|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.editor.LeftNavMenu
public class LeftNavMenu
This is helper class that contains the implementation of the left navigation menu as well as two inner classes. One for the sub menus and one the links. This class is mainly used by EditorAS and classes extending it. The left navigation menu is printed out in EditorHeaderView.
Constructor Summary | |
---|---|
LeftNavMenu(java.lang.String _sCurrentASName)
Creates a new Left Nav Menu object. |
Method Summary | |
---|---|
void |
AddJavaScriptValidationToLink(java.lang.String _sDPName,
java.lang.String _sJSName)
To set a JavaScript to be called when the user tries to go to a particular Display Page. |
int |
AddLinkToSubMenu(int _nSubMenuID,
java.lang.String _dpName)
Creates a new link and adds it to the sub menu identified by the ID passed in argument. |
int |
AddLinkToSubMenu(int _nSubMenuID,
java.lang.String _dpName,
boolean _bIsMandatory)
Creates a new link and adds it to the sub menu identified by the ID passed in argument. |
XPArrayList |
GetArrayOfNonVisitedMandatoryPages()
Returns the array of non visited mandatory pages. |
XPArrayList |
GetArraySubMenus()
Returns the array of sub menus. |
boolean |
HasUnvisitedMandatoryPage()
Returns true if some of the mandatory pages have not been visited |
void |
HideLink(boolean _bHide,
int _nSubMenuID,
int _nLinkID)
Will display or hide the link identified by the ID in argument. |
void |
HideLink(boolean _bHide,
java.lang.String _sDPName)
Will display or hide the link identified by the Display Page name in argument. |
void |
HideSubMenu(boolean _bHide,
int _nSubMenuID)
Will display or hide the sub menu identified by the ID in argument. |
void |
RemovePageFromMandatoryArray(java.lang.String _dpName)
Removes the page in argument from the array of mandatory pages. |
void |
SetMandatoryPage(boolean _bIsMandatory,
java.lang.String _dpName)
Changes the status of the page in argument to mandatory or to non-mandatory. |
int |
StartNewSubMenu(java.lang.String _sSubMenuTitle)
Creates a new sub menu, adds it to the array of menus and returns the ID of that new sub menu. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LeftNavMenu(java.lang.String _sCurrentASName)
_sCurrentASName
- name of the AS you create that menu fromMethod Detail |
---|
public void RemovePageFromMandatoryArray(java.lang.String _dpName)
_dpName
- Name of the Display Page to removepublic void SetMandatoryPage(boolean _bIsMandatory, java.lang.String _dpName)
_bIsMandatory
- New status_dpName
- Name of the Display Pagepublic void AddJavaScriptValidationToLink(java.lang.String _sDPName, java.lang.String _sJSName)
_sDPName
- Name of the Display Page to modify_sJSName
- Name of the JavaScript functionpublic XPArrayList GetArrayOfNonVisitedMandatoryPages()
public boolean HasUnvisitedMandatoryPage()
public int AddLinkToSubMenu(int _nSubMenuID, java.lang.String _dpName)
_nSubMenuID
- ID of the sub menu you want to add that link to_dpName
- name of the display page this link should go to
public int AddLinkToSubMenu(int _nSubMenuID, java.lang.String _dpName, boolean _bIsMandatory)
_nSubMenuID
- ID of the sub menu you want to add that link to_dpName
- name of the display page this link should go to_bIsMandatory
- true if the link is mandatory
public XPArrayList GetArraySubMenus()
public void HideLink(boolean _bHide, int _nSubMenuID, int _nLinkID)
_bHide
- true to hide it, false to not hide it_nSubMenuID
- ID of the sub menu containing the link_nSubMenuID
- ID of the link in that sub menupublic void HideLink(boolean _bHide, java.lang.String _sDPName)
_bHide
- true to hide it, false to not hide it_sDPName
- Name of the Display Page to hidepublic void HideSubMenu(boolean _bHide, int _nSubMenuID)
_bHide
- true to hide it, false to not hide it_nSubMenuID
- ID of the sub menupublic int StartNewSubMenu(java.lang.String _sSubMenuTitle)
_sSubMenuTitle
-
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |