FieldColumnControl

FieldColumnControl Functions

getCalendarProperties	FieldColumnControl.getCalendarProperties( )	Image properties for the calendar icon of date fields.
getEditorInputBackgroundProperties	FieldColumnControl.getEditorInputBackgroundProperties( )	Background properties for the data content of each table cell.
getEditorInputBorderProperties	FieldColumnControl.getEditorInputBorderProperties( )	Border properties for the data content of each table cell.
getEditorInputTextProperties	FieldColumnControl.getEditorInputTextProperties( )	Text properties for the data content of each table cell.
isSortable	FieldColumnControl.isSortable( )	Indicates whether or not the user can sort the table by this column.
setSortable	FieldColumnControl.setSortable( sortable )	Sets whether or not the user can sort the table by this column.
getStripeCalendarProperties	FieldColumnControl.getStripeCalendarProperties( )	Image properties for the calendar icon of date fields - applied to alternate (striped) rows.
getStripeEditorInputBackgroundProperties	FieldColumnControl.getStripeEditorInputBackgroundProperties( )	Background properties for the data content of each table cell - applied to alternate (striped) rows.
getStripeEditorInputBorderProperties	FieldColumnControl.getStripeEditorInputBorderProperties( )	Border properties for the data content of each table cell - applied to alternate (striped) rows.
getStripeEditorInputTextProperties	FieldColumnControl.getStripeEditorInputTextProperties( )	Text properties for the data content of each table cell - applied to alternate (striped) rows.
getTableColumn	FieldColumnControl.getTableColumn( )	Returns the com.ebasetech.xi.api.WebFormTableColumn displayed by this Table Column Control.
getValuePatternProperties	FieldColumnControl.getValuePatternProperties( )	Value pattern properties.

ColumnStyleProperties Functions

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

Control Functions

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

FieldControlProperties Functions

addAriaCustomAttribute	FieldColumnControl.addAriaCustomAttribute( name , value )	Add an ARIA custom attribute with a specified name and value.
getAriaCustomAttributes	FieldColumnControl.getAriaCustomAttributes( )	Returns the ARIA custom attributes for the control.
setAriaCustomAttributes	FieldColumnControl.setAriaCustomAttributes( ariaCustomAttributes )	Sets the ARIA custom attributes associated with the control property and overrides the aria custom attributes value.
getAriaDescribedBy	FieldColumnControl.getAriaDescribedBy( )	Returns the ARIA described-by element ID for the control.
getAriaLabelledBy	FieldColumnControl.getAriaLabelledBy( )	Returns the ARIA labelled-by element ID for the control.
getAriaLabelText	FieldColumnControl.getAriaLabelText( )	Returns the com.ebasetech.xi.api.Text object for the aria label text.
isAriaRequired	FieldColumnControl.isAriaRequired( )	Indicates whether or not this is an aria required field.
setAriaRequired	FieldColumnControl.setAriaRequired( ariaRequired )	Sets whether or not this the aria-required attribute is set to true.
isButtonDisplayAsImage	FieldColumnControl.isButtonDisplayAsImage( )	Indicates whether or not the image specified in the buttonImageUrl property is displayed instead of a button.
setButtonDisplayAsImage	FieldColumnControl.setButtonDisplayAsImage( buttonDisplayAsImage )	Sets whether or not the image specified in the buttonImageUrl property is displayed instead of a button.
getButtonImageUrl	FieldColumnControl.getButtonImageUrl( )	Returns the URL of the image to be displayed when the buttonDisplayAsImage is set to true.
setButtonImageUrl	FieldColumnControl.setButtonImageUrl( buttonImageUrl )	Sets the URL of the image to be displayed when the buttonDisplayAsImage is set to true.
isButtonSkipValidation	FieldColumnControl.isButtonSkipValidation( )	Returns whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.
setButtonSkipValidation	FieldColumnControl.setButtonSkipValidation( buttonSkipValidation )	Specifies whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.
getButtonText	FieldColumnControl.getButtonText( )	Returns the com.ebasetech.xi.api.Text object for the button text.
isDisabled	FieldColumnControl.isDisabled( )	Returns true if the field is marked as disabled, otherwise returns false.
setDisabled	FieldColumnControl.setDisabled( disabled )	Disables the field and results in the HTML disabled attribute being added to the <input> HTML tag.
isDisplayIvAsImage	FieldColumnControl.isDisplayIvAsImage( )	Indicates that a button is displayed as an image, and is applicable only when Javascript is disabled and immediate validation is simulated using buttons/images to be clicked by the user.
setDisplayIvAsImage	FieldColumnControl.setDisplayIvAsImage( displayIvAsImage )	Sets whether or not a button is displayed as an image, and is applicable only when Javascript is disabled and immediate validation is simulated using buttons/images to be clicked by the user.
getEditorHtmlElementProperties	FieldColumnControl.getEditorHtmlElementProperties( )	Return the field editor com.ebasetech.xi.api.controls.HtmlElementProperties of the control
isHyperlink	FieldColumnControl.isHyperlink( )	Indicates whether or not the field's value should be displayed as a hyperlink.
setHyperlink	FieldColumnControl.setHyperlink( hyperlink )	Sets whether or not the field's value should be displayed as a hyperlink.
getHyperlinkProperties	FieldColumnControl.getHyperlinkProperties( )	Hyperlink properties that apply when the field value should be displayed as a hyperlink (property hyperlink is set to true).
isImmediateValidation	FieldColumnControl.isImmediateValidation( )	Indicates whether or not control should pass immediately to the Ebase Server when the user changes the field's value.
setImmediateValidation	FieldColumnControl.setImmediateValidation( immediateValidation )	Sets whether or not control should pass immediately to the Ebase Server when the user changes the field's value.
getIvImageURL	FieldColumnControl.getIvImageURL( )	Returns the URL of the image to be displayed when Javascript is disabled and immediate validation is simulated using an image to be clicked by the user (displayIvAsImage is set to true).
setIvImageURL	FieldColumnControl.setIvImageURL( url )	Sets the URL of the image to be displayed when Javascript is disabled and immediate validation is simulated using an image to be clicked by the user (property displayIvAsImage is set to true).
isMandatory	FieldColumnControl.isMandatory( )
setMandatory	FieldColumnControl.setMandatory( mandatory )
getPlaceHolderText	FieldColumnControl.getPlaceHolderText( )	Returns the com.ebasetech.xi.api.Text object for the place holder text.
removeAriaCustomAttribute	FieldColumnControl.removeAriaCustomAttribute( name )	Remove an ARIA custom attribute specified by name.
isRequired	FieldColumnControl.isRequired( )	Indicates whether or not this is a required field.
setRequired	FieldColumnControl.setRequired( required )	Sets whether or not this is a required field.
getRequiredText	FieldColumnControl.getRequiredText( )	Returns the required message com.ebasetech.xi.api.Text displayed when the field is missing.
getValidationText	FieldColumnControl.getValidationText( )	Returns the HTML5 validation message com.ebasetech.xi.api.Text.

MessageProperties Functions

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

CellStyleProperties Functions

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

BackgroundStyleProperties Functions

getBackgroundColor	FieldColumnControl.getBackgroundColor( )	Background color.
setBackgroundColor	FieldColumnControl.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	FieldColumnControl.getBackgroundImage( )	URL of the background image.
setBackgroundImage	FieldColumnControl.setBackgroundImage( backgroundImage )	Sets the URL of the background image.
getBackgroundImagePosition	FieldColumnControl.getBackgroundImagePosition( )	Background image position.
setBackgroundImagePosition	FieldColumnControl.setBackgroundImagePosition( backgroundImagePosition )	Sets the background image position.
getBackgroundImageRepeat	FieldColumnControl.getBackgroundImageRepeat( )	Background image repeat property.
setBackgroundImageRepeat	FieldColumnControl.setBackgroundImageRepeat( backgroundImageRepeat )	Sets the background image repeat property.

BorderStyleProperties Functions

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

PaddingStyleProperties Functions

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

TextStyleProperties Functions

getLineHeight	FieldColumnControl.getLineHeight( )	Line height.
setLineHeight	FieldColumnControl.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	FieldColumnControl.getTextBold( )	Text bold setting.
setTextBold	FieldColumnControl.setTextBold( textBold )	Sets the text bold setting.
getTextColor	FieldColumnControl.getTextColor( )	Text color.
setTextColor	FieldColumnControl.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	FieldColumnControl.getTextDecoration( )	Text decoration property (shown as Lines in the designer).
setTextDecoration	FieldColumnControl.setTextDecoration( textDecoration )	Sets the text decoration property (shown as Lines in the designer).
getTextFont	FieldColumnControl.getTextFont( )	List of text fonts.
setTextFont	FieldColumnControl.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	FieldColumnControl.getTextItalic( )	Text italic setting.
setTextItalic	FieldColumnControl.setTextItalic( textItalic )	Sets the text italic setting.
getTextSize	FieldColumnControl.getTextSize( )	Text size.
setTextSize	FieldColumnControl.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	FieldColumnControl.addErrorMessage( message [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessage	FieldColumnControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessageText	FieldColumnControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage	FieldColumnControl.addInfoMessage( message [, stopProcessing ] )	Adds an information message that will be displayed to the user.
addInfoMessageText	FieldColumnControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage	FieldColumnControl.addWarningMessage( message [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessage	FieldColumnControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessageText	FieldColumnControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages	FieldColumnControl.existErrorMessages( )	Returns true if undisplayed error messages exist for this element, otherwise returns false.
existInfoMessages	FieldColumnControl.existInfoMessages( )	Returns true if undisplayed info messages exist for this element, otherwise returns false.
existMessages	FieldColumnControl.existMessages( )	Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false.
existWarningMessages	FieldColumnControl.existWarningMessages( )	Returns true if undisplayed warning messages exist for this element, otherwise returns false.

Element Functions

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