LayoutControl
LayoutControl is one these types:
LayoutControlArticleControl
AsideControl
BasicBlockControl
BootstrapColumnControl
BootstrapContainerControl
FooterControl
GridCellControl
GroupAndPagePanelProperties
GroupPanelControl
HeaderControl
ListControl
ListItemControl
ListPanelControl
MainControl
NavControl
PageControl
PagePanelControl
PanelControl
RepeatingTableControl
RepeatingTableListControl
RepeatingTableListRowControl
RepeatingTableRowControl
SectionControl
TabControl
TitlePanelControl
LayoutControl Functions
| getLayout | LayoutControl.getLayout( ) | Returns the Layout object configured for the container control or null if no layout is configured. |
| getLayoutType | LayoutControl.getLayoutType( ) | Returns a String representing the layout type for the container. |
ContainerControl Functions
| getChildControls | LayoutControl.getChildControls( ) | Returns an array of controls that are immediate children of this control. |
MessageProperties Functions
| getErrorMessageStyle | LayoutControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | LayoutControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | LayoutControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
Control Functions
| addCssClass | LayoutControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | LayoutControl.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 | LayoutControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | LayoutControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | LayoutControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | LayoutControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | LayoutControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | LayoutControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | LayoutControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | LayoutControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | LayoutControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | LayoutControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | LayoutControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | LayoutControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | LayoutControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | LayoutControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | LayoutControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | LayoutControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | LayoutControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | LayoutControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | LayoutControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | LayoutControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | LayoutControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | LayoutControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | LayoutControl.isNewLine( ) | Returns the new line property. |
| setNewLine | LayoutControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | LayoutControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | LayoutControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | LayoutControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | LayoutControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | LayoutControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | LayoutControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | LayoutControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | LayoutControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | LayoutControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | LayoutControl.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 | LayoutControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | LayoutControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | LayoutControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | LayoutControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | LayoutControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | LayoutControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageContainer Functions
| addErrorMessage | LayoutControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | LayoutControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | LayoutControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | LayoutControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | LayoutControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | LayoutControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | LayoutControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | LayoutControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | LayoutControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | LayoutControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | LayoutControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | LayoutControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | LayoutControl.getElementName( ) | Returns the element name |
| getElementType | LayoutControl.getElementType( ) | Returns the element type |
LayoutControlinterface is implemented by all controls that can act as a container i.e. they can contain other controls. Every container has a Layout which defines how the child controls of that container are positioned relative to each other - simple examples are horizontally and vertically.