Difference between revisions of "Custom Gadget Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
| Line 115: | Line 115: | ||
!width="80%"|Description | !width="80%"|Description | ||
|- | |- | ||
| − | |valign="top"|Desktop||Include this gadget in a Desktop client (True | False) | + | |valign="top"|[[UI Presentation Rules#Desktop|Desktop]]||Include this gadget in a Desktop client (True | False). |
|- | |- | ||
| − | |valign="top"|Web||Include this gadget in a Web client (True | False) | + | |valign="top"|[[UI Presentation Rules#Web|Web]]||Include this gadget in a Web client (True | False). |
|- | |- | ||
| − | |valign="top"|Tablet||Include this gadget in a Tablet client (True | False) | + | |valign="top"|[[UI Presentation Rules#Tablet|Tablet]]||Include this gadget in a Tablet client (True | False). |
|- | |- | ||
| − | |valign="top"|Phone||Include this gadget in a Phone client (True | False) | + | |valign="top"|[[UI Presentation Rules#Phone|Phone]]||Include this gadget in a Phone client (True | False). |
|- | |- | ||
| − | |UI States||UI states that affect this gadget. Specify multiple states as a comma separated list. | + | |valign="top"|[[UI Presentation Rules#UI States|UI States]]||UI states that affect this gadget. Specify multiple states as a comma separated list. |
|- | |- | ||
| − | |Initial UI state||The initial UI state for this gadget. | + | |valign="top"|[[UI Presentation Rules#Initial UI state|Initial UI state]]||The initial UI state for this gadget. |
|- | |- | ||
| − | |valign="top"|Readonly when||Gadget is readonly at runtime if specified expression evaluates to true. | + | |valign="top"|[[UI Presentation Rules#Readonly when|Readonly when]]||Gadget is readonly at runtime if specified expression evaluates to true. |
|- | |- | ||
| − | |valign="top"|Visible when||Gadget is visible at runtime if specified expression evaluates to true. | + | |valign="top"|[[UI Presentation Rules#Visible when|Visible when]]||Gadget is visible at runtime if specified expression evaluates to true. |
|- | |- | ||
| − | |valign="top"|Display orientation||Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) | + | |valign="top"|[[UI Presentation Rules#Display orientation|Display orientation]]||Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) |
|- | |- | ||
| − | |valign="top"|Apply rules on change||Apply | + | |valign="top"|[[UI Presentation Rules#Apply rules on change|Apply rules on change]]||Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). |
|- | |- | ||
|} | |} | ||
[[Category:Attributes|4 Custom Gadget]] | [[Category:Attributes|4 Custom Gadget]] | ||
Revision as of 08:57, 15 April 2016
Under construction
Contents
Details
| Attribute | Description |
|---|---|
| Name | The name for this gadget (unique to the section) |
| Meta types | A comma separated list of metatype names |
| Type | The type of control: Gadget (readonly) |
| Gadget type | The type of gadget: custom (readonly) |
| Margin | Margin size around the gadget |
| Fixed width | Fix the gadget width (True | False) |
| Fixed height | Fix the gadget height (True | False) |
| Inline | Render the gadget inline rather than it its own column (True | False) |
| Stretch width | Auto stretch the width of the gadget into the width of the section (True | False) |
Geometry
| Attribute | Description |
|---|---|
| Absolute | Enable or disable absolute positioning (True | False) |
| Top | Top position in pixels |
| Left | Left position in pixels |
| Width | Width in pixels |
| Height | Height in pixels |
| CSS style | CSS style (separate attributes with ; or use app:/filename.css) |
Caption
| Attribute | Description |
|---|---|
| Caption | The caption for the gadget |
| Background color | The background color for the caption |
| Foreground color | The foreground color for the caption |
| Font | The font for the caption |
| Icon | The image for the caption (png | jpg | gif). Use app:/imagename.ext for app specific images. |
| Border width | The caption border width |
| Border color | The caption border color |
| Transparency | Specify a transparency percentage from 0 to 100 |
| Gradient colors | Render the caption color as a gradient (True | False) |
| Gradient type | Specify the gradient type |
| Gradient start color | Gradient start color |
| Gradient end color | Gradient end color |
Data
| Attribute | Description |
|---|---|
| Scripting language | The scripting language used to write the code for this custom gadget: (Recital | Python | JavaScript | PHP (readonly) |
| Custom filename | The file containing the custom code for this gadget |
| Background color | The background color for the gadget |
| Foreground color | The foreground color for the gadget |
Other Options
| Attribute | Description |
|---|---|
| Hide header | Hide gadget header at runtime (True | False) |
Permissions and Roles
| Attribute | Description |
|---|---|
| Read roles | A comma separated list of roles that can read (and view) the data |
| Update roles | A comma separated list of roles that can perform update operations on the data |
UI Presentation Rules
| Attribute | Description |
|---|---|
| Desktop | Include this gadget in a Desktop client (True | False). |
| Web | Include this gadget in a Web client (True | False). |
| Tablet | Include this gadget in a Tablet client (True | False). |
| Phone | Include this gadget in a Phone client (True | False). |
| UI States | UI states that affect this gadget. Specify multiple states as a comma separated list. |
| Initial UI state | The initial UI state for this gadget. |
| Readonly when | Gadget is readonly at runtime if specified expression evaluates to true. |
| Visible when | Gadget is visible at runtime if specified expression evaluates to true. |
| Display orientation | Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) |
| Apply rules on change | Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). |
