ImageColumnControl

Image Column Control.

Further documentation.

ImageColumnControl Functions

getHeaderText ImageColumnControl.getHeaderText( ) Returns the com.ebasetech.xi.api.Text object for the column header text.
getImageHtmlElementProperties ImageColumnControl.getImageHtmlElementProperties( ) Return the image com.ebasetech.xi.api.controls.HtmlElementProperties for the Image Column Control
getImageProperties ImageColumnControl.getImageProperties( ) Image properties
getStripedImageProperties ImageColumnControl.getStripedImageProperties( ) Image properties applied to alternate (striped) rows.

ColumnStyleProperties Functions

getColumnCellClass ImageColumnControl.getColumnCellClass( ) Returns the list of CSS classes configured for each table cell.
setColumnCellClass ImageColumnControl.setColumnCellClass( columnCellClass ) Sets one or more CSS classes to be applied to each table cell.
getColumnCellStyle ImageColumnControl.getColumnCellStyle( ) Returns the inline CSS style configured for each table cell.
setColumnCellStyle ImageColumnControl.setColumnCellStyle( columnCellStyle ) Sets the inline CSS style to be applied to each table cell.
getColumnDataClass ImageColumnControl.getColumnDataClass( ) Returns the list of CSS classes configured for the content of each table cell.
setColumnDataClass ImageColumnControl.setColumnDataClass( columnDataClass ) Sets one or more CSS classes to be applied to the content of each table cell.
getColumnDataStyle ImageColumnControl.getColumnDataStyle( ) Returns the inline CSS style configured for the content of each table cell.
setColumnDataStyle ImageColumnControl.setColumnDataStyle( columnDataStyle ) Sets the inline CSS style to be applied to the content of each table cell.
getColumnHeaderProperties ImageColumnControl.getColumnHeaderProperties( ) Column header properties.
getStripeProperties ImageColumnControl.getStripeProperties( ) Cell text, background, border and padding properties applied to alternate (striped) rows.

Control Functions

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

ImageControlProperties Functions

getAlternativeText ImageColumnControl.getAlternativeText( ) Returns the com.ebasetech.xi.api.Text object for the image alternate text.
isDisplayAsHyperlink ImageColumnControl.isDisplayAsHyperlink( ) Returns true if the image should behave as a hyperlink when clicked, otherwise returns false.
setDisplayAsHyperlink ImageColumnControl.setDisplayAsHyperlink( displayAsHyperlink ) Sets whether or not the image should behave as a hyperlink when clicked,.
getHyperlinkTarget ImageColumnControl.getHyperlinkTarget( ) Returns the target window id or frame id in which the hyperlink URL is displayed.
setHyperlinkTarget ImageColumnControl.setHyperlinkTarget( hyperlinkTarget ) Sets the target window id or frame id in which the hyperlink URL is displayed.
getHyperlinkURL ImageColumnControl.getHyperlinkURL( ) Returns the hyperlink URL activated when the displayAsHyperlink property is set to true.
setHyperlinkURL ImageColumnControl.setHyperlinkURL( hyperlinkURL ) Sets the hyperlink URL activated when the displayAsHyperlink property is set to true.
getImageURL ImageColumnControl.getImageURL( ) Returns the URL of the image to be displayed.
setImageURL ImageColumnControl.setImageURL( imageURL ) Sets the URL of the image to be displayed.
getMouseOverText ImageColumnControl.getMouseOverText( ) Returns the com.ebasetech.xi.api.Text object for the mouse over text.
isSkipValidation ImageColumnControl.isSkipValidation( ) Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the image's on click event (if configured).
setSkipValidation ImageColumnControl.setSkipValidation( skipValidation ) Specifies whether or not validation of controls higher on the page is skipped prior to executing the image's on click event (if configured).

MessageProperties Functions

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

CellStyleProperties Functions

getHAlign ImageColumnControl.getHAlign( ) Horizontal alignment of table cell content.
setHAlign ImageColumnControl.setHAlign( hAlign ) Sets the horizontal alignment of table cell content.
getVAlign ImageColumnControl.getVAlign( ) Vertical alignment of table cell content.
setVAlign ImageColumnControl.setVAlign( vAlign ) Sets the vertical alignment of table cell content.
getWidth ImageColumnControl.getWidth( ) Width of the table column.
setWidth ImageColumnControl.setWidth( width ) Sets the width of the table column.

BackgroundStyleProperties Functions

getBackgroundColor ImageColumnControl.getBackgroundColor( ) Background color.
setBackgroundColor ImageColumnControl.setBackgroundColor( backgroundColor ) Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used.
getBackgroundImage ImageColumnControl.getBackgroundImage( ) URL of the background image.
setBackgroundImage ImageColumnControl.setBackgroundImage( backgroundImage ) Sets the URL of the background image.
getBackgroundImagePosition ImageColumnControl.getBackgroundImagePosition( ) Background image position.
setBackgroundImagePosition ImageColumnControl.setBackgroundImagePosition( backgroundImagePosition ) Sets the background image position.
getBackgroundImageRepeat ImageColumnControl.getBackgroundImageRepeat( ) Background image repeat property.
setBackgroundImageRepeat ImageColumnControl.setBackgroundImageRepeat( backgroundImageRepeat ) Sets the background image repeat property.

BorderStyleProperties Functions

getBorderColor ImageColumnControl.getBorderColor( ) Border color applied to all borders.
setBorderColor ImageColumnControl.setBorderColor( borderColor ) Sets border color.
getBorderRadius ImageColumnControl.getBorderRadius( ) Border radius.
setBorderRadius ImageColumnControl.setBorderRadius( borderRadius ) Sets border radius.
getBorderStyle ImageColumnControl.getBorderStyle( ) Border style applied to all borders.
setBorderStyle ImageColumnControl.setBorderStyle( borderStyle ) Sets border style.
getBorderWidth ImageColumnControl.getBorderWidth( ) Border width applied to all four borders.
setBorderWidth ImageColumnControl.setBorderWidth( borderWidth ) Sets the border width applied to all four borders.
getBottomBorderWidth ImageColumnControl.getBottomBorderWidth( ) Bottom border width, overriding property borderWidth.
setBottomBorderWidth ImageColumnControl.setBottomBorderWidth( bottomBorderWidth ) Sets the bottom border width, overriding property borderWidth.
getLeftBorderWidth ImageColumnControl.getLeftBorderWidth( ) Left border width, overriding property borderWidth.
setLeftBorderWidth ImageColumnControl.setLeftBorderWidth( leftBorderWidth ) Sets the left border width, overriding property borderWidth.
getRightBorderWidth ImageColumnControl.getRightBorderWidth( ) Right border width, overriding property borderWidth.
setRightBorderWidth ImageColumnControl.setRightBorderWidth( rightBorderWidth ) Sets the right border width, overriding property borderWidth.
getTopBorderWidth ImageColumnControl.getTopBorderWidth( ) Top border width, overriding property borderWidth.
setTopBorderWidth ImageColumnControl.setTopBorderWidth( topBorderWidth ) Sets the top border width, overriding property borderWidth.

PaddingStyleProperties Functions

getAllPadding ImageColumnControl.getAllPadding( ) Single PaddingStyleProperties size value used for top, bottom, left and right padding.
setAllPadding ImageColumnControl.setAllPadding( allPadding ) Sets the PaddingStyleProperties size value used for top, bottom, left and right padding.
getBottomPadding ImageColumnControl.getBottomPadding( ) Bottom PaddingStyleProperties size value.
setBottomPadding ImageColumnControl.setBottomPadding( bottomPadding ) Sets the bottom PaddingStyleProperties size value.
getLeftPadding ImageColumnControl.getLeftPadding( ) Left PaddingStyleProperties size value.
setLeftPadding ImageColumnControl.setLeftPadding( leftPadding ) Sets the left PaddingStyleProperties size value.
getRightPadding ImageColumnControl.getRightPadding( ) Right PaddingStyleProperties size value.
setRightPadding ImageColumnControl.setRightPadding( rightPadding ) Sets the right PaddingStyleProperties size value.
getTopPadding ImageColumnControl.getTopPadding( ) Top PaddingStyleProperties size value.
setTopPadding ImageColumnControl.setTopPadding( topPadding ) Sets the top PaddingStyleProperties size value.

TextStyleProperties Functions

getLineHeight ImageColumnControl.getLineHeight( ) Line height.
setLineHeight ImageColumnControl.setLineHeight( lineHeight ) Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used.
getTextBold ImageColumnControl.getTextBold( ) Text bold setting.
setTextBold ImageColumnControl.setTextBold( textBold ) Sets the text bold setting.
getTextColor ImageColumnControl.getTextColor( ) Text color.
setTextColor ImageColumnControl.setTextColor( textColor ) Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used.
getTextDecoration ImageColumnControl.getTextDecoration( ) Text decoration property (shown as Lines in the designer).
setTextDecoration ImageColumnControl.setTextDecoration( textDecoration ) Sets the text decoration property (shown as Lines in the designer).
getTextFont ImageColumnControl.getTextFont( ) List of text fonts.
setTextFont ImageColumnControl.setTextFont( textFont ) Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used.
getTextItalic ImageColumnControl.getTextItalic( ) Text italic setting.
setTextItalic ImageColumnControl.setTextItalic( textItalic ) Sets the text italic setting.
getTextSize ImageColumnControl.getTextSize( ) Text size.
setTextSize ImageColumnControl.setTextSize( textSize ) Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used.

MessageContainer Functions

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

Element Functions

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