Difference between revisions of "Page Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
Line 32: | Line 32: | ||
|valign="top"|CSS style||CSS style (separate attributes with ; or use app:/filename.css)|||||||||| | |valign="top"|CSS style||CSS style (separate attributes with ; or use app:/filename.css)|||||||||| | ||
|- | |- | ||
− | |valign="top"|Gradient colors||Render the background color as a gradient (True | False)|||||||||| | + | |valign="top"|[[Gradients#Gradient colors|Gradient colors]]||Render the background color as a gradient (True | False)|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient type||Specify the gradient type | + | |valign="top"|[[Gradients#Gradient type|Gradient type]]||Specify the gradient type|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient start color||Gradient start color|||||||||| | + | |valign="top"|[[Gradients#Gradient start color|Gradient start color]]||Gradient start color|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient end color||Gradient end color|||||||||| | + | |valign="top"|[[Gradients#Gradient end color|Gradient end color]]||Gradient end color|||||||||| |
|- | |- | ||
|valign="top"|Transparency||Specify a transparency percentage from 0 to 100|||||||||| | |valign="top"|Transparency||Specify a transparency percentage from 0 to 100|||||||||| | ||
Line 103: | Line 103: | ||
|valign="top"|Header image||The image for the Header (png | jpg | gif).<br>Use app:/imagename.ext for app specific images.|||||||||| | |valign="top"|Header image||The image for the Header (png | jpg | gif).<br>Use app:/imagename.ext for app specific images.|||||||||| | ||
|- | |- | ||
− | |valign="top"|Gradient colors||Render the Header background color as a gradient (True | False)|||||||||| | + | |valign="top"|[[Gradients#Gradient colors|Gradient colors]]||Render the Header background color as a gradient (True | False)|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient type||Specify the gradient type | + | |valign="top"|[[Gradients#Gradient type|Gradient type]]||Specify the gradient type|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient start color||Gradient start color|||||||||| | + | |valign="top"|[[Gradients#Gradient start color|Gradient start color]]||Gradient start color|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient end color||Gradient end color|||||||||| | + | |valign="top"|[[Gradients#Gradient end color|Gradient end color]]||Gradient end color|||||||||| |
|- | |- | ||
|valign="top"|Hide header icon||Hide the header icon in the page Header (True | False)|||||||||| | |valign="top"|Hide header icon||Hide the header icon in the page Header (True | False)|||||||||| | ||
Line 144: | Line 144: | ||
|valign="top"|Footer image||The image for the Footer (png | jpg | gif).<br>Use app:/imagename.ext for app specific images.|||||||||| | |valign="top"|Footer image||The image for the Footer (png | jpg | gif).<br>Use app:/imagename.ext for app specific images.|||||||||| | ||
|- | |- | ||
− | |valign="top"|Gradient colors||Render the Footer background color as a gradient (True | False)|||||||||| | + | |valign="top"|[[Gradients#Gradient colors|Gradient colors]]||Render the Footer background color as a gradient (True | False)|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient type||Specify the gradient type | + | |valign="top"|[[Gradients#Gradient type|Gradient type]]||Specify the gradient type|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient start color||Gradient start color|||||||||| | + | |valign="top"|[[Gradients#Gradient start color|Gradient start color]]||Gradient start color|||||||||| |
|- | |- | ||
− | |valign="top"|Gradient end color||Gradient end color|||||||||| | + | |valign="top"|[[Gradients#Gradient end color|Gradient end color]]||Gradient end color|||||||||| |
|- | |- | ||
|valign="top"|Gadget||The custom gadget to be rendered in the Footer|||||||||| | |valign="top"|Gadget||The custom gadget to be rendered in the Footer|||||||||| |
Revision as of 13:41, 19 January 2015
Under construction
Contents
Details
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Name | The unique name for this page | |||||
Title | The menu title for this page | |||||
Menu icon image | The menu icon image for the title (png | jpg | gif). Use app:/imagename.ext for app specific images. Note that in the mobile client this icon will be displayed in the PageBar. |
|||||
Autosave in Page Library | Always save this page to the UI Page Library when an App is saved. |
Appearance
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Current page height | Current page height | |||||
Background color | Page background color | |||||
Foreground color | Page foreground color | |||||
CSS style | CSS style (separate attributes with ; or use app:/filename.css) | |||||
Gradient colors | Render the background color as a gradient (True | False) | |||||
Gradient type | Specify the gradient type | |||||
Gradient start color | Gradient start color | |||||
Gradient end color | Gradient end color | |||||
Transparency | Specify a transparency percentage from 0 to 100 | |||||
Background image | The background image for the page (png | jpg | gif). Use app:/imagename.ext for app specific images. |
|||||
Stretch image | Stretch the background image to fill the page (True | False) | |||||
Margin | Margin size around the page | |||||
Hide page from menu | Hide page from menu at runtime | |||||
Accordion behavior | Render as accordion sections (True | False) | |||||
Use Accordions | Render as accordion sections on low resolution displays | |||||
Use Accordions height | Render as accordion sections on low resolution displays less than this height | |||||
Stacked behavior at runtime | Treat accordion sections as stacked at runtime allowing the sections to be made raised from the Navigation Panel | |||||
Stretch last section | Stretch last section to bottom of page | |||||
Stretch last section min height | If the last section is less than this height, then set it to this height and show page vertical scrollbar | |||||
Hide actionbar | Hide the actionbar | |||||
Sync actionbar buttons | Keep the actionbar buttons in sync with the current data position. Turn this off to improve performance with large amounts of data. | |||||
Show options icon | Show the options menu icon in the actionbar | |||||
Custom options menu | Custom options menu (comma separated list of values) | |||||
Show scrollbar | Show a vertical scrollbar for the page | |||||
Show scrollbar height | Show vertical scrollbar on low resolution displays less than this height | |||||
Refresh when activated | Refresh all sections on this page when the page is activated | |||||
Full page edit | Edit all editable sections on this page when the page is edited |
Header
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Visible | Header visible (True | False) | |||||
Caption | Header caption | |||||
Height | Header height | |||||
Background color | Header background color | |||||
Foreground color | Header foreground color | |||||
Header bottom border | Display Header bottom border (True | False) | |||||
Header bottom border color | Header bottom border color | |||||
Header image | The image for the Header (png | jpg | gif). Use app:/imagename.ext for app specific images. |
|||||
Gradient colors | Render the Header background color as a gradient (True | False) | |||||
Gradient type | Specify the gradient type | |||||
Gradient start color | Gradient start color | |||||
Gradient end color | Gradient end color | |||||
Hide header icon | Hide the header icon in the page Header (True | False) | |||||
Hide search box | Hide the search box in the page Header (True | False) | |||||
Minimum search text length | Minimum number of characters to type in the search box before search is made | |||||
Hide notifications icon | Hide the notifications icon in the page Header (True | False) | |||||
Hide fullscreen icon | Hide the fullscreen icon in the page Header (True | False) | |||||
Hide share icon | Hide the share icon in the page Header (True | False) | |||||
Hide home icon | Hide the home icon in the page Header (True | False) |
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Visible | Footer visible (True | False) | |||||
Height | Footer height | |||||
Background color | Footer background color | |||||
Foreground color | Footer foreground color | |||||
Footer image | The image for the Footer (png | jpg | gif). Use app:/imagename.ext for app specific images. |
|||||
Gradient colors | Render the Footer background color as a gradient (True | False) | |||||
Gradient type | Specify the gradient type | |||||
Gradient start color | Gradient start color | |||||
Gradient end color | Gradient end color | |||||
Gadget | The custom gadget to be rendered in the Footer | |||||
Refresh interval | The interval in seconds that the Footer content will be refreshed |
Left Sidebar
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Show left sidebar | Show left sidebar (True | False) | |||||
Collapse left sidebar | Collapse left sidebar when the App is first loaded (True | False) | |||||
Width | Left sidebar width | |||||
Show left sidebar logo image | Show left sidebar logo image (True | False) | |||||
Logo image | The logo displayed at the top of the left sidebar (png | jpg | gif). Use app:/imagename.ext for app specific images. |
|||||
Show login panel | Show the login panel in the left sidebar (True | False) | |||||
Show Apps | Show the Apps menu in the left sidebar (True | False) | |||||
Show Apps Caption | Show the Apps caption above the Apps menu (True | False) | |||||
Show Menu | Show the page menu in the left sidebar (True | False) | |||||
Show Recent Items | Show Watches, Favorites, Recently Viewed/Modified items and Instant Selections in the left sidebar (True | False) | |||||
Background color | Left sidebar background color | |||||
Foreground color | Left sidebar foreground color | |||||
Border color | Left sidebar border color | |||||
Favorite items | The number of Favorites to display | |||||
Recently viewed items | The number of Recently Viewed items to display | |||||
Recently modified items | The number of Recently Modified items to display | |||||
Watched items | The number of Watched items to display | |||||
Refresh interval | The interval in seconds that the Instant Selections content will be refreshed |
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Show navigation panel | Show a Navigation panel on the left side of the page (True | False). By default this is a TreeGrid, so you can load it in the load delegate for the page and structure it as a Grid or a Tree. |
|||||
Collapsable | Enable collapsing and expanding for the Navigation panel (True | False) | |||||
Collapse when first loaded | Hide Navigation panel when first loaded. Use $("page:yourpagename?action=shownavigationpanel") to show it and $("page:yourpagename?action=hidenavigationpanel") to hide it again |
|||||
Position on page | Navigation panel position on page(Left | Right) | |||||
Show caption | Show Navigation panel caption (True | False) | |||||
Caption height | Navigation panel caption height | |||||
Caption | Navigation panel caption | |||||
Width | Navigation panel width | |||||
Custom UI page | Specify an (optional) custom UI Page from the UI Page Library to embed into the Navigation panel | |||||
Show child indicators | Show child indicators | |||||
Alternating row colors | Alternating row colors | |||||
Double click to select | Check this if you want the selection delegate to be called on a double-click rather than a single click | |||||
Column headers | Specify a comma separated list of column headers | |||||
Data source | Specify a comma separated list of items to load as caption#icon or a SQL SELECT statement to load from a data source. Note that you can optionally load the Navigation panel in the load delegate for the page. |
|||||
Selection column | When using a multi column TreeGrid, specify the column you want to select when calling the selection delegate | |||||
Item sync expression | Specify an expression to evaluate to keep the TreeGrid in sync while data is navigated in the page | |||||
Selection delegate | Specify a delegate to call when a row is clicked. Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=search&text={}") Notice how {} is used to substitute the value of the item selected. |
|||||
Show ActionBar | Show the actionbar at the bottom of the Navigation panel (True | False) | |||||
Add delegate | Specify a delegate to call when the 'Add' icon is clicked. Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=add") |
|||||
Delete delegate | Specify a delegate to call when the 'Delete' icon is clicked. Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=delete") |
|||||
Row height | Row height for the Tree items in the Navigation panel | |||||
Font size | Font size for the Tree items in the Navigation panel | |||||
CSS style | CSS style for the Navigation panel and its Tree (separate attributes with ; or use app:/filename.css) |
Right Sidebar
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Show right sidebar | Show right sidebar (True | False) | |||||
Collapse right sidebar | Collapse right sidebar when the App is first loaded (True | False) | |||||
Width | Right sidebar width | |||||
Background color | Right sidebar background color | |||||
Foreground color | Right sidebar foreground color | |||||
Border color | Right sidebar border color | |||||
Custom content gadget | Gadget based on custom script | |||||
+ Show | Show the custom content gadget (True | False) | |||||
+ Expanded | Expand the custom content gadget when the App is first loaded (True | False) | |||||
+ Height | Custom content gadget height | |||||
+ Stretch | Stretch the custom content into the right sidebar (True | False) | |||||
+ Caption | Custom content gadget caption | |||||
+ Gadget | The gadget to be displayed | |||||
+ Refresh interval | The interval in seconds that the content will be refreshed | |||||
Content gadget #1 | Gadget based on URL | |||||
+ Show | Show the gadget (True | False) | |||||
+ Expanded | Expand the gadget when the App is first loaded (True | False) | |||||
+ Height | Gadget height | |||||
+ Stretch | Stretch the content into the right sidebar (True | False) | |||||
+ Caption | Gadget caption | |||||
+ URL | The URL of the content to be displayed | |||||
+ Refresh interval | The interval in seconds that the content will be refreshed | |||||
Content gadget #2 | Gadget based on URL | |||||
+ Show | Show the gadget (True | False) | |||||
+ Expanded | Expand the gadget when the App is first loaded (True | False) | |||||
+ Height | Gadget height | |||||
+ Stretch | Stretch the content into the right sidebar (True | False) | |||||
+ Caption | Gadget caption | |||||
+ URL | The URL of the content to be displayed | |||||
+ Refresh interval | The interval in seconds that the content will be refreshed | |||||
Content gadget #3 | Gadget based on URL | |||||
+ Show | Show the gadget (True | False) | |||||
+ Expanded | Expand the gadget when the App is first loaded (True | False) | |||||
+ Height | Gadget height | |||||
+ Stretch | Stretch the content into the right sidebar (True | False) | |||||
+ Caption | Gadget caption | |||||
+ URL | The URL of the content to be displayed | |||||
+ Refresh interval | The interval in seconds that the content will be refreshed | |||||
Content gadget #4 | Gadget based on URL | |||||
+ Show | Show the gadget (True | False) | |||||
+ Expanded | Expand the gadget when the App is first loaded (True | False) | |||||
+ Height | Gadget height | |||||
+ Stretch | Stretch the content into the right sidebar (True | False) | |||||
+ Caption | Gadget caption | |||||
+ URL | The URL of the content to be displayed | |||||
+ Refresh interval | The interval in seconds that the content will be refreshed |
Custom Delegates
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Scripting language | The default scripting language for custom code in this page (Inherit | Recital | Visual FoxPro | Python | JavaScript | PHP) | |||||
Custom library | The filename of the library containing code for event handlers and custom procedures/functions | |||||
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 | |||||
Timer | The delegate for the Timer event | |||||
Timer interval | The timer interval in seconds that the Timer event will be called at runtime | |||||
Custom menu | The delegate for the Custom menu event | |||||
Custom search | The delegate for the Search event | |||||
Instant search | The delegate for the Instant Search event. The text typed in the searchbox is passed as a parameter | |||||
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 |
Gestures
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Swipe navigation | Enable swipe left and swipe right to navigate between Pages (True | False) | |||||
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' |
|||||
Swipe left gesture | The Swipe Left gesture delegate | |||||
Swipe right gesture | The Swipe Right gesture delegate | |||||
Swipe up gesture | The Swipe Up gesture delegate | |||||
Swipe down gesture | The Swipe Down gesture delegate | |||||
Pan gesture | The Pan gesture delegate | |||||
Pinch gesture | The Pinch gesture delegate | |||||
Tap gesture | The Tap gesture delegate | |||||
Tap and hold gesture | The Tap and Hold gesture delegate | |||||
Gestures | The catch all delegate for the Gestures event |
Custom Actions
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Add action | The custom action function for Add. This will be called to add a record. | |||||
Delete action | The custom action function for Delete. This will be called to delete a record. | |||||
Refresh action | The custom action function for Refresh. This will be called to refresh the current record. | |||||
First action | The custom action function for First. This will be called to read the first record. | |||||
Previous action | The custom action function for Previous. This will be called to read the previous record. | |||||
Next action | The custom action function for Next. This will be called to read the next record. | |||||
Last action | The custom action function for Last. This will be called to read the last record. | |||||
Edit action | The custom action function for Edit. This will be called to edit the current record. | |||||
Save action | The custom action function for Save. This will be called to save changes. | |||||
Cancel action | The custom action function for Cancel. This will be called to cancel changes. |
Permissions and Roles
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Create roles | A comma separated list of roles that can perform create operations on data in the page | |||||
Read roles | A comma separated list of roles that can read (and view) the page | |||||
Update roles | A comma separated list of roles that can perform update operations on data in the page | |||||
Delete roles | A comma separated list of roles that can perform delete operations on data in the page |
UI Presentation Rules
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Desktop | Include this page in a Desktop client (True | False) | |||||
Web | Include this page in a Web client (True | False) | |||||
Tablet | Include this page in a Tablet client (True | False) | |||||
Phone | Include this page in a Phone client (True | False) | |||||
UI States | UI states that affect this page. Specify multiple states as a comma separated list. | |||||
Initial UI state | The initial UI state for this page. This will be applied to the page and all its sections and fields. | |||||
Readonly when | Page is readonly at runtime if specified expression evaluates to true. | |||||
Visible when | Page is visible at runtime if specified expression evaluates to true. | |||||
Page transition effect | The page transition effect when navigating between pages on Web/Tablet/Phone. (None | Fade | Pop | Flip | Turn | Flow | SlideFade | Slide | SlideUp | SlideDown) | |||||
Apply rules on change | Apply page UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False) |
Page Center Tile
Attribute | Description | More | Desktop | Web | Tablet | Phone |
---|---|---|---|---|---|---|
Category | The category in which the Tile should be displayed in the Page Center | |||||
Tile caption | The caption for the Tile in the Page Center | |||||
Tile icon | The icon for the Tile in the Page Center | |||||
Tile size | The size of the Tile in the Page Center | |||||
Background color | The background color for the Tile displayed in the Page Center | |||||
Foreground color | The foreground color for the Tile displayed in the Page Center |