com.vaadin.ui
Class OptionGroup
java.lang.Object
com.vaadin.terminal.AbstractClientConnector
com.vaadin.ui.AbstractComponent
com.vaadin.ui.AbstractField<Object>
com.vaadin.ui.AbstractSelect
com.vaadin.ui.OptionGroup
- All Implemented Interfaces:
- 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, Action.ShortcutNotifier, FieldEvents.BlurNotifier, FieldEvents.FocusNotifier, MethodEventSource, Connector, ClientConnector, RpcTarget, Sizeable, Vaadin6Component, VariableOwner, Component, Component.Focusable, Field<Object>, Serializable, EventListener
public class OptionGroup
- extends AbstractSelect
- implements FieldEvents.BlurNotifier, FieldEvents.FocusNotifier
Configures select to be used as an option group.
- See Also:
- Serialized Form
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractSelect |
AbstractSelect.AbstractSelectTargetDetails, AbstractSelect.AcceptItem, AbstractSelect.CaptionChangeListener, AbstractSelect.DefaultNewItemHandler, AbstractSelect.Filtering, AbstractSelect.ItemCaptionMode, AbstractSelect.ItemDescriptionGenerator, AbstractSelect.MultiSelectMode, AbstractSelect.NewItemHandler, AbstractSelect.TargetItemIs, AbstractSelect.VerticalLocationIs |
Nested classes/interfaces inherited from interface com.vaadin.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 |
Methods inherited from class com.vaadin.ui.AbstractSelect |
addContainerProperty, addItem, addItem, addListener, addListener, 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, removeAllItems, removeContainerProperty, removeItem, removeListener, removeListener, select, setContainerDataSource, setItemCaption, setItemCaptionMode, setItemCaptionPropertyId, setItemIcon, setItemIconPropertyId, setMultiSelect, setNewItemHandler, setNewItemsAllowed, setNullSelectionAllowed, setNullSelectionItemId, setValue, size, unselect |
Methods inherited from class com.vaadin.ui.AbstractField |
addListener, addListener, addValidator, commit, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getErrorMessage, getInternalValue, getPropertyDataSource, getRequiredError, getState, getTabIndex, getValidators, isBuffered, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isReadThrough, isRequired, isValid, isValidationVisible, isWriteThrough, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeValidator, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setPropertyDataSource, setReadOnly, setReadThrough, setRequired, setRequiredError, setTabIndex, setValidationVisible, setWriteThrough, shouldHideErrors, toString, updateState, validate, validate, valueChange |
Methods inherited from class com.vaadin.ui.AbstractComponent |
addListener, addListener, addListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireEvent, getActionManager, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getHeight, getHeightUnits, getIcon, getLocale, getParent, getRoot, getStyle, getStyleName, getWidth, getWidthUnits, handleError, hasListeners, isConnectorEnabled, isEnabled, isImmediate, isVisible, removeListener, removeListener, removeListener, removeListener, removeListener, removeShortcutListener, removeStyleName, requestRepaint, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setHeight, setIcon, setImmediate, setLocale, setParent, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidth |
Methods inherited from class com.vaadin.terminal.AbstractClientConnector |
addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls |
Methods inherited from interface com.vaadin.ui.Component |
addListener, addStyleName, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getState, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible, updateState |
OptionGroup
public OptionGroup()
OptionGroup
public OptionGroup(String caption,
Collection<?> options)
OptionGroup
public OptionGroup(String caption,
Container dataSource)
OptionGroup
public OptionGroup(String caption)
paintContent
public void paintContent(PaintTarget target)
throws PaintException
- Description copied from class:
AbstractSelect
- Paints the content of this component.
- Specified by:
paintContent
in interface Vaadin6Component
- Overrides:
paintContent
in class AbstractSelect
- Parameters:
target
- the Paint Event.
- Throws:
PaintException
- if the paint operation failed.
paintItem
protected void paintItem(PaintTarget target,
Object itemId)
throws PaintException
- Overrides:
paintItem
in class AbstractSelect
- Throws:
PaintException
changeVariables
public void changeVariables(Object source,
Map<String,Object> variables)
- Description copied from class:
AbstractSelect
- Invoked when the value of a variable has changed.
- Specified by:
changeVariables
in interface VariableOwner
- Overrides:
changeVariables
in class AbstractSelect
- Parameters:
source
- the Source of the variable change. This is the origin of the
event. For example in Web Adapter this is the request.variables
- the Mapping from variable names to new variable values.- See Also:
com.vaadin.ui.AbstractComponent#changeVariables(java.lang.Object,
java.util.Map)
addListener
public void addListener(FieldEvents.BlurListener listener)
- Description copied from interface:
FieldEvents.BlurNotifier
- Adds a
BlurListener
to the Component which gets fired
when a Field
loses keyboard focus.
- Specified by:
addListener
in interface FieldEvents.BlurNotifier
- See Also:
FieldEvents.BlurListener
removeListener
public void removeListener(FieldEvents.BlurListener listener)
- Description copied from interface:
FieldEvents.BlurNotifier
- Removes a
BlurListener
from the Component.
- Specified by:
removeListener
in interface FieldEvents.BlurNotifier
- See Also:
FieldEvents.BlurListener
addListener
public void addListener(FieldEvents.FocusListener listener)
- Description copied from interface:
FieldEvents.FocusNotifier
- Adds a
FocusListener
to the Component which gets fired
when a Field
receives keyboard focus.
- Specified by:
addListener
in interface FieldEvents.FocusNotifier
- See Also:
FieldEvents.FocusListener
removeListener
public void removeListener(FieldEvents.FocusListener listener)
- Description copied from interface:
FieldEvents.FocusNotifier
- Removes a
FocusListener
from the Component.
- Specified by:
removeListener
in interface FieldEvents.FocusNotifier
- See Also:
FieldEvents.FocusListener
setValue
protected void setValue(Object newValue,
boolean repaintIsNotNeeded)
- Description copied from class:
AbstractSelect
- Sets the visible value of the property.
The value of the select is the selected item id. If the select is in
multiselect-mode, the value is a set of selected item keys. In
multiselect mode all collections of id:s can be assigned.
- Overrides:
setValue
in class AbstractSelect
- Parameters:
newValue
- the New selected item or collection of selected items.repaintIsNotNeeded
- True if caller is sure that repaint is not needed.- See Also:
com.vaadin.ui.AbstractField#setValue(java.lang.Object,
java.lang.Boolean)
setItemEnabled
public void setItemEnabled(Object itemId,
boolean enabled)
- 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)
- 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)
- 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()
- 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)
Copyright © 2000-2011 Vaadin Ltd. All Rights Reserved.