Package com.ebasetech.xi.api.controls

Interface ButtonControlProperties

All Superinterfaces:

BackgroundStyleProperties, BootstrapButtonStyle, BorderStyleProperties, MarginStyleProperties, PaddingStyleProperties, TextStyleProperties

All Known Subinterfaces:

ButtonColumnControl, ButtonControl, FileUploadControl, InitiateUploadControl

public interface ButtonControlProperties
extends BackgroundStyleProperties, TextStyleProperties, PaddingStyleProperties, MarginStyleProperties, BorderStyleProperties, BootstrapButtonStyle

Method Summary

Modifier and Type	Method	Description
Text	getButtonText()	Returns the Text object for the button text.
Text	getMouseOverText()	Returns the Text object for the mouse over text.
boolean	isDisabled()	Returns true if the button is marked as disabled, otherwise returns false.
boolean	isSkipValidation()	Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.
void	setDisabled(boolean disabled)	Disables the button and results in the HTML disabled attribute being added to the <button> HTML tag.
void	setSkipValidation(boolean skipValidation)	Specifies whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.

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.BootstrapButtonStyle

getBootstrapSize, getBootstrapState, getBootstrapStyle, setBootstrapSize, setBootstrapState, setBootstrapStyle

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.MarginStyleProperties

getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin

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

getButtonText

Text getButtonText()

Returns the Text object for the button text.

Since:

V4.4

getMouseOverText

Text getMouseOverText()

Returns the Text object for the mouse over text.

Since:

V4.4

isSkipValidation

boolean isSkipValidation()

Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.

Note that field type validation is always executed regardless of the setting of this flag (e.g. check that only numeric data is entered for numeric fields).

Further documentation.

Since:

V4.4

setSkipValidation

void setSkipValidation(boolean skipValidation)

Specifies whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.

Note that field type validation is always executed regardless of the setting of this flag (e.g. check that only numeric data is entered for numeric fields).

Further documentation.

Since:

V4.4

isDisabled

boolean isDisabled()

Returns true if the button is marked as disabled, otherwise returns false.

Since:

V5.9

See Also:

setDisabled(boolean)

setDisabled

void setDisabled(boolean disabled)

Disables the button and results in the HTML disabled attribute being added to the <button> HTML tag.

Since:

V5.9