org.dellroad.stuff.vaadin7

Class FieldLayout<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.AbstractOrderedLayout

com.vaadin.ui.HorizontalLayout

org.dellroad.stuff.vaadin7.FieldLayout<T>

Type Parameters:

T - field type

All Implemented Interfaces:

Buffered, BufferedValidatable, Property<T>, Property.Editor, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, ContextClickEvent.ContextClickNotifier, LayoutEvents.LayoutClickNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Component.Focusable, ComponentContainer, Field<T>, HasComponents, HasComponents.ComponentAttachDetachNotifier, Layout, Layout.AlignmentHandler, Layout.MarginHandler, Layout.SpacingHandler, Serializable, Iterable<Component>

public class FieldLayout<T>
extends HorizontalLayout
implements Field<T>

A HorizontalLayout that also exposes an internally wrapped Field. This is useful when you have an existing Field and want to display it differently and/or with additional Components but still need it to function as a Field from a data perspective.

The layout is initially empty; use HorizontalLayout.addComponent() to add content.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.Field

Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Buffered

Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.data.Property

Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeEvent, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

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.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

Layout.AlignmentHandler, Layout.MarginHandler, Layout.SpacingHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

HasComponents.ComponentAttachDetachNotifier, HasComponents.ComponentAttachEvent, HasComponents.ComponentAttachListener, HasComponents.ComponentDetachEvent, HasComponents.ComponentDetachListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Field<T>	field

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

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 and Description
FieldLayout(Field<T> field) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addListener(Property.ValueChangeListener listener)
void	addValidator(Validator validator)
void	addValueChangeListener(Property.ValueChangeListener listener)
void	clear()
void	commit()
void	discard()
void	focus()
Property	getPropertyDataSource()
String	getRequiredError()
int	getTabIndex()
Class<? extends T>	getType()
Collection<Validator>	getValidators()
T	getValue()
boolean	isBuffered()
boolean	isEmpty()
boolean	isInvalidAllowed()
boolean	isInvalidCommitted()
boolean	isModified()
boolean	isReadOnly()
boolean	isRequired()
boolean	isValid()
void	removeAllValidators()
void	removeListener(Property.ValueChangeListener listener)
void	removeValidator(Validator validator)
void	removeValueChangeListener(Property.ValueChangeListener listener)
void	setBuffered(boolean buffered)
void	setInvalidAllowed(boolean invalidAllowed)
void	setInvalidCommitted(boolean invalidCommitted)
void	setPropertyDataSource(Property newDataSource)
void	setReadOnly(boolean readOnly)
void	setRequired(boolean required)
void	setRequiredError(String requiredError)
void	setTabIndex(int index)
void	setValue(T value)
void	validate()
void	valueChange(Property.ValueChangeEvent event)

Methods inherited from class com.vaadin.ui.HorizontalLayout

getState

Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, addListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, getState, isSpacing, iterator, readDesign, removeComponent, removeLayoutClickListener, removeListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

readMargin, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, removeListener, removeListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, addListener, addListener, getComponentIterator, moveComponentsFrom, removeAllComponents, removeListener, removeListener

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Field Detail

field

protected final Field<T> field

Constructor Detail

FieldLayout

public FieldLayout(Field<T> field)

Constructor.

Parameters:

field - the wrapped Field that this instance will derive its Field state from

Method Detail

getRequiredError

public String getRequiredError()

Specified by:

getRequiredError in interface Field<T>

setRequiredError

public void setRequiredError(String requiredError)

Specified by:

setRequiredError in interface Field<T>

isRequired

public boolean isRequired()

Specified by:

isRequired in interface Field<T>

setRequired

public void setRequired(boolean required)

Specified by:

setRequired in interface Field<T>

focus

public void focus()

Specified by:

focus in interface Component.Focusable

Overrides:

focus in class AbstractComponent

getTabIndex

public int getTabIndex()

Specified by:

getTabIndex in interface Component.Focusable

setTabIndex

public void setTabIndex(int index)

Specified by:

setTabIndex in interface Component.Focusable

isInvalidCommitted

public boolean isInvalidCommitted()

Specified by:

isInvalidCommitted in interface BufferedValidatable

setInvalidCommitted

public void setInvalidCommitted(boolean invalidCommitted)

Specified by:

setInvalidCommitted in interface BufferedValidatable

commit

public void commit()
            throws Buffered.SourceException

Specified by:

commit in interface Buffered

Throws:

Buffered.SourceException

discard

public void discard()
             throws Buffered.SourceException

Specified by:

discard in interface Buffered

Throws:

Buffered.SourceException

setBuffered

public void setBuffered(boolean buffered)

Specified by:

setBuffered in interface Buffered

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Buffered

isModified

public boolean isModified()

Specified by:

isModified in interface Buffered

addValidator

public void addValidator(Validator validator)

Specified by:

addValidator in interface Validatable

removeValidator

public void removeValidator(Validator validator)

Specified by:

removeValidator in interface Validatable

removeAllValidators

public void removeAllValidators()

Specified by:

removeAllValidators in interface Validatable

getValidators

public Collection<Validator> getValidators()

Specified by:

getValidators in interface Validatable

isValid

public boolean isValid()

Specified by:

isValid in interface Validatable

validate

public void validate()
              throws Validator.InvalidValueException

Specified by:

validate in interface Validatable

Throws:

Validator.InvalidValueException

isInvalidAllowed

public boolean isInvalidAllowed()

Specified by:

isInvalidAllowed in interface Validatable

setInvalidAllowed

public void setInvalidAllowed(boolean invalidAllowed)

Specified by:

setInvalidAllowed in interface Validatable

getType

public Class<? extends T> getType()

Specified by:

getType in interface Property<T>

getValue

public T getValue()

Specified by:

getValue in interface Property<T>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Property<T>

Specified by:

isReadOnly in interface Component

Overrides:

isReadOnly in class AbstractComponent

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface Property<T>

Specified by:

setReadOnly in interface Component

Overrides:

setReadOnly in class AbstractComponent

setValue

public void setValue(T value)

Specified by:

setValue in interface Property<T>

addValueChangeListener

public void addValueChangeListener(Property.ValueChangeListener listener)

Specified by:

addValueChangeListener in interface Property.ValueChangeNotifier

removeValueChangeListener

public void removeValueChangeListener(Property.ValueChangeListener listener)

Specified by:

removeValueChangeListener in interface Property.ValueChangeNotifier

addListener

public void addListener(Property.ValueChangeListener listener)

Specified by:

addListener in interface Property.ValueChangeNotifier

removeListener

public void removeListener(Property.ValueChangeListener listener)

Specified by:

removeListener in interface Property.ValueChangeNotifier

valueChange

public void valueChange(Property.ValueChangeEvent event)

Specified by:

valueChange in interface Property.ValueChangeListener

setPropertyDataSource

public void setPropertyDataSource(Property newDataSource)

Specified by:

setPropertyDataSource in interface Property.Viewer

getPropertyDataSource

public Property getPropertyDataSource()

Specified by:

getPropertyDataSource in interface Property.Viewer

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Field<T>

clear

public void clear()

Specified by:

clear in interface Field<T>