org.gwtbootstrap3.extras.select.client.ui

Class OptGroup

Object

UIObject

Widget

Panel

ComplexPanel

ComplexWidget

OptGroup

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasEnabled, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, Iterable<Widget>, HasId, HasInlineStyle, HasPull, HasResponsiveness

public class OptGroup
extends ComplexWidget
implements HasEnabled

Select option group widget.

Author:

Xiaodong Sun

Nested Class Summary

Nested classes/interfaces inherited from class UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface IndexedPanel

IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface HasWidgets

HasWidgets.ForIsWidget

Field Summary

Fields inherited from class UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
OptGroup()

Method Summary

Modifier and Type	Method and Description
void	add(Widget child)
IconType	getIcon() Returns the icon of the option; may be null.
String	getLabel() Returns the label of the option group; may be null.
String	getSubtext() Returns the sub-text of the option.
void	insert(Widget child, int beforeIndex)
boolean	isEnabled()
boolean	remove(Widget w)
void	setEnabled(boolean enabled)
void	setIcon(IconType iconType) Add an icon to the option.
void	setLabel(String label) Set the label of the option group.
void	setMaxOptions(int maxOptions) When set to a positive value and in a multi-select, the number of selected options cannot exceed the given value.
void	setSubtext(String subtext) Set the specified sub-text to the option.

Methods inherited from class ComplexWidget

getId, getPull, insert, setColor, setHiddenOn, setId, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPull, setVisibleOn

Methods inherited from class ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, remove

Methods inherited from class Panel

add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, 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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Detail

OptGroup

public OptGroup()

Method Detail

setLabel

public void setLabel(String label)

Set the label of the option group.

Parameters:

label -

getLabel

public String getLabel()

Returns the label of the option group; may be null.

Returns:

the label of the option group

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface HasEnabled

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface HasEnabled

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:

setMaxOptions

public void setMaxOptions(int maxOptions)

When set to a positive value and in a multi-select, the number of selected options cannot exceed the given value. When set to a strict negative value (less than zero), this options will be deactivated.

Parameters:

maxOptions -

add

public void add(Widget child)

Specified by:

add in interface HasWidgets

Overrides:

add in class ComplexWidget

insert

public void insert(Widget child,
                   int beforeIndex)

Overrides:

insert in class ComplexWidget

remove

public boolean remove(Widget w)

Specified by:

remove in interface HasWidgets

Overrides:

remove in class ComplexWidget