org.gwtbootstrap3.extras.select.client.ui

Class Option

Object

UIObject

Widget

AbstractTextWidget

Option

All Implemented Interfaces:

IsEditor<LeafValueEditor<String>>, HasAttachHandlers, HasHandlers, EventListener, TakesValue<String>, HasEnabled, HasHTML, HasName, HasText, HasVisibility, IsWidget, HasId, HasInlineStyle, HasPull, HasResponsiveness

public class Option
extends AbstractTextWidget
implements HasName, TakesValue<String>, HasEnabled

Select option widget.

Author:

Xiaodong Sun

Nested Class Summary

Nested classes/interfaces inherited from class UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Option()

Method Summary

Modifier and Type	Method and Description
String	getContent() Returns the custom HTML content; may be null.
IconType	getIcon() Returns the icon of the option; may be null.
String	getName()
OptionElement	getSelectElement() Returns the OptionElement.
String	getSubtext() Returns the sub-text of the option.
String	getTokens() Returns the search key words.
String	getValue() Returns the value of the option.
boolean	isDivider() Returns true if the option is a divider.
boolean	isEnabled()
boolean	isHidden() Returns true if the option is hidden.
boolean	isSelected() Returns true if the option is selected.
void	setContent(String content) Inserts custom HTML into the option.
void	setDivider(boolean divider) Turns the option into a divider.
void	setEnabled(boolean enabled)
void	setHidden(boolean hidden) Hides the option if set to true. Defaults to false.
void	setIcon(IconType iconType) Add an icon to the option.
void	setName(String name)
void	setSelected(boolean selected) Selects/deselects the option.
void	setSubtext(String subtext) Set the specified sub-text to the option.
void	setTokens(String tokens) Adds key words to improve the searchability.
void	setValue(String value)

Methods inherited from class AbstractTextWidget

asEditor, getHTML, getId, getPull, getText, setColor, setHiddenOn, setHTML, setId, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPull, setText, setVisibleOn

Methods inherited from class Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Option

public Option()

Method Detail

getSelectElement

public OptionElement getSelectElement()

Returns the OptionElement.

Returns:

the OptionElement.

isSelected

public boolean isSelected()

Returns true if the option is selected.

Returns:

true if the option is selected

setSelected

public void setSelected(boolean selected)

Selects/deselects the option.

Parameters:

selected -

setName

public void setName(String name)

Specified by:

setName in interface HasName

getName

public String getName()

Specified by:

getName in interface HasName

setValue

public void setValue(String value)

Specified by:

setValue in interface TakesValue<String>

getValue

public String getValue()

Returns the value of the option. If no value, fall-back to the displayed option text.

Specified by:

getValue in interface TakesValue<String>

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface HasEnabled

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface HasEnabled

setTokens

public void setTokens(String tokens)

Adds key words to improve the searchability.

Parameters:

tokens -

getTokens

public String getTokens()

Returns the search key words.

Returns:

setDivider

public void setDivider(boolean divider)

Turns the option into a divider.

Parameters:

divider -

isDivider

public boolean isDivider()

Returns true if the option is a divider.

Returns:

true if the option is a divider

setSubtext

public void setSubtext(String subtext)

Set the specified sub-text to the option.

Parameters:

subtext -

getSubtext

public String getSubtext()

Returns the sub-text of the option.

Returns:

setIcon

public void setIcon(IconType iconType)

Add an icon to the option.

Parameters:

iconType -

getIcon

public IconType getIcon()

Returns the icon of the option; may be null.

Returns:

setContent

public void setContent(String content)

Inserts custom HTML into the option.

Parameters:

content -

getContent

public String getContent()

Returns the custom HTML content; may be null.

Returns:

the custom HTML content

setHidden

public void setHidden(boolean hidden)

Hides the option if set to true.

Defaults to false.

Parameters:

hidden -

isHidden

public boolean isHidden()

Returns true if the option is hidden.

Returns:

true if the option is hidden