DynamicMenuItemControl

A Dynamic Menu Item Control represents a location in a menu where any number of menu items are to be inserted at runtime.

Further documentation

DynamicMenuItemControl Functions

setModel

DynamicMenuItemControl.setModel( model )

Sets the model representing the dynamic menu stucture to be added to the parent menu, where model is an XML string containing a structure of menu items.

MenuItemControl Functions

getItemName	DynamicMenuItemControl.getItemName( )	The name that uniquely identifies each menu item within a menu.
getName	DynamicMenuItemControl.getName( )

Control Functions

addCssClass	DynamicMenuItemControl.addCssClass( cssClass )	Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes.
getAll	DynamicMenuItemControl.getAll( )	Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page.
isContainer	DynamicMenuItemControl.isContainer( )	Returns true if this control is a container control i.e.
getCssClass	DynamicMenuItemControl.getCssClass( )	Returns the list of CSS classes configured for the control.
setCssClass	DynamicMenuItemControl.setCssClass( cssClass )	Sets one or more CSS classes to be applied to the control.
isDisplayOnly	DynamicMenuItemControl.isDisplayOnly( )	Returns `true` if the control is marked as display only, otherwise returns `false`.
setDisplayOnly	DynamicMenuItemControl.setDisplayOnly( displayOnly )	Marks the control and all its children as display only (when `displayOnly` is `true`) or enterable (when `displayOnly` is `false`).
isDisplayOnlyIncludingParents	DynamicMenuItemControl.isDisplayOnlyIncludingParents( )	Returns `true` if the control or any of its parents is marked as display only, otherwise returns `false`.
getErrorMsgClass	DynamicMenuItemControl.getErrorMsgClass( )	Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control.
setErrorMsgClass	DynamicMenuItemControl.setErrorMsgClass( errorMsgClass )	Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control.
getErrorMsgStyle	DynamicMenuItemControl.getErrorMsgStyle( )	Returns the inline CSS style configured for error messages when the messages are displayed locally to the control.
setErrorMsgStyle	DynamicMenuItemControl.setErrorMsgStyle( errorMsgStyle )	Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control.
isEventField	DynamicMenuItemControl.isEventField( )	Returns `true` if the control is an event field i.e.
hasModifier	DynamicMenuItemControl.hasModifier( modifier )	Returns true if the control has the specified modifier, otherwise returns false.
isHidden	DynamicMenuItemControl.isHidden( )	Returns `true` if the control is marked as hidden, otherwise returns `false`.
setHidden	DynamicMenuItemControl.setHidden( hidden )	Hides or shows the control and all its children.
hide	DynamicMenuItemControl.hide( )	Hides the control, this is equivalent to setting property `hidden` to `true`.
getInfoMsgClass	DynamicMenuItemControl.getInfoMsgClass( )	Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control.
setInfoMsgClass	DynamicMenuItemControl.setInfoMsgClass( infoMsgClass )	Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control.
getInfoMsgStyle	DynamicMenuItemControl.getInfoMsgStyle( )	Returns the inline CSS style configured for info messages when the messages are displayed locally to the control.
setInfoMsgStyle	DynamicMenuItemControl.setInfoMsgStyle( infoMsgStyle )	Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control.
isInheritMsg	DynamicMenuItemControl.isInheritMsg( )	Returns `true` if Use parent control setting is checked in the Message Options properties for the control, otherwise returns `false`.
getLayoutCell	DynamicMenuItemControl.getLayoutCell( )	Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control.
isLocalMsg	DynamicMenuItemControl.isLocalMsg( )	Returns `true` if Local Message is checked in the Message Options properties for the control, otherwise returns `false`.
isNewLine	DynamicMenuItemControl.isNewLine( )	Returns the new line property.
setNewLine	DynamicMenuItemControl.setNewLine( newLine )	Sets or unsets the control's new line property.
getNextSiblingControl	DynamicMenuItemControl.getNextSiblingControl( )	Returns the control that appears after this control within the same parent, or null if no such control exists.
getPage	DynamicMenuItemControl.getPage( )	Returns the com.ebasetech.xi.api.Page where this control is located.
getParentControl	DynamicMenuItemControl.getParentControl( )	Returns this control's parent control or null if no such parent exists.
getPreviousSiblingControl	DynamicMenuItemControl.getPreviousSiblingControl( )	Returns the control that appears before this control within the same parent, or null if no such control exists.
refresh	DynamicMenuItemControl.refresh( )	Refreshes this control in the user's browser when the page is next displayed.
removeCssClass	DynamicMenuItemControl.removeCssClass( cssClass )	Removes one or more CSS classes from the control.
requestFocus	DynamicMenuItemControl.requestFocus( )	Sets the browser focus to the control.
getRootHtmlElementProperties	DynamicMenuItemControl.getRootHtmlElementProperties( )	Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control
show	DynamicMenuItemControl.show( )	Shows the control, this is equivalent to setting property `hidden` to `false`.
isShowing	DynamicMenuItemControl.isShowing( )	Returns `true` if the control will be included in the web page when it's next displayed to the user, otherwise returns `false`.
getStyle	DynamicMenuItemControl.getStyle( )	Returns the inline CSS style configured for the control.
setStyle	DynamicMenuItemControl.setStyle( style )	Sets inline CSS style to be applied to the control.
getWarningMsgClass	DynamicMenuItemControl.getWarningMsgClass( )	Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control.
setWarningMsgClass	DynamicMenuItemControl.setWarningMsgClass( warningMsgClass )	Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control.
getWarningMsgStyle	DynamicMenuItemControl.getWarningMsgStyle( )	Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control.
setWarningMsgStyle	DynamicMenuItemControl.setWarningMsgStyle( warningMsgStyle )	Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control.

MessageProperties Functions

getErrorMessageStyle	DynamicMenuItemControl.getErrorMessageStyle( )	Returns the MessageStyleProperties object representing error message styling properties.
getInfoMessageStyle	DynamicMenuItemControl.getInfoMessageStyle( )	Returns the MessageStyleProperties object representing info message styling properties.
getWarningMessageStyle	DynamicMenuItemControl.getWarningMessageStyle( )	Returns the MessageStyleProperties object representing warning message styling properties.

MessageContainer Functions

addErrorMessage	DynamicMenuItemControl.addErrorMessage( message [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessage	DynamicMenuItemControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessageText	DynamicMenuItemControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage	DynamicMenuItemControl.addInfoMessage( message [, stopProcessing ] )	Adds an information message that will be displayed to the user.
addInfoMessageText	DynamicMenuItemControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage	DynamicMenuItemControl.addWarningMessage( message [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessage	DynamicMenuItemControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessageText	DynamicMenuItemControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages	DynamicMenuItemControl.existErrorMessages( )	Returns `true` if undisplayed error messages exist for this element, otherwise returns `false`.
existInfoMessages	DynamicMenuItemControl.existInfoMessages( )	Returns `true` if undisplayed info messages exist for this element, otherwise returns `false`.
existMessages	DynamicMenuItemControl.existMessages( )	Returns `true` if undisplayed info, warning or error messages exist for this element, otherwise returns `false`.
existWarningMessages	DynamicMenuItemControl.existWarningMessages( )	Returns `true` if undisplayed warning messages exist for this element, otherwise returns `false`.

Element Functions

getElementName	DynamicMenuItemControl.getElementName( )	Returns the element name
getElementType	DynamicMenuItemControl.getElementType( )	Returns the element type