Difference between revisions of "Timeline Section Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
| Line 290: | Line 290: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="50%"|Description |
| + | !width="20%"|Name | ||
| + | !width="10%"|Type | ||
|- | |- | ||
|valign="top"|[[Accordion Behavior#Hide form NavBar|Hide form NavBar]]||Hide form Navigation Bar at runtime if this section is in an Accordion Stack (True | False) | |valign="top"|[[Accordion Behavior#Hide form NavBar|Hide form NavBar]]||Hide form Navigation Bar at runtime if this section is in an Accordion Stack (True | False) | ||
| + | |valign="top"|hideFormNavBar||valign="top"|Boolean | ||
|- | |- | ||
|valign="top"|[[Section Appearance#Collapsable|Collapsable]]||The section is collapsible at runtime (True | False) | |valign="top"|[[Section Appearance#Collapsable|Collapsable]]||The section is collapsible at runtime (True | False) | ||
| + | |valign="top"|collapsableAtRuntime||valign="top"|Boolean | ||
|- | |- | ||
|valign="top"|[[Accordion Behavior#Exclude from accordion|Exclude from accordion]]||The section is excluded from accordion behavior at runtime (True | False) | |valign="top"|[[Accordion Behavior#Exclude from accordion|Exclude from accordion]]||The section is excluded from accordion behavior at runtime (True | False) | ||
| + | |valign="top"|excludeAccordionAtRuntime||valign="top"|Boolean | ||
|- | |- | ||
|valign="top"|[[Section Appearance#Hide search icon|Hide search icon]]||Hide the search icon at runtime (True | False) | |valign="top"|[[Section Appearance#Hide search icon|Hide search icon]]||Hide the search icon at runtime (True | False) | ||
| + | |valign="top"|hideSearchIcon||valign="top"|Boolean | ||
|- | |- | ||
|} | |} | ||
| Line 374: | Line 380: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="50%"|Description |
| − | !width=" | + | !width="20%"|Name |
!width="10%"|Type | !width="10%"|Type | ||
|- | |- | ||
Revision as of 09:43, 6 July 2016
Contents
See Also
Getting and Setting Attributes
The setAttribute(name, value) method can be used to set the value of an Attribute:
Lianja.get("pageid.sectionid").setAttribute("title","Section1")
Note: the shortened form setAttr(name,value) is also available.
The getAttribute(name) method can be used to get the value of an Attribute:
cTitle = Lianja.get("pageid.sectionid").getAttribute("title")
Note: the shortened form getAttr(name) is also available.
Details
| Attribute | Description |
|---|---|
| Name | The name for this section (unique to the page) |
| Meta types | A comma separated list of metatype names |
| Type | The type of section: timeline (readonly) |
| Caption | The section caption displayed in the section header |
| Database | The database for this section |
| Table | The table for this section |
| SQL statement | The SQL statement used to populate a Virtual Table. Use {} macros in the WHERE condition to relate parent-->child sections and ORDER BY to order the display of records. This is native SQL for the target SQL database and may call stored procedures as well as SQL Select. |
| Filter | The filter expression that restricts the records that will be included in the data |
| Where condition | The dynamic WHERE condition for a Virtual Table that restricts which records will be retrieved |
| Search field | The search field for the section |
| Height | The section height |
| Fixed height | Fix the section height (True | False) |
| Auto layout percent | Auto layout percentage of page size. If set to 0, then all sections on a page are resized to an equal height |
| Readonly | Section is readonly (True | False) |
Appearance
| Attribute | Description |
|---|---|
| Background color | Section background color |
| Foreground color | Section foreground color |
| CSS style | CSS style (separate attributes with ; or use app:/filename.css) |
| Transparency | Specify a transparency percentage from 0 to 100 |
| Background image | The background image for the section (png | jpg | gif). Use app:/imagename.ext for app specific images. |
| Stretch image | Stretch the background image to fill the section (True | False) |
| Margin | Margin size around the section |
| Spacing | Spacing between items in the section |
| Border-radius | Border radius of items in the section |
| Add spacer at bottom | Add spacer at bottom of section (True | False) |
Header
| Attribute | Description | Name | Type |
|---|---|---|---|
| Hide header | Hide section header at runtime(True | False) | hideHeaderAtRuntime | Boolean |
| Hide actionbar | Hide actionbar buttons in the section header (True | False) | hideActionBarAtRuntime | Boolean |
| Hide navigation buttons | Hide actionbar navigation buttons in the section header (True | False) | hideNavButtons | Boolean |
| Hide editing buttons | Hide the Save/Cancel editing buttons in the section header (True | False). Don't change this unless you are handling these operations programatically. | hideEditingButtons | Boolean |
| Header CSS style | CSS style (separate attributes with ; or use app:/filename.css) | headerCssStyle | Character |
| Background color | Header background color | headerBackColor | Character |
| Foreground color | Header foreground color | headerForeColor | Character |
| Header icon | The image for the Header (png | jpg | gif). Use app:/imagename.ext for app specific images. |
headerIcon | Character |
| Gradient colors | Render the Header background color as a gradient (True | False) | headerGradient | Boolean |
| Gradient type | Specify the gradient type | headerGradientType | Int |
| Gradient start color | Gradient start color | headerFromColor | Character |
| Gradient end color | Gradient end color | headerToColor | Character |
| Show OK/Cancel buttons | Show OK/Cancel buttons in the section header (True | False) | showOkCancelButtons | Boolean |
| Show Add/Delete buttons | Show Add/Delete buttons in the section header (True | False) | showAddDeleteButtons | Boolean |
| Show Print button | Show Print button in the section header (True | False) | showPrintButton | Boolean |
| Hide custom search icon | Hide the custom search icon (True | False) | hideCustomSearchIcon | Boolean |
| Show info tips icon | Show the info tips icon in the section header (True | False) | showInfoTipsIcon | Boolean |
| Show help icon | Show the help icon in the section header (True | False) | showHelpIcon | Boolean |
| Help topic | Help topic to display when the help icon is clicked in the section header | helpTopic | Character |
Related Data
| Attribute | Description | Name | Type |
|---|---|---|---|
| Parent section name | Name of related parent section | ||
| Automatically relate | Automatically relate the child section (True | False). If this is unchecked then you need to manually relate it in the parentdatachanged delegate. | autoRelateChildSection | Boolean |
| Parent key | Parent key | ||
| Child key | Child key | childKeyExpr | Character |
Menu
| Attribute | Description | Name | Type |
|---|---|---|---|
| Visible | Section menu visible (True | False) | sectionMenuVisible | Boolean |
| Height | Section menu height | sectionMenuHeight | Int |
| Background color | Section menu background color | sectionMenuBackColor | Character |
| Foreground color | Section menu foreground color | sectionMenuForeColor | Character |
| Custom menu panel | The .rsp or .jssp page used to create the custom menu panel. This page should generate dynamic HTML5/JavaScript. | customSectionMenuPanel | Character |
| Custom menu | Section menu contents | customSectionMenu | Character |
| Custom action | Action to perform when a menu item is selected | sectionMenuAction | Character |
Search Panel
| Attribute | Description | Name | Type |
|---|---|---|---|
| Visible | Section search panel visible (True | False) | searchPanelVisible | Boolean |
| Height | Section search panel height | searchPanelHeight | Int |
| Background color | Section search panel background color | searchPanelBackColor | Character |
| Foreground color | Section search panel foreground color | searchPanelForeColor | Character |
| Auto create | Automatically create search panel for all Section search fields | searchPanelAutoCreate | Boolean |
| Custom search panel | The delegate used to create the custom search panel | searchPanelAction | Character |
Subtitle
| Attribute | Description | Name | Type |
|---|---|---|---|
| Visible | Section subtitle visible (True | False) | subtitleVisible | Boolean |
| Caption | Section subtitle caption | subtitleCaption | Character |
| Height | Section subtitle height | subtitleHeight | Int |
| Background color | Section subtitle background color | subtitleBackColor | Character |
| Foreground color | Section subtitle foreground color | subtitleForeColor | Character |
| Font | Section subtitle font | subtitleFont | Int |
| CSS style | CSS style | subtitleCssStyle | Character |
| Attribute | Description | Name | Type |
|---|---|---|---|
| Visible | Section footer visible (True | False) | footerVisible | Boolean |
| Caption | Section footer caption | footerText | Character |
| Height | Section footer height | footerHeight | Int |
| Background color | Section footer background color | footerBackColor | Character |
| Foreground color | Section footer foreground color | footerForeColor | Character |
| Custom menu | Section footer menu contents | customOptionsMenu | Character |
| Custom action | Action to perform when a footer menu item is selected | customOptionsMenuAction | Character |
| Footer button CSS | Footer button CSS style | footerButtonCss | Character |
| Footer button width | Footer button width | footerButtonWidth | Int |
Other Options
| Attribute | Description | Name | Type |
|---|---|---|---|
| Hide form NavBar | Hide form Navigation Bar at runtime if this section is in an Accordion Stack (True | False) | hideFormNavBar | Boolean |
| Collapsable | The section is collapsible at runtime (True | False) | collapsableAtRuntime | Boolean |
| Exclude from accordion | The section is excluded from accordion behavior at runtime (True | False) | excludeAccordionAtRuntime | Boolean |
| Hide search icon | Hide the search icon at runtime (True | False) | hideSearchIcon | Boolean |
Custom Delegates
| Attribute | Description |
|---|---|
| Scripting language | The default scripting language for custom code in this section (Inherit | Recital | Visual FoxPro | Python | JavaScript | PHP) |
| Custom library | The filename of the library containing code for event handlers and custom procedures/functions |
| Expanded | The delegate for the Expanded event |
| Collapsed | The delegate for the Collapsed event |
| Enabled When | The delegate for the EnabledWhen event |
| Visible When | The delegate for the VisibleWhen event |
| Valid When | The delegate for the ValidWhen event |
| Activate | The delegate for the Activate event |
| Deactivate | The delegate for the Deactivate event |
| Init | The delegate for the Init event |
| Destroy | The delegate for the Destroy event |
| Load | The delegate for the Load event |
| Ready | The delegate for the Ready event |
| Unload | The delegate for the Unload event |
| Change | The delegate for the Change event |
| Link Click | The delegate for the Hyperlink/Button Click event. This is called with two arguments: functionname(controlsource,text) |
| Before Data Create | The delegate for the BeforeCreated event |
| After Data Create | The delegate for the AfterCreated event |
| After Data Changed | The delegate for the dataChanged event (after data is read) |
| Before Data Update | The delegate for the BeforeUpdate event |
| After Data Update | The delegate for the AfterUpdate event |
| Before Data Delete | The delegate for the BeforeDelete event |
| After Data Delete | The delegate for the AfterDelete event |
| Refresh | The delegate for the Refresh event |
| Parent data changed | The delegate for the ParentDataChanged event |
| Dialog button delegate | The delegate for the DialogButtonClicked event. If a dialogbutton on a Field has no delegate, the Section delegate will be called. If the section has no delegate, then the Page delegate will be called. |
| Timer | The delegate for the Timer event |
| Timer interval | The timer interval in seconds that the Timer event will be called at runtime |
| Custom footer menu | The delegate for the footer menu event |
| Custom search command | The delegate for the search event |
| Custom section menu | The delegate for the section menu event |
Gestures
| Attribute | Description | Name | Type |
|---|---|---|---|
| Gestures enabled | Enable gestures for this page: swipe, pan, pinch, tap and tapandhold (True | False). If enabled, then the Gestures delegate will be called with two arguments, e.g. 'swipe','left' or 'swipe','right'. |
gesturesEnabled | Boolean |
| Swipe left gesture | The delegate for the gestureSwipeLeft event. | gestureSwipeLeftAction | Character |
| Swipe right gesture | The delegate for the gestureSwipeRight event. | gestureSwipeRightAction | Character |
| Swipe up gesture | The delegate for the gestureSwipeUp event. | gestureSwipeUpAction | Character |
| Swipe down gesture | The delegate for the gestureSwipeDown event. | gestureSwipeDownAction | Character |
| Pan gesture | The delegate for the gesturePan event. | gesturePanAction | Character |
| Pinch gesture | The delegate for the gesturePinch event. | gesturePinchAction | Character |
| Tap gesture | The delegate for the gestureTap event. | gestureTapAction | Character |
| Tap and hold gesture | The delegate for the gestureTapAndHold event. | gestureTapAndHoldAction | Character |
| Gestures | The catch all delegate for the gestures event. | gesturesAction | Character |
Permissions and Roles
| Attribute | Description | Name | Type |
|---|---|---|---|
| Create roles | A comma separated list of roles that can perform create operations on data in the section. | permcreate | Character |
| Read roles | A comma separated list of roles that can read (and view) the section. | permRead | Character |
| Update roles | A comma separated list of roles that can perform update operations on data in the section. | permUpdate | Character |
| Delete roles | A comma separated list of roles that can perform delete operations on data in the section. | permDelete | Character |
UI Presentation Rules
| Attribute | Description | Name | Type |
|---|---|---|---|
| Desktop | Include this section in a Desktop client (True | False). | desktopUI | Boolean |
| Web | Include this section in a Web client (True | False). | webUI | Boolean |
| Tablet | Include this section in a Tablet client (True | False). | tabletUI | Boolean |
| Phone | Include this section in a Phone client (True | False). | mobileUI | Boolean |
| UI States | UI states that affect this section. Specify multiple states as a comma separated list. | state | Character |
| Initial UI state | The initial UI state for this section. This will be applied to the section and all its fields and gadgets. | uiStateInit | Character |
| Readonly when | Section is readonly at runtime if specified expression evaluates to true. | readonlyWhen | Character |
| Visible when | Section is visible at runtime if specified expression evaluates to true. | visibleWhen | Character |
| Display orientation | Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) | displayOrientation | Character |
| Apply rules on change | Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). | applyRulesOnChange | Boolean |
| Apply rules on parent change | Apply section UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True | False) | applyRulesOnParentChange | Boolean |
