Package com.vaadin.v7.ui
Class OptionGroup
-
- All Implemented Interfaces:
Action.ShortcutNotifier
,ConnectorEventListener
,ContextClickEvent.ContextClickNotifier
,MethodEventSource
,SerializableEventListener
,ClientConnector
,Sizeable
,VariableOwner
,com.vaadin.shared.Connector
,Component
,Component.Focusable
,LegacyComponent
,Buffered
,BufferedValidatable
,Container
,Container.ItemSetChangeListener
,Container.ItemSetChangeNotifier
,Container.PropertySetChangeListener
,Container.PropertySetChangeNotifier
,Container.Viewer
,Property<Object>
,Property.Editor
,Property.ReadOnlyStatusChangeListener
,Property.ReadOnlyStatusChangeNotifier
,Property.ValueChangeListener
,Property.ValueChangeNotifier
,Property.Viewer
,Validatable
,FieldEvents.BlurNotifier
,FieldEvents.FocusNotifier
,Field<Object>
,Serializable
,EventListener
@Deprecated public class OptionGroup extends AbstractSelect implements FieldEvents.BlurNotifier, FieldEvents.FocusNotifier
Deprecated.As of 8.0, useRadioButtonGroup
for single select orCheckBoxGroup
for multiselect insteadConfigures select to be used as an option group.- Author:
- Vaadin Ltd
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractSelect
AbstractSelect.AbstractSelectTargetDetails, AbstractSelect.AcceptItem, AbstractSelect.CaptionChangeListener, AbstractSelect.DefaultNewItemHandler, AbstractSelect.Filtering, AbstractSelect.ItemCaptionMode, AbstractSelect.ItemDescriptionGenerator, AbstractSelect.NewItemHandler, AbstractSelect.TargetItemIs, AbstractSelect.VerticalLocationIs
-
Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractField
AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent
-
Nested classes/interfaces inherited from interface com.vaadin.v7.data.Buffered
Buffered.SourceException
-
Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener
-
Nested classes/interfaces inherited from interface com.vaadin.ui.Component
Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener
-
Nested classes/interfaces inherited from interface com.vaadin.v7.data.Container
Container.Editor, Container.Filter, Container.Filterable, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.SimpleFilterable, Container.Sortable, Container.Viewer
-
Nested classes/interfaces inherited from interface com.vaadin.v7.ui.Field
Field.ValueChangeEvent
-
Nested classes/interfaces inherited from interface com.vaadin.v7.data.Property
Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer
-
Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable
Sizeable.Unit
-
-
Field Summary
-
Fields inherited from class com.vaadin.v7.ui.AbstractSelect
ITEM_CAPTION_MODE_EXPLICIT, ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID, ITEM_CAPTION_MODE_ICON_ONLY, ITEM_CAPTION_MODE_ID, ITEM_CAPTION_MODE_INDEX, ITEM_CAPTION_MODE_ITEM, ITEM_CAPTION_MODE_PROPERTY, itemIdMapper, items
-
Fields inherited from class com.vaadin.ui.AbstractComponent
DESIGN_ATTR_PLAIN_TEXT
-
Fields inherited from interface com.vaadin.server.Sizeable
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS
-
-
Constructor Summary
Constructors Constructor Description OptionGroup()
Deprecated.OptionGroup(String caption)
Deprecated.OptionGroup(String caption, Container dataSource)
Deprecated.OptionGroup(String caption, Collection<?> options)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addBlurListener(FieldEvents.BlurListener listener)
Deprecated.Adds aBlurListener
to the Component which gets fired when aField
loses keyboard focus.void
addFocusListener(FieldEvents.FocusListener listener)
Deprecated.Adds aFocusListener
to the Component which gets fired when aField
receives keyboard focus.void
changeVariables(Object source, Map<String,Object> variables)
Deprecated.protected OptionGroupState
getState()
Deprecated.protected OptionGroupState
getState(boolean markAsDirty)
Deprecated.boolean
isHtmlContentAllowed()
Deprecated.Checks whether captions are interpreted as html or plain text.boolean
isItemEnabled(Object itemId)
Deprecated.Returns true if the item is enabled.void
paintContent(PaintTarget target)
Deprecated.Paints the content of this component.protected void
paintItem(PaintTarget target, Object itemId)
Deprecated.protected Object
readItem(org.jsoup.nodes.Element child, Set<String> selected, DesignContext context)
Deprecated.Reads an Item from a design and inserts it into the data source.void
removeBlurListener(FieldEvents.BlurListener listener)
Deprecated.Removes aBlurListener
from the Component.void
removeFocusListener(FieldEvents.FocusListener listener)
Deprecated.Removes aFocusListener
from the Component.void
setHtmlContentAllowed(boolean htmlContentAllowed)
Deprecated.Sets whether html is allowed in the item captions.void
setItemEnabled(Object itemId, boolean enabled)
Deprecated.Sets an item disabled or enabled.protected void
setValue(Object newValue, boolean repaintIsNotNeeded)
Deprecated.Sets the value of the field.protected org.jsoup.nodes.Element
writeItem(org.jsoup.nodes.Element design, Object itemId, DesignContext context)
Deprecated.Writes a data source Item to a design.-
Methods inherited from class com.vaadin.v7.ui.AbstractSelect
addContainerProperty, addItem, addItem, addItems, addItems, addItemSetChangeListener, addListener, addListener, addPropertySetChangeListener, attach, containerItemSetChange, containerPropertySetChange, containsId, detach, fireItemSetChange, firePropertySetChange, getCaptionChangeListener, getContainerDataSource, getContainerProperty, getContainerPropertyIds, getItem, getItemCaption, getItemCaptionMode, getItemCaptionPropertyId, getItemIcon, getItemIconPropertyId, getItemIds, getListeners, getNewItemHandler, getNullSelectionItemId, getType, getType, getValue, getVisibleItemIds, isEmpty, isMultiSelect, isNewItemsAllowed, isNullSelectionAllowed, isSelected, readDesign, readItems, removeAllItems, removeContainerProperty, removeItem, removeItemSetChangeListener, removeListener, removeListener, removePropertySetChangeListener, sanitizeSelection, select, setContainerDataSource, setItemCaption, setItemCaptionMode, setItemCaptionPropertyId, setItemIcon, setItemIconPropertyId, setMultiSelect, setNewItemHandler, setNewItemsAllowed, setNullSelectionAllowed, setNullSelectionItemId, setValue, setValue, size, unselect, writeDesign, writeItems
-
Methods inherited from class com.vaadin.v7.ui.AbstractField
addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, beforeClientResponse, clear, commit, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, isBuffered, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, shouldHideErrors, validate, validate, valueChange
-
Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent
getExplicitImmediateValue, isImmediate, setImmediate
-
Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined
-
Methods inherited from class com.vaadin.server.AbstractClientConnector
addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier
addShortcutListener, removeShortcutListener
-
Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, beforeClientResponse, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler
-
Methods inherited from interface com.vaadin.ui.Component
addListener, addStyleName, addStyleNames, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible
-
Methods inherited from interface com.vaadin.ui.LegacyComponent
markAsDirty
-
Methods inherited from interface com.vaadin.server.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined
-
Methods inherited from interface com.vaadin.server.VariableOwner
isEnabled
-
-
-
-
Constructor Detail
-
OptionGroup
public OptionGroup()
Deprecated.
-
OptionGroup
public OptionGroup(String caption, Collection<?> options)
Deprecated.
-
OptionGroup
public OptionGroup(String caption)
Deprecated.
-
-
Method Detail
-
paintContent
public void paintContent(PaintTarget target) throws PaintException
Deprecated.Description copied from class:AbstractSelect
Paints the content of this component.- Specified by:
paintContent
in interfaceLegacyComponent
- Overrides:
paintContent
in classAbstractSelect
- Parameters:
target
- the Paint Event.- Throws:
PaintException
- if the paint operation failed.
-
paintItem
protected void paintItem(PaintTarget target, Object itemId) throws PaintException
Deprecated.- Overrides:
paintItem
in classAbstractSelect
- Throws:
PaintException
-
changeVariables
public void changeVariables(Object source, Map<String,Object> variables)
Deprecated.- Specified by:
changeVariables
in interfaceVariableOwner
- Overrides:
changeVariables
in classAbstractSelect
-
addBlurListener
public void addBlurListener(FieldEvents.BlurListener listener)
Deprecated.Description copied from interface:FieldEvents.BlurNotifier
Adds aBlurListener
to the Component which gets fired when aField
loses keyboard focus.- Specified by:
addBlurListener
in interfaceFieldEvents.BlurNotifier
- See Also:
FieldEvents.BlurListener
-
removeBlurListener
public void removeBlurListener(FieldEvents.BlurListener listener)
Deprecated.Description copied from interface:FieldEvents.BlurNotifier
Removes aBlurListener
from the Component.- Specified by:
removeBlurListener
in interfaceFieldEvents.BlurNotifier
- See Also:
FieldEvents.BlurListener
-
addFocusListener
public void addFocusListener(FieldEvents.FocusListener listener)
Deprecated.Description copied from interface:FieldEvents.FocusNotifier
Adds aFocusListener
to the Component which gets fired when aField
receives keyboard focus.- Specified by:
addFocusListener
in interfaceFieldEvents.FocusNotifier
- See Also:
FieldEvents.FocusListener
-
removeFocusListener
public void removeFocusListener(FieldEvents.FocusListener listener)
Deprecated.Description copied from interface:FieldEvents.FocusNotifier
Removes aFocusListener
from the Component.- Specified by:
removeFocusListener
in interfaceFieldEvents.FocusNotifier
- See Also:
FieldEvents.FocusListener
-
setValue
protected void setValue(Object newValue, boolean repaintIsNotNeeded)
Deprecated.Description copied from class:AbstractField
Sets the value of the field.- Overrides:
setValue
in classAbstractField<Object>
- Parameters:
newValue
- the New value of the field.repaintIsNotNeeded
- True if caller is sure that repaint is not needed.
-
setItemEnabled
public void setItemEnabled(Object itemId, boolean enabled)
Deprecated.Sets an item disabled or enabled. In the multiselect mode, a disabled item cannot be selected or deselected by the user. In the single selection mode, a disable item cannot be selected. However, programmatical selection or deselection of an disable item is possible. By default, items are enabled.- Parameters:
itemId
- the id of the item to be disabled or enabledenabled
- if true the item is enabled, otherwise the item is disabled
-
isItemEnabled
public boolean isItemEnabled(Object itemId)
Deprecated.Returns true if the item is enabled.- Parameters:
itemId
- the id of the item to be checked- Returns:
- true if the item is enabled, false otherwise
- See Also:
setItemEnabled(Object, boolean)
-
setHtmlContentAllowed
public void setHtmlContentAllowed(boolean htmlContentAllowed)
Deprecated.Sets whether html is allowed in the item captions. If set to true, the captions are passed to the browser as html and the developer is responsible for ensuring no harmful html is used. If set to false, the content is passed to the browser as plain text.- Parameters:
htmlContentAllowed
- true if the captions are used as html, false if used as plain text
-
isHtmlContentAllowed
public boolean isHtmlContentAllowed()
Deprecated.Checks whether captions are interpreted as html or plain text.- Returns:
- true if the captions are used as html, false if used as plain text
- See Also:
setHtmlContentAllowed(boolean)
-
readItem
protected Object readItem(org.jsoup.nodes.Element child, Set<String> selected, DesignContext context)
Deprecated.Description copied from class:AbstractSelect
Reads an Item from a design and inserts it into the data source. Hierarchical select components should override this method to recursively recursively read any child items as well.- Overrides:
readItem
in classAbstractSelect
- Parameters:
child
- a child element representing the itemselected
- A set accumulating selected items. If the item that is read is marked as selected, its item id should be added to this set.context
- the DesignContext instance used in parsing- Returns:
- the item id of the new item
-
writeItem
protected org.jsoup.nodes.Element writeItem(org.jsoup.nodes.Element design, Object itemId, DesignContext context)
Deprecated.Description copied from class:AbstractSelect
Writes a data source Item to a design. Hierarchical select components should override this method to recursively write any child items as well.- Overrides:
writeItem
in classAbstractSelect
- Parameters:
design
- the element into which to insert the itemitemId
- the id of the item to writecontext
- the DesignContext instance used in writing- Returns:
-
getState
protected OptionGroupState getState()
Deprecated.- Overrides:
getState
in classAbstractSelect
-
getState
protected OptionGroupState getState(boolean markAsDirty)
Deprecated.- Overrides:
getState
in classAbstractSelect
-
-