TablePageControl

A Table Page Control represents a horizontal page of table data and can only be added as a child of a TableControl. When a Table Control contains more than one Table Page Control, horizontal scrolling is automatically activated.

Further documentation

ContainerControl Functions

getChildControls TablePageControl.getChildControls( ) Returns an array of controls that are immediate children of this control.

Control Functions

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

MessageContainer Functions

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

Element Functions

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