Package com.ebasetech.xi.api.controls

Interface FieldColumnControl

All Superinterfaces:

BackgroundStyleProperties, BorderStyleProperties, CellStyleProperties, ColumnStyleProperties, Control, Element, EventOwner, FieldControlProperties, MessageContainer, MessageProperties, PaddingStyleProperties, java.io.Serializable, TextStyleProperties, WebFormEventOwner

public interface FieldColumnControl
extends Control, FieldControlProperties, ColumnStyleProperties, MessageProperties

Field Column Control

Further documentation.

Method Summary

Modifier and Type	Method	Description
ImageStyleProperties	getCalendarProperties()	Image properties for the calendar icon of date fields.
BackgroundStyleProperties	getEditorInputBackgroundProperties()	Background properties for the data content of each table cell.
BorderStyleProperties	getEditorInputBorderProperties()	Border properties for the data content of each table cell.
TextStyleProperties	getEditorInputTextProperties()	Text properties for the data content of each table cell.
ImageStyleProperties	getStripeCalendarProperties()	Image properties for the calendar icon of date fields - applied to alternate (striped) rows.
BackgroundStyleProperties	getStripeEditorInputBackgroundProperties()	Background properties for the data content of each table cell - applied to alternate (striped) rows.
BorderStyleProperties	getStripeEditorInputBorderProperties()	Border properties for the data content of each table cell - applied to alternate (striped) rows.
TextStyleProperties	getStripeEditorInputTextProperties()	Text properties for the data content of each table cell - applied to alternate (striped) rows.
WebFormTableColumn	getTableColumn()	Returns the table column displayed by this Table Column Control.
TextStyleProperties	getValuePatternProperties()	Value pattern properties.
boolean	isSortable()	Indicates whether or not the user can sort the table by this column.
void	setSortable(boolean sortable)	Sets whether or not the user can sort the table by this column.

Methods inherited from interface com.ebasetech.xi.api.controls.BackgroundStyleProperties

getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeat

Methods inherited from interface com.ebasetech.xi.api.controls.BorderStyleProperties

getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth

Methods inherited from interface com.ebasetech.xi.api.controls.CellStyleProperties

getHAlign, getVAlign, getWidth, setHAlign, setVAlign, setWidth

Methods inherited from interface com.ebasetech.xi.api.controls.ColumnStyleProperties

getColumnCellClass, getColumnCellStyle, getColumnDataClass, getColumnDataStyle, getColumnHeaderProperties, getStripeProperties, setColumnCellClass, setColumnCellStyle, setColumnDataClass, setColumnDataStyle

Methods inherited from interface com.ebasetech.xi.api.controls.Control

addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getRootHtmlElementProperties, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Methods inherited from interface com.ebasetech.xi.api.controls.FieldControlProperties

addAriaCustomAttribute, getAriaCustomAttributes, getAriaDescribedBy, getAriaLabelledBy, getAriaLabelText, getButtonImageUrl, getButtonText, getEditorHtmlElementProperties, getHyperlinkProperties, getIvImageURL, getPlaceHolderText, getRequiredText, getValidationText, isAriaRequired, isButtonDisplayAsImage, isButtonSkipValidation, isDisabled, isDisplayIvAsImage, isHyperlink, isImmediateValidation, isMandatory, isRequired, removeAriaCustomAttribute, setAriaCustomAttributes, setAriaRequired, setButtonDisplayAsImage, setButtonImageUrl, setButtonSkipValidation, setDisabled, setDisplayIvAsImage, setHyperlink, setImmediateValidation, setIvImageURL, setMandatory, setRequired

Methods inherited from interface com.ebasetech.xi.api.MessageContainer

addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages

Methods inherited from interface com.ebasetech.xi.api.controls.MessageProperties

getErrorMessageStyle, getInfoMessageStyle, getWarningMessageStyle

Methods inherited from interface com.ebasetech.xi.api.controls.PaddingStyleProperties

getAllPadding, getBottomPadding, getLeftPadding, getRightPadding, getTopPadding, setAllPadding, setBottomPadding, setLeftPadding, setRightPadding, setTopPadding

Methods inherited from interface com.ebasetech.xi.api.controls.TextStyleProperties

getLineHeight, getTextBold, getTextColor, getTextDecoration, getTextFont, getTextItalic, getTextSize, setLineHeight, setTextBold, setTextColor, setTextDecoration, setTextFont, setTextItalic, setTextSize

Method Details

getEditorInputBackgroundProperties

BackgroundStyleProperties getEditorInputBackgroundProperties()

Background properties for the data content of each table cell.

Since:

V4.4

getStripeEditorInputBackgroundProperties

BackgroundStyleProperties getStripeEditorInputBackgroundProperties()

Background properties for the data content of each table cell - applied to alternate (striped) rows. These properties override getEditorInputBackgroundProperties() properties.

Since:

V4.4

getEditorInputBorderProperties

BorderStyleProperties getEditorInputBorderProperties()

Border properties for the data content of each table cell.

Since:

V4.4

getStripeEditorInputBorderProperties

BorderStyleProperties getStripeEditorInputBorderProperties()

Border properties for the data content of each table cell - applied to alternate (striped) rows. These properties override getEditorInputBorderProperties() properties.

Since:

V4.4

getEditorInputTextProperties

TextStyleProperties getEditorInputTextProperties()

Text properties for the data content of each table cell.

Since:

V4.4

getStripeEditorInputTextProperties

TextStyleProperties getStripeEditorInputTextProperties()

Text properties for the data content of each table cell - applied to alternate (striped) rows. These properties override getEditorInputTextProperties() properties.

Since:

V4.4

getCalendarProperties

ImageStyleProperties getCalendarProperties()

Image properties for the calendar icon of date fields.

Since:

V4.4

getStripeCalendarProperties

ImageStyleProperties getStripeCalendarProperties()

Image properties for the calendar icon of date fields - applied to alternate (striped) rows. These properties override getCalendarProperties() properties.

Since:

V4.4

getValuePatternProperties

TextStyleProperties getValuePatternProperties()

Value pattern properties.

Since:

V4.4

isSortable

boolean isSortable()

Indicates whether or not the user can sort the table by this column. Sort icons are displayed next to the column header text when a column is sortable.

Further documentation.

Since:

V4.4

setSortable

void setSortable(boolean sortable)

Sets whether or not the user can sort the table by this column. Sort icons are displayed next to the column header text when a column is sortable.

Further documentation.

Since:

V4.4

getTableColumn

WebFormTableColumn getTableColumn()

Returns the table column displayed by this Table Column Control.

Since:

V4.4