| Function |
Description |
Arguments |
| this%pathPage |
Derive the following variables from the Path Page:
- this%PP
- this%EntryPP
- this%FamilyPP
- this%SP
- this%EntrySP
- this%FamilySP
- this%PageNumber
- this%PageExt
If you want the PortalObject to derive these variables from another Path Page instead of the one in the URL, call this function with an explicit PP argument. |
PP: Path Page
DirectoryIndex |
| this%menuLoad |
Load the Menu specified by this%MenuName, initialise this%TopicAddress and load this%PageInfo.
If you want to reload the Menu and this%PageInfo of a different menu entry, call this function with an explicit TopicAddress to identify the menu entry you want. |
TopicAddress |
| this%menuSelectOptionTags |
Return a series of <option ...> tags in for the menu entries, with proper indentation. If the argument "selected" is specified, the <option ...> tag containing such menu entry will be marked "selected". |
selected: the menu entry to be marked "selected" in the <option ...> tag. |
| this%listMenu |
Return the this%ListMenu variable, which is a ready-made HTML string presenting menu entries vertically. If the argument "show" is specified, 0 means to have all items listed (a site map), 1 (default) is the hierarchical format and 2 shows only the path to the item. |
format, show |
| this%pathMenu |
Return the this%PathMenu variable, which is a ready-made HTML string presenting the menu path to the current entry horizontally |
format |
| this%pageBar |
Return the this%PageBar variable, which is a ready-made HTML string presenting a page bar containing all pages of the topic ({this%PageNumber} of them) with navigation arrows. The href links on the page bar are stored in this%PageBarHref. The elements are "new", "prevtopic", "nexttopic", "prevpage", "@1", "@2", ..., "nextpage". Links not shown will be undefined and the link for the current page (in the form of "@n" will be defined but blank. |
|
| this%menuRefresh |
update this%MenuSelectOptionTags, this%ListMenu and this%PathMenu based on the current Menu. |
(none) |
| this%auth |
Perform the Login or Logout process, and return the status and message. |
Defaults to sys%form: Submit, username, password, realm
Default to this%: SessionTimeout, IdleTimeout |
| this%clientScripts |
Display the standard client scripts (must be called right after <body ...>) |
(none) |
| this%parsePageName |
Parse the argument and return an array indexed by "Family", "PageNumber" and "PageExt". If there is no PageNumber in the argument, it will be set to 1. |
parsePageName |
| this%genPageName |
Return the Page Name from the "Family", "PageNumber" and "PageExt" elements of the argument array. If "PageNumber" is 1 or null, the PageNumber part of the Page Number will be absent. |
genPageName |
| this%convPath |
A conversion converting a path name into a normalised name with one and only one '/' in front and no '/' at end. |
If arguments are specified, the first will preceed the result and the second will be appended to the result. |
| this%convPN |
A conversion converting the input page number into one of the three arguments. |
If the input page number is 1, return the first argument; if the page is the last page of the topic, the third; otherwise, the second. "@pn" in the argument will be substituted by the input page number. The first argument default to "@pn", the second to the first and the third to the second. |
|
|
|
|
|
|
|
|
|
|
|
|