public interface SelectableIconHolder

ExtendsIconHolder

Known subtypesFloatingActionButton, MultiButton, ScaleImageButton, ShareButton, SpanButton, SpanMultiButton, LikeButton, Button, CheckBox, RadioButton, Picker

An interface that is implemented by “selectable” components that hold icons, such as Button, SpanButton, MultiButton, etc… This interface includes methods for managing different icons for different component states (e.g. pressed, disabled, etc..).

Methods

public abstract Image getRolloverIcon()Indicates the icon that is displayed on the button when the button is in rolled over state
public abstract void setRolloverIcon(Image rolloverIcon)Indicates the icon that is displayed on the button when the button is in rolled over state
public abstract Image getPressedIcon()Indicates the icon that is displayed on the button when the button is in pressed state
public abstract void setPressedIcon(Image pressedIcon)Indicates the icon that is displayed on the button when the button is in pressed state
public abstract Image getDisabledIcon()Indicates the icon that is displayed on the button when the button is in the disabled state
public abstract void setDisabledIcon(Image disabledIcon)Indicates the icon that is displayed on the button when the button is in the disabled state
public abstract Image getRolloverPressedIcon()Indicates the icon that is displayed on the button when the button is in pressed state and is selected.
public abstract void setRolloverPressedIcon(Image rolloverPressedIcon)Indicates the icon that is displayed on the button when the button is in pressed state and is selected.
public abstract Image getIconFromState()Returns the icon for the button based on its current state

Inherited methods

From IconHolder

getIcon, setIcon, getGap, setGap, getTextPosition, setTextPosition, getIconUIID, setIconUIID, getIconStyleComponent, setMaterialIcon, setFontIcon

Method details

getRolloverIcon

public abstract Image getRolloverIcon()
Indicates the icon that is displayed on the button when the button is in rolled over state

Returns

icon used

See also

setRolloverIcon

public abstract void setRolloverIcon(Image rolloverIcon)
Indicates the icon that is displayed on the button when the button is in rolled over state

Parameters

rolloverIcon Image
icon to use

See also

getPressedIcon

public abstract Image getPressedIcon()
Indicates the icon that is displayed on the button when the button is in pressed state

Returns

icon used

See also

setPressedIcon

public abstract void setPressedIcon(Image pressedIcon)
Indicates the icon that is displayed on the button when the button is in pressed state

Parameters

pressedIcon Image
icon used

See also

getDisabledIcon

public abstract Image getDisabledIcon()
Indicates the icon that is displayed on the button when the button is in the disabled state

Returns

icon used

setDisabledIcon

public abstract void setDisabledIcon(Image disabledIcon)
Indicates the icon that is displayed on the button when the button is in the disabled state

Parameters

disabledIcon Image
icon used

getRolloverPressedIcon

public abstract Image getRolloverPressedIcon()
Indicates the icon that is displayed on the button when the button is in pressed state and is selected. This is ONLY applicable to toggle buttons

Returns

icon used

setRolloverPressedIcon

public abstract void setRolloverPressedIcon(Image rolloverPressedIcon)
Indicates the icon that is displayed on the button when the button is in pressed state and is selected. This is ONLY applicable to toggle buttons

Parameters

rolloverPressedIcon Image
icon used

getIconFromState

public abstract Image getIconFromState()
Returns the icon for the button based on its current state

Returns

the button icon based on its current state