psdi.webclient.controls

Class Menus

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ControlInstance

psdi.webclient.controls.Menus

All Implemented Interfaces:

java.lang.Cloneable

public class Menus
extends ControlInstance

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMON_APPLINK_MENUITEM_LIBRARY_ID
static java.lang.String	COMMON_MENU_LIBRARY_ID
static java.lang.String	COMPONENT_TYPE_MENU
static java.lang.String	COMPONENT_TYPE_MENUITEM
static java.lang.String	ID_MENUITEM
static java.lang.String	LIBRARY_MENUS
static int	MENUTYPE_ACTIONS
static int	MENUTYPE_COMBOBOX
static int	MENUTYPE_DYNAMIC
static int	MENUTYPE_GOTO
static int	MENUTYPE_MENUBAR
static int	MENUTYPE_PROFILE
static int	MENUTYPE_QUERY
static int	MENUTYPE_REPORTS
static int	MENUTYPE_TOOLBAR
static int	MENUTYPE_UNKNOWN
static java.lang.String	PROPERTY_ACCESSKEY
static java.lang.String	PROPERTY_APP
static java.lang.String	PROPERTY_APPLINK
static java.lang.String	PROPERTY_APPNAME
static java.lang.String	PROPERTY_APPTYPE
static java.lang.String	PROPERTY_APPUID
static java.lang.String	PROPERTY_BORDER
static java.lang.String	PROPERTY_CLAUSENAME
static java.lang.String	PROPERTY_CMSENTRYID
static java.lang.String	PROPERTY_CMSEVENT
static java.lang.String	PROPERTY_CMSITEM
static java.lang.String	PROPERTY_COMPONENT
static java.lang.String	PROPERTY_CONTROL
static java.lang.String	PROPERTY_CONTROLVALUE
static java.lang.String	PROPERTY_CSSCLASS
static java.lang.String	PROPERTY_DISABLE_NULL
static java.lang.String	PROPERTY_DISABLE_QUERY
static java.lang.String	PROPERTY_DISABLE_READONLY
static java.lang.String	PROPERTY_DISABLED
static java.lang.String	PROPERTY_ELEMENTTYPE
static java.lang.String	PROPERTY_EVENT
static java.lang.String	PROPERTY_EVENTVALUE
static java.lang.String	PROPERTY_HEADER
static java.lang.String	PROPERTY_ID
static java.lang.String	PROPERTY_IMAGE
static java.lang.String	PROPERTY_INPUTMODE
static java.lang.String	PROPERTY_KEY
static java.lang.String	PROPERTY_LABEL
static java.lang.String	PROPERTY_LICENSEKEY
static java.lang.String	PROPERTY_LINK
static java.lang.String	PROPERTY_LOADLINK
static java.lang.String	PROPERTY_LOOKUP
static java.lang.String	PROPERTY_MAINMENU
static java.lang.String	PROPERTY_MENUPARENT
static java.lang.String	PROPERTY_MENUTYPE
static java.lang.String	PROPERTY_MODULE
static java.lang.String	PROPERTY_MXEVENT
static java.lang.String	PROPERTY_MXEVENT_CHG
static java.lang.String	PROPERTY_OPENAT
static java.lang.String	PROPERTY_QUERY
static java.lang.String	PROPERTY_READONLY
static java.lang.String	PROPERTY_SELECTVALUE
static java.lang.String	PROPERTY_SUBMENU
static java.lang.String	PROPERTY_TABDISPLAY
static java.lang.String	PROPERTY_TAG
static java.lang.String	PROPERTY_TARGET
static java.lang.String	PROPERTY_TEXT

Fields inherited from class psdi.webclient.system.controller.ControlInstance

amIinitialize, DATASOURCE, INPUTMODE, labelOverride, ONDATACAHNGE, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_LIGHTNING, PARAM_MOBILE, PARAM_MODULE, PARAM_PAGE, PARAM_PARENTCOMPONENT, PARAM_PARENTCONTROL, PARAM_PRESENTATION, PARAM_SCREENREADER, PARAM_SKINNAME, PARAM_TAB, PARAM_TABGROUP, PARAM_TABGROUP_MAIN, PARAM_TABLE, PARAM_USERINFO, PARAM_VERTICALLABEL, RERENDER_PROPERTY

Fields inherited from class psdi.webclient.system.controller.BaseInstance

EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors

Constructor and Description
Menus()

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildDummyMenu(org.w3c.dom.Element libraryMenu, boolean isSub, java.lang.String parentId)
java.lang.String	buildMenu(org.w3c.dom.Element libraryMenu, boolean isSub, java.lang.String parentId) This is used to build a menu from a menus.xml menu definition This now separates all sub menus and places them at the same level as the main menu
void	buildMenu(java.util.Map<?,java.util.Map<java.lang.String,java.lang.String>> options) Builds menus based on a Map of options This now spearates all sub menus and places them at the same level as the main menu
void	buildMenu(java.util.Map<?,java.util.Map<java.lang.String,java.lang.String>> options, int limit)
void	buildMenu(java.util.Map<?,java.util.Map<java.lang.String,java.lang.String>> options, int limit, WebClientEvent overflowEvent)
com.ibm.json.java.JSONObject	buildMenuCache(java.lang.String componentId)
java.util.Map<java.lang.String,java.lang.String>	changePropertyName(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String oldName, java.lang.String newName)
void	clearMenuData()
int	click() Handles the clicking of any menuitem
java.util.Map<java.lang.String,java.lang.String>	createMenuItemProperties(java.util.Map<java.lang.String,java.lang.String> oldMap)
int	fetchmenucache()
com.ibm.json.java.JSONObject	fetchMenuDef(int type, java.lang.String compId, java.lang.String menuId) Returns JSON definition for menu types or a static menu
com.ibm.json.java.JSONObject	fetchMenuDef(int type, java.lang.String compId, java.lang.String menuId, boolean inLeftNav) Returns JSON definition for menu types or a static menu
java.lang.String	getFirstMenuId()
java.lang.String	getFirstMenuItemId()
java.lang.String	getId() Return the ID
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getMenubarOptions() Create the Map of menus and menuitems for a menubar
java.util.Map<java.lang.String,java.lang.String>	getMenuItem(java.lang.String id) Walks current menus to find the correct item to use when clicked
java.util.ArrayList<MenuInstance>	getMenus()
com.ibm.json.java.JSONObject	getMenusAsJson()
int	getMenuType()
WebClientEvent	getOriginalEvent()
ComponentInstance	getParentComponent()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getQueryOptions() Create the Map of menus and items for the query dropdown
boolean	getShowSingle()
java.lang.String	getTriggerItemId()
boolean	hiddenByProperty(java.lang.String hideWhen) Allows hiding components via the registry by using reflection on parentControl (control that launched menu)
boolean	isGotoMenu()
int	render() Render this control's components
void	setIsGotoMenu(boolean showGoto)
void	setNeedsRender(boolean needsRender)
void	setRendered()
int	showmenu()

Methods inherited from class psdi.webclient.system.controller.ControlInstance

addChild, addComponent, broadcastEvent, canInsert, canInsert, canRemove, childHasError, childHasErrorFocus, cleanup, clearComponent, clearErrors, copy, createRenderId, errorLevelChanged, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getConditonallyChanged, getDataBean, getDataSource, getDescriptorControl, getDesignerProperty, getDesignerSelected, getDesignerSelectedControl, getElement, getErrorLevel, getGeneratedControl, getOriginalControl, getOriginalProperty, getProperties, getProperty, getProperty, getPropertyIgnoreFlags, getPropertyOriginator, getPropertyUncle, getRecordHover, getSkipPreRender, getTableControl, getTakesValueComponent, handleEvent, hasChanged, hasChangedConditionally, hasChildElements, hasMaskedChanged, hasRecordHover, hasVisibleChildren, initialize, instantiatedatasrc, isDesignerEditedProperty, isDisabled, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, isVisible, launchexternal, moveChild, needsRender, parseParamvalues, preRender, preRenderChecks, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setDesignerSelected, setDisabled, setElement, setErrorFocusOnControl, setFocus, setFocus, setFocusable, setFocusTable, setGenerated, setGeneratedControl, setIncluded, setIncluded, setOnTableFilterRow, setOnTableRow, setOnTableTitleRow, setOriginalControl, setPropertyOriginator, setPropertyUncle, setReInitialize, setReRenderFlags, setSelected, setSkipPreRender, setTableControl, setVisibility, stopRender, walkForId, walkForId

Methods inherited from class psdi.webclient.system.controller.BaseInstance

addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRenderId, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, hasAnyPropertyChanged, hasLocalProperty, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, isOnTableRow, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_MODULE

public static final java.lang.String PROPERTY_MODULE

See Also:

Constant Field Values

PROPERTY_APP

public static final java.lang.String PROPERTY_APP

See Also:

Constant Field Values

PROPERTY_QUERY

public static final java.lang.String PROPERTY_QUERY

See Also:

Constant Field Values

PROPERTY_HEADER

public static final java.lang.String PROPERTY_HEADER

See Also:

Constant Field Values

PROPERTY_OPENAT

public static final java.lang.String PROPERTY_OPENAT

See Also:

Constant Field Values

LIBRARY_MENUS

public static final java.lang.String LIBRARY_MENUS

See Also:

Constant Field Values

ID_MENUITEM

public static final java.lang.String ID_MENUITEM

See Also:

Constant Field Values

PROPERTY_MENUTYPE

public static final java.lang.String PROPERTY_MENUTYPE

See Also:

Constant Field Values

PROPERTY_APPTYPE

public static final java.lang.String PROPERTY_APPTYPE

See Also:

Constant Field Values

PROPERTY_TARGET

public static final java.lang.String PROPERTY_TARGET

See Also:

Constant Field Values

PROPERTY_ID

public static final java.lang.String PROPERTY_ID

See Also:

Constant Field Values

PROPERTY_ACCESSKEY

public static final java.lang.String PROPERTY_ACCESSKEY

See Also:

Constant Field Values

PROPERTY_CLAUSENAME

public static final java.lang.String PROPERTY_CLAUSENAME

See Also:

Constant Field Values

PROPERTY_COMPONENT

public static final java.lang.String PROPERTY_COMPONENT

See Also:

Constant Field Values

PROPERTY_CONTROL

public static final java.lang.String PROPERTY_CONTROL

See Also:

Constant Field Values

PROPERTY_CSSCLASS

public static final java.lang.String PROPERTY_CSSCLASS

See Also:

Constant Field Values

PROPERTY_DISABLED

public static final java.lang.String PROPERTY_DISABLED

See Also:

Constant Field Values

PROPERTY_DISABLE_NULL

public static final java.lang.String PROPERTY_DISABLE_NULL

See Also:

Constant Field Values

PROPERTY_DISABLE_READONLY

public static final java.lang.String PROPERTY_DISABLE_READONLY

See Also:

Constant Field Values

PROPERTY_DISABLE_QUERY

public static final java.lang.String PROPERTY_DISABLE_QUERY

See Also:

Constant Field Values

PROPERTY_READONLY

public static final java.lang.String PROPERTY_READONLY

See Also:

Constant Field Values

PROPERTY_KEY

public static final java.lang.String PROPERTY_KEY

See Also:

Constant Field Values

PROPERTY_EVENTVALUE

public static final java.lang.String PROPERTY_EVENTVALUE

See Also:

Constant Field Values

PROPERTY_IMAGE

public static final java.lang.String PROPERTY_IMAGE

See Also:

Constant Field Values

PROPERTY_ELEMENTTYPE

public static final java.lang.String PROPERTY_ELEMENTTYPE

See Also:

Constant Field Values

PROPERTY_TEXT

public static final java.lang.String PROPERTY_TEXT

See Also:

Constant Field Values

PROPERTY_MAINMENU

public static final java.lang.String PROPERTY_MAINMENU

See Also:

Constant Field Values

PROPERTY_SUBMENU

public static final java.lang.String PROPERTY_SUBMENU

See Also:

Constant Field Values

PROPERTY_TAG

public static final java.lang.String PROPERTY_TAG

See Also:

Constant Field Values

PROPERTY_MENUPARENT

public static final java.lang.String PROPERTY_MENUPARENT

See Also:

Constant Field Values

PROPERTY_MXEVENT

public static final java.lang.String PROPERTY_MXEVENT

See Also:

Constant Field Values

PROPERTY_MXEVENT_CHG

public static final java.lang.String PROPERTY_MXEVENT_CHG

See Also:

Constant Field Values

PROPERTY_TABDISPLAY

public static final java.lang.String PROPERTY_TABDISPLAY

See Also:

Constant Field Values

COMPONENT_TYPE_MENU

public static final java.lang.String COMPONENT_TYPE_MENU

See Also:

Constant Field Values

COMPONENT_TYPE_MENUITEM

public static final java.lang.String COMPONENT_TYPE_MENUITEM

See Also:

Constant Field Values

PROPERTY_APPLINK

public static final java.lang.String PROPERTY_APPLINK

See Also:

Constant Field Values

PROPERTY_LOOKUP

public static final java.lang.String PROPERTY_LOOKUP

See Also:

Constant Field Values

PROPERTY_LOADLINK

public static final java.lang.String PROPERTY_LOADLINK

See Also:

Constant Field Values

PROPERTY_SELECTVALUE

public static final java.lang.String PROPERTY_SELECTVALUE

See Also:

Constant Field Values

PROPERTY_LINK

public static final java.lang.String PROPERTY_LINK

See Also:

Constant Field Values

PROPERTY_LABEL

public static final java.lang.String PROPERTY_LABEL

See Also:

Constant Field Values

PROPERTY_EVENT

public static final java.lang.String PROPERTY_EVENT

See Also:

Constant Field Values

PROPERTY_BORDER

public static final java.lang.String PROPERTY_BORDER

See Also:

Constant Field Values

PROPERTY_LICENSEKEY

public static final java.lang.String PROPERTY_LICENSEKEY

See Also:

Constant Field Values

PROPERTY_APPNAME

public static final java.lang.String PROPERTY_APPNAME

See Also:

Constant Field Values

PROPERTY_APPUID

public static final java.lang.String PROPERTY_APPUID

See Also:

Constant Field Values

PROPERTY_CONTROLVALUE

public static final java.lang.String PROPERTY_CONTROLVALUE

See Also:

Constant Field Values

PROPERTY_INPUTMODE

public static final java.lang.String PROPERTY_INPUTMODE

See Also:

Constant Field Values

COMMON_MENU_LIBRARY_ID

public static final java.lang.String COMMON_MENU_LIBRARY_ID

See Also:

Constant Field Values

COMMON_APPLINK_MENUITEM_LIBRARY_ID

public static final java.lang.String COMMON_APPLINK_MENUITEM_LIBRARY_ID

See Also:

Constant Field Values

PROPERTY_CMSITEM

public static final java.lang.String PROPERTY_CMSITEM

See Also:

Constant Field Values

PROPERTY_CMSEVENT

public static final java.lang.String PROPERTY_CMSEVENT

See Also:

Constant Field Values

PROPERTY_CMSENTRYID

public static final java.lang.String PROPERTY_CMSENTRYID

See Also:

Constant Field Values

MENUTYPE_UNKNOWN

public static final int MENUTYPE_UNKNOWN

See Also:

Constant Field Values

MENUTYPE_COMBOBOX

public static final int MENUTYPE_COMBOBOX

See Also:

Constant Field Values

MENUTYPE_GOTO

public static final int MENUTYPE_GOTO

See Also:

Constant Field Values

MENUTYPE_QUERY

public static final int MENUTYPE_QUERY

See Also:

Constant Field Values

MENUTYPE_ACTIONS

public static final int MENUTYPE_ACTIONS

See Also:

Constant Field Values

MENUTYPE_MENUBAR

public static final int MENUTYPE_MENUBAR

See Also:

Constant Field Values

MENUTYPE_REPORTS

public static final int MENUTYPE_REPORTS

See Also:

Constant Field Values

MENUTYPE_PROFILE

public static final int MENUTYPE_PROFILE

See Also:

Constant Field Values

MENUTYPE_DYNAMIC

public static final int MENUTYPE_DYNAMIC

See Also:

Constant Field Values

MENUTYPE_TOOLBAR

public static final int MENUTYPE_TOOLBAR

See Also:

Constant Field Values

Constructor Detail

Menus

public Menus()

Method Detail

render

public int render()
           throws java.lang.NoSuchMethodException,
                  java.lang.IllegalAccessException,
                  java.lang.reflect.InvocationTargetException

Description copied from class: ControlInstance

Render this control's components

Overrides:

render in class ControlInstance

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

clearMenuData

public void clearMenuData()

setIsGotoMenu

public void setIsGotoMenu(boolean showGoto)

getParentComponent

public ComponentInstance getParentComponent()

getTriggerItemId

public java.lang.String getTriggerItemId()

setRendered

public void setRendered()

getMenuType

public int getMenuType()

getFirstMenuId

public java.lang.String getFirstMenuId()

getFirstMenuItemId

public java.lang.String getFirstMenuItemId()

isGotoMenu

public boolean isGotoMenu()

getOriginalEvent

public WebClientEvent getOriginalEvent()

showmenu

public int showmenu()

getMenus

public java.util.ArrayList<MenuInstance> getMenus()

buildMenuCache

public com.ibm.json.java.JSONObject buildMenuCache(java.lang.String componentId)

fetchMenuDef

public com.ibm.json.java.JSONObject fetchMenuDef(int type,
                                                 java.lang.String compId,
                                                 java.lang.String menuId)

Returns JSON definition for menu types or a static menu

fetchMenuDef

public com.ibm.json.java.JSONObject fetchMenuDef(int type,
                                                 java.lang.String compId,
                                                 java.lang.String menuId,
                                                 boolean inLeftNav)

Returns JSON definition for menu types or a static menu

fetchmenucache

public int fetchmenucache()
                   throws java.io.IOException,
                          MXException

Throws:

java.io.IOException

MXException

getMenusAsJson

public com.ibm.json.java.JSONObject getMenusAsJson()

getMenubarOptions

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getMenubarOptions()

Create the Map of menus and menuitems for a menubar

getQueryOptions

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getQueryOptions()

Create the Map of menus and items for the query dropdown

buildMenu

public java.lang.String buildMenu(org.w3c.dom.Element libraryMenu,
                                  boolean isSub,
                                  java.lang.String parentId)

This is used to build a menu from a menus.xml menu definition This now separates all sub menus and places them at the same level as the main menu

Parameters:

Element - xml menu element

Boolean - is this a sub menu

String - parent menus id

buildDummyMenu

public java.lang.String buildDummyMenu(org.w3c.dom.Element libraryMenu,
                                       boolean isSub,
                                       java.lang.String parentId)

buildMenu

public void buildMenu(java.util.Map<?,java.util.Map<java.lang.String,java.lang.String>> options)

Builds menus based on a Map of options This now spearates all sub menus and places them at the same level as the main menu

Parameters:

Map - of menitems

buildMenu

public void buildMenu(java.util.Map<?,java.util.Map<java.lang.String,java.lang.String>> options,
                      int limit)

buildMenu

public void buildMenu(java.util.Map<?,java.util.Map<java.lang.String,java.lang.String>> options,
                      int limit,
                      WebClientEvent overflowEvent)

createMenuItemProperties

public java.util.Map<java.lang.String,java.lang.String> createMenuItemProperties(java.util.Map<java.lang.String,java.lang.String> oldMap)

changePropertyName

public java.util.Map<java.lang.String,java.lang.String> changePropertyName(java.util.Map<java.lang.String,java.lang.String> props,
                                                                           java.lang.String oldName,
                                                                           java.lang.String newName)

getMenuItem

public java.util.Map<java.lang.String,java.lang.String> getMenuItem(java.lang.String id)

Walks current menus to find the correct item to use when clicked

click

public int click()

Handles the clicking of any menuitem

getShowSingle

public boolean getShowSingle()

setNeedsRender

public void setNeedsRender(boolean needsRender)

Overrides:

setNeedsRender in class ControlInstance

hiddenByProperty

public boolean hiddenByProperty(java.lang.String hideWhen)

Allows hiding components via the registry by using reflection on parentControl (control that launched menu)

getId

public java.lang.String getId()

Return the ID

Overrides:

getId in class BaseInstance

Returns:

Returns the id.