MapFluid Class Methods
In this section, the MapFluid class methods are presented in alphabetical order.
Syntax
AddMenuItemToActionMenu(&Map, index, key, label, URL, classes, JS_function)
Description
Use this method to add a list item to the actions list that is displayed in the header for the PeopleSoft Fluid Interface.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Map |
Specifies the MAP application as an already instantiated Map object. |
| index |
Specifies the location of the new list item as a Number. Note: An index of 1 is the top of the actions list. |
| key |
Specifies a unique key for the new list item as a String. Note: PeopleTools has reserved the following list item keys: HOME, SRCH, NAVG, and LOGOUT. |
| label |
Specifies the label for the new list item as a String. |
| URL |
Specifies the target URL for the new list item as a String. |
| classes |
Specifies custom CSS style classes as a String. |
| JS_function |
Specifies a custom JavaScript function as a String. Note: If no custom function is specified, then the delivered ChangeActionMenuSelection(this,true) function is invoked. |
Returns
None
Example
Local PT_MAP_ADMIN:MapFluid &oToolbar = create PT_MAP_ADMIN:MapFluid();
&oToolbar.AddMenuItemToActionMenu(&Map, 1, "PENDING", MsgGetText(18081, 25014, "No message found: Pending Approvals."), &URL, "color:red;", "my_function(true)");
&oToolbar.RenderActionMenuHTML(&Map);
Syntax
RemoveAction(&Map, key, button, menu)
Description
Use this method to remove an item from the actions list (which is displayed in the header for the PeopleSoft Fluid Interface), from the button tool bar, or both.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Map |
Specifies the MAP application as an already instantiated Map object. |
| key |
Specifies a unique key for the list item to be removed as a String. Note: PeopleTools has reserved the following list item keys: HOME, SRCH, NAVG, and LOGOUT. |
| button |
Specifies a Boolean value indicating whether to remove this item from the main fluid page header. The default value is False. |
| menu |
Specifies a Boolean value indicating whether to remove this list item from the actions list. The default value is False. |
Returns
None
Example
In the following example, the Search button will be removed from the main fluid header and the Search list item will also be removed from the actions list:
Local PT_MAP_ADMIN:MapFluid &oToolbar = create PT_MAP_ADMIN:MapFluid();
&oToolbar.RemoveAction(&Map, "SRCH", False, True);
&oToolbar.RenderActionMenuHTML(&Map);
Syntax
RenderActionMenuHTML(&Map)
Description
Use this method to render the HTML representing the complete actions list that is displayed in the header for the PeopleSoft Fluid Interface.
You must invoke this method after invoking AddMenuItemToActionMenu, RemoveAction, or UpdateSignOutURL to make changes to the structure of the actions list.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Map |
Specifies the MAP application as an already instantiated Map object. |
Returns
None
Example
&oToolbar.RenderActionMenuHTML(&Map);Syntax
UpdateSignOutURL(&Map, URL)
Description
Use this method to change the URL that is invoked when a user clicks Sign out in the actions list.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Map |
Specifies the MAP application as an already instantiated Map object. |
| URL |
Specifies the new URL as a String. |
Returns
None
Example
Local PT_MAP_ADMIN:MapFluid &oToolbar = create PT_MAP_ADMIN:MapFluid();
&oToolbar.UpdateSignOutURL(&Map, &URL | "/?cmd=logout&fmode=1");
&oToolbar.RenderActionMenuHTML(&Map);