Show TOC

Background documentationTray Function Tags Locate this document in the navigation structure

 

The layout tag library provides tags for creating links that invoke tray functions, such as refreshing or personalizing the iView.

For each type of link, the following types of tags are available (an example is shown in parentheses):

  • Anchor Tag (IViewAbout): Creates a link to invoke a tray function. The tag's body is the text or image for the link. The tag has optional anchorAttributes attribute with which you can add additional HTML anchor tag attributes to the link. You can add any attribute except href and onclick that are already used.

  • Anchor Text Tag (IViewAboutTitle): Displays default and localized text for the link that invokes a tray function. This tag is included in the body of the anchor tag.

  • Conditional, Administrator Setting is On (IfIViewAboutAvailable): The body of the tag is included if the iView's properties are set to display the specific link. For each iView, the administrator can choose whether to display links to specific tray functions.

  • Conditional, Administrator Setting is Off (IfIViewAboutNotAvailable): The body of the tag is included if the iView's properties are set not to display the specific link. For each iView, the administrator can choose whether to display links to specific tray functions.

Tray Functions

Tags are available for the following tray functions (available tags are listed after each function):

  • About: Displays information about the iView.

    • IViewAbout

    • IViewAboutTitle

    • IfIViewAboutAvailable

    • IfIViewAboutNotAvailable

  • Expand: Opens the iView in a new window.

    • IViewExpand

    • IViewExpandTitle

    • IfIViewExpandAvailable

    • IfIViewExpandNotAvailable

  • Help: Displays help for the iView.

    • IViewHelp

    • IViewHelpTitle

    • IfIViewHelpAvailable

    • IfIViewHelpNotAvailable

  • Personalize: Displays the personalize dialog for the iView.

    • IViewPersonalize

    • IViewPersonalizeTitle

    • IfIViewPersonalizeAvailable

    • IfIViewPersonalizeNotAvailable

  • Refresh: Refreshes the iView.

    • IViewRefresh

    • IViewRefreshTitle

    • IfIViewRefreshAvailable

    • IfIViewRefreshNotAvailable

  • Remove: Removes the iView from the current page.

    • IViewRemove

    • IViewRemoveTitle

    • IfIViewRemoveAvailable

    • IfIViewRemoveNotAvailable

Coordinating Tags

These tags must be nested in the following tag:

containerWithTrayDesign

Example

The following is a section of a layout JSP page that displays a link for each tray function if the administrator has set that link to be displayed for the current iView. Each link carries an additional class attribute. The code must be nested in a containerWithTrayDesign tag.

Example Example

  1. <lyt:IfIViewExpandAvailable>
    <lyt:IViewExpand anchorAttributes="class='ivuExpand'">
        <lyt:IviewExpandTitle/>
    </lyt:IViewExpand> |
</lyt:IfIViewExpandAvailable>

<lyt:IfIViewRefreshAvailable>
    <lyt:IViewRefresh anchorAttributes="class='ivuRefresh'">
        <lyt:IViewRefreshTitle/>
    </lyt:IViewRefresh> |
</lyt:IfIViewRefreshAvailable>

<lyt:IfIViewAboutAvailable>
    <lyt:IViewAbout anchorAttributes="class='ivuAbout'">
        <lyt:IViewAboutTitle/>
    </lyt:IViewAbout> |
</lyt:IfIViewAboutAvailable>

<lyt:IfIViewHelpAvailable>
    <lyt:IViewHelp anchorAttributes="class='ivuHelp'">
        <lyt:IViewHelpTitle/>
    </lyt:IViewHelp> |
</lyt:IfIViewHelpAvailable>

<lyt:IfIViewRemoveAvailable>
    <lyt:IViewRemove anchorAttributes="class='ivuRemove'">
        <lyt:IViewRemoveTitle/>
    </lyt:IViewRemove> |
</lyt:IfIViewRemoveAvailable>

<lyt:IfIViewPersonalizeAvailable>
    <lyt:IViewPersonalize anchorAttributes="class='ivuPersonalize'">
        <lyt:IViewPersonalizeTitle/>
    </lyt:IViewPersonalize>
</lyt:IfIViewPersonalizeAvailable>
End of the code.