Package com.ebasetech.xi.api.controls

Interface EbaseButtonControlProperties

All Superinterfaces:

BackgroundStyleProperties, BorderStyleProperties, Control, Element, EventOwner, MarginStyleProperties, MessageContainer, PaddingStyleProperties, java.io.Serializable, TextStyleProperties, WebFormEventOwner

All Known Subinterfaces:

FinishButtonControl, NextPageButtonControl, PrevPageButtonControl, RestoreButtonControl, SaveButtonControl

public interface EbaseButtonControlProperties
extends Control, BackgroundStyleProperties, TextStyleProperties, PaddingStyleProperties, MarginStyleProperties, BorderStyleProperties

The EbaseButtonControlProperties interface represents common properties for all Ebase navigation buttons.

Further documentation.

Since:

V4.4

Method Summary

Modifier and Type	Method	Description
java.lang.String	getImageUrl()	Returns the URL of the image when property displayAsImage is true.
boolean	isDisplayAsImage()	Indicates whether or not the button is displayed as an image.
void	setDisplayAsImage(boolean displayAsImage)	Sets whether or not the button is displayed as an image.
void	setImageUrl(java.lang.String imageUrl)	Sets the URL of the image when property displayAsImage is true.

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

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

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

isDisplayAsImage

boolean isDisplayAsImage()

Indicates whether or not the button is displayed as an image. The image URL can be configured using the imageUrl property.

Since:

V4.4

setDisplayAsImage

void setDisplayAsImage(boolean displayAsImage)

Sets whether or not the button is displayed as an image. The image URL can be configured using the setImageUrl(String) method.

Since:

V4.4

getImageUrl

java.lang.String getImageUrl()

Returns the URL of the image when property displayAsImage is true. The URL can be either relative or absolute.

Further documentation.

Since:

V4.4

setImageUrl

void setImageUrl(java.lang.String imageUrl)

Sets the URL of the image when property displayAsImage is true. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g. http://www.google.com.

Further documentation.

Since:

V4.4