Difference between revisions of "PageBuilder"
From Lianjapedia
Yvonne.milne (Talk | contribs) (→Methods) |
Yvonne.milne (Talk | contribs) (→Methods) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 37: | Line 37: | ||
|Object | |Object | ||
|Return an object reference to the currently active [[Tree|Navigation Panel]] | |Return an object reference to the currently active [[Tree|Navigation Panel]] | ||
+ | |- | ||
+ | |valign="top"|State | ||
+ | |valign="top"|R | ||
+ | |valign="top"|Character | ||
+ | |Comma separated list of [[UI States]] that the Page handles. | ||
|- | |- | ||
|Title | |Title | ||
Line 42: | Line 47: | ||
|Character | |Character | ||
|Menu title text | |Menu title text | ||
+ | |- | ||
+ | |valign="top"|UIState | ||
+ | |valign="top"|R | ||
+ | |valign="top"|Character | ||
+ | |The last [[UI States|UI State]] applied to the Page. | ||
|- | |- | ||
|} | |} | ||
Line 93: | Line 103: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return the current page data as JSON | |valign="top"|Return the current page data as JSON | ||
+ | |- | ||
+ | |valign="top"|hideActionBarButtons | ||
+ | |valign="top"|buttonList as Character | ||
+ | |valign="top"|Hide the actionbar buttons specified in the buttonList comma-separated string. Valid buttons are: add, delete, refresh, first, previous, next, last, edit, save, cancel. From v6.3. | ||
+ | |- | ||
+ | |valign="top"|hideSeachBox() | ||
+ | |valign="top"|None | ||
+ | |valign="top"|Hide the [[Instant Search]] box. From v5.4. | ||
|- | |- | ||
|valign="top"|Item | |valign="top"|Item | ||
Line 116: | Line 134: | ||
|RefreshNavigationPanel | |RefreshNavigationPanel | ||
|url as Character | |url as Character | ||
− | |Refresh the Navigation Panel | + | |Refresh the Navigation Panel. From v5.0. |
|- | |- | ||
|RemoveSection | |RemoveSection | ||
Line 129: | Line 147: | ||
|valign="top"|parentSection as character,<br>childSection as character,<br>parentKey as character,<br>childKey as character | |valign="top"|parentSection as character,<br>childSection as character,<br>parentKey as character,<br>childKey as character | ||
|valign="top"|Relate two sections in the page. From v5.0. | |valign="top"|Relate two sections in the page. From v5.0. | ||
+ | |- | ||
+ | |valign="top"|showActionBarButtons | ||
+ | |valign="top"|buttonList as Character | ||
+ | |valign="top"|Show the (previously hidden) actionbar buttons specified in the buttonList comma-separated string. Valid buttons are: add, delete, refresh, first, previous, next, last, edit, save, cancel. From v6.3. | ||
+ | |- | ||
+ | |valign="top"|showSeachBox() | ||
+ | |valign="top"|None | ||
+ | |valign="top"|Show the [[Instant Search]] box. From v5.4. | ||
|- | |- | ||
|} | |} |
Latest revision as of 05:57, 16 February 2024
The reference class for Lianja Page Builder Pages. See Page for the Visual FoxPro framework class for a Page in a Pageframe.
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Properties
This class supports the Common Properties plus the following:
Property | Access (R/RW) | Value | Description |
---|---|---|---|
ActiveSection | RW | Object | Return an object reference to the currently active section |
Caption | RW | Character | Caption text |
Count | R | Numeric | Number of Sections in the Page |
Id | R | Character | Object's Id |
NavigationPanel | RW | Object | Return an object reference to the currently active Navigation Panel |
State | R | Character | Comma separated list of UI States that the Page handles. |
Title | RW | Character | Menu title text |
UIState | R | Character | The last UI State applied to the Page. |
Methods
This class supports the Common Methods plus the following:
Method | Args | Description |
---|---|---|
Add | None | Add a record and enter edit mode for the new record |
AddSection | id as Character, type as Character | Add a new section with the specified id and section type |
ApplyMetaData | None | Apply MetaData for the page (from v3.4). |
ApplyRules | None | Applies UI presentation rules for the page |
Cancel | None | Cancel data changes |
Delete | None | Delete the current record |
Edit | None | Toggle edit mode for the current record |
Editmode | None | Enter edit mode for the current record |
First | None | Move to the first data record |
GetJSON() | None | Return the current page data as JSON |
hideActionBarButtons | buttonList as Character | Hide the actionbar buttons specified in the buttonList comma-separated string. Valid buttons are: add, delete, refresh, first, previous, next, last, edit, save, cancel. From v6.3. |
hideSeachBox() | None | Hide the Instant Search box. From v5.4. |
Item | position as Numeric | Return a reference to the Section object at the specified position |
Last | None | Move to the last data record |
Next | None | Move to the next data record |
Previous | None | Move to the previous data record |
Refresh | None | Refresh the page |
RefreshNavigationPanel | url as Character | Refresh the Navigation Panel. From v5.0. |
RemoveSection | id as Character | Remove the specified section |
Save | None | Save data changes |
setRelationship | parentSection as character, childSection as character, parentKey as character, childKey as character |
Relate two sections in the page. From v5.0. |
showActionBarButtons | buttonList as Character | Show the (previously hidden) actionbar buttons specified in the buttonList comma-separated string. Valid buttons are: add, delete, refresh, first, previous, next, last, edit, save, cancel. From v6.3. |
showSeachBox() | None | Show the Instant Search box. From v5.4. |
Events
In Lianja, scripting language independent delegates are used to handle "events".
A full description of custom delegates is described in the Custom Delegates documentation.
The order in which delegates are dispatched is described in the Event Delegate Sequences documentation.