Class Reference
IRIS for UNIX 2024.1.2
|
Class Reference
IRIS for UNIX 2024.1.2
|
|
|
Private
Storage
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This base class provides a standard template for portal pages implemented using Zen.
|
|
|
|
|
|
Set this to the appropriate application class.
If true, auto-switch namespace to whatever $NAMESPACE is passed in.
If this page has sort options, this is its initial sort mode.
If this page has multiple views, this is its initial display mode.
Set this to the correct domain.
SMP favorite icon.
URL of home page (used in links by many pages viahomePage .)
Allow pages to have iframes by not setting x-frame-options: same origin. Set default for Management Portal as iframes are not allowed.
Comma-separated list of additional JS include files for the page.
Name of this page.
If true, register visits to this page in the recent list.
If true, show the Namespace dropdown.
|
|
Define the title that will be displayed within subclasses
About page URL
Current sort mode for this page (if applicable).
For pages with steps, this is the current step (1-based).
If this page has "views", this is the current view type.
Product home page URL. Note that multiple portal pages rely on this being a fully formed link.
Set to true to suppress hyperevent error pop-ups in the event of a connectitivity failure.
True if the contents of this page need to be saved.
Current search key value (if applicable).
|
|
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link) Sub-class can override to include extra levels.
Decorate the page.
This callback is called at the start of the HTML HEAD section of the page (just after the title).
It allows a page to write out meta tags, if desired. The default implementation writes out an IE-specific meta tag to ensure that IE 9 and 10 don't fall back into Compatibility Mode when we are returning an HTML5 page (i.e.cssLevel is set to 3).
Get the (localized) name of the page. This should be implemented in a subclass.
Get the product name for the page.
Get the contents of the small menu in the title area.
Get the (localized) title string for the page. This should be implemented in a subclass.
Use soft modals for the portal.
Register this visit to the recent items list.
This method rebuilds context menu on the top left corner.
Helper method to ensure that the user has sufficient privileges to access the links returned inGetContextLinks (). This is especially important for cases where system administrators have specified custom resources for pages in the portal, as we need to check the custom resources before adding the option to the context menu.
Draw additional content in the locator bar.
Draw the contents of the tool ribbon. This is displayed if a subclass implements theOnGetRibbonInfo callback.
Draw the contents of the title area. Dispatch to application class.
Tranforms the link specified by link into a URL and returns it as a string
Define any context links for the page. Sub-class to override. Note that the subclass should callCheckContextLinks () to ensure that the user is actually permitted to access all of the links - the pages may have custom resources defined that would prevent the user from seeing the page.
Given a HelpAddress, this method finds the DocBook Link and constructs the proper URL for the Doc page and return to the client to be displayed.
Given new namespace, return new URL with new $NAMESPACE. When changing namespace, always go back to Home page
because you don't know if the new namespace has or allows your current page.
Define any quick links for the page
This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content is best wrapped within a single td element. It can also consist of multiple td elements.To achieve a fixed position for elements within the ribbon, for a fixed width page you can use a single enclosing td that contains a table and a single tr, with td elements inside that single tr that contain your content for the ribbon.
To achieve a fixed position for elements within the ribbon, for a page whose width varies depending on its contents (thereby stretching the ribbon) you can use multiple td elements to contain your content and then a final td element that is empty and has width 40% (or so) to push your contents towards the left and keep them in their proper locations.
This callback, if implemented returns information used to display the standard ribbon bar.
pDisplay is true if the ribbon should be displayed.
pViewIcons is an array describing "view" buttons to display: pViewIcons(n) = $LB(id,help,icon)
pSortOptions is an array describing "sort" options to display: pSortOptions(n) = $LB(id,caption,help)
pSearch is true if a search box is displayed.
pRibbonTitle is a title to display.
pCommands is an array of command buttons to display: pCommands(n) = $LB(id,caption,help,onclick)
Show dialog to change password
Get the title string to add to the locator row. This should be implemented in a subclass.
Return the height of the title area (titleBar plus locator).
Go to the home page.
Go to the menu link.
Navigate to a new namespace in the portal.
End the current session. If user has unsaved changes, prompt to save before process logout.
Navigate to a new page in the portal.
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
Custom handler for hyperEvent handlers to be (optionally) less intrusive if the cause of the error was an auto-refresh timer losing commectivity with the host.
This client event, if present, is fired when the page is loaded.
This client method, if defined and the AUTOLOGOUT parameter for this page is true, is invoked when the logout timer for this page fires.
If this method return true then the normal page logout behavior will fire. That is, the page will be reloaded causing a login page to appear if the current session has ended.
This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
Blur event in search box.
Change in search box value. Can be overridden by subclasses.
Blur event in search box.
Key down in search box.
Key press in search box.
Set the modified flag for the page.
Set the document name for the page.
Change the current sort mode for the page.
Do the actual work of updating the view to match the current sort mode.
Change the current display mode for this page. This is called by the icon buttons on the ribbon. This will call thesetViewModeHandler within a subclass.
Do the actual work of updating the view to match the current view mode.
Go to the about page.
Go to the about page.
Show documentation.
Show dialog to switch namespace