org.sensorhub.ui.api

Interface IModuleConfigForm

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.shared.Connector, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, Iterable<com.vaadin.ui.Component>, com.vaadin.ui.Layout.MarginHandler, Serializable, com.vaadin.server.Sizeable

All Known Implementing Classes:

BasicSecurityConfigForm, CommProviderConfigForm, GenericConfigForm, GenericStorageConfigForm, HttpServerConfigForm, SOSConfigForm, SPSConfigForm

public interface IModuleConfigForm
extends com.vaadin.ui.ComponentContainer, com.vaadin.ui.Layout.MarginHandler

Interface for all UI forms used to configure modules

Since:

0.5

Author:

Alex Robin

Nested Class Summary

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

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

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

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

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

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

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

com.vaadin.server.Sizeable.Unit

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	build(String propertyId, ComplexProperty prop, boolean includeSubForms) Builds the whole form for a complex property (i.e.
void	build(String title, String popupText, MyBeanItem<? extends Object> beanItem, boolean includeSubForms) Builds the whole form for a given config object.
void	commit() Commit all changes made in the UI values to the underlying bean object
IModuleConfigForm	getParentForm()
Class<?>	getPolymorphicBeanParentType() Get the class whose allowed bean types should derive from
Map<String,Class<?>>	getPossibleTypes(String propId) Return possible object types for the given property ID
List<Object>	getPossibleValues(String propId) Return possible values for the given property ID
List<com.vaadin.ui.Component>	getSubForms()
void	setParentForm(IModuleConfigForm parentForm)

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponent, addComponents, addListener, addListener, getComponentCount, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponent, removeListener, removeListener, replaceComponent

Methods inherited from interface com.vaadin.ui.HasComponents

iterator

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, readDesign, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, 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.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Methods inherited from interface com.vaadin.ui.Layout.MarginHandler

getMargin, setMargin, setMargin

Method Detail

build

void build(String propertyId,
         ComplexProperty prop,
         boolean includeSubForms)

Builds the whole form for a complex property (i.e. whose value is an object)

Parameters:

propertyId -

prop -

includeSubForms -

build

void build(String title,
         String popupText,
         MyBeanItem<? extends Object> beanItem,
         boolean includeSubForms)

Builds the whole form for a given config object.

Parameters:

title - title of the form

popupText - help popup text shown when hovering on the form title

beanItem - object to render a form for

includeSubForms - true to include sub forms in the component

getParentForm

IModuleConfigForm getParentForm()

Returns:

the parent form or null if non exists

setParentForm

void setParentForm(IModuleConfigForm parentForm)

getSubForms

List<com.vaadin.ui.Component> getSubForms()

Returns:

list of subforms included into this form

getPolymorphicBeanParentType

Class<?> getPolymorphicBeanParentType()

Get the class whose allowed bean types should derive from

Returns:

parent type or null if the bean cannot be replaced by another type

getPossibleTypes

Map<String,Class<?>> getPossibleTypes(String propId)

Return possible object types for the given property ID

Parameters:

propId - property ID

Returns:

map of names to types assignable to that property

getPossibleValues

List<Object> getPossibleValues(String propId)

Return possible values for the given property ID

Parameters:

propId - property ID

Returns:

list of values allowed for that property

commit

void commit()
            throws com.vaadin.data.fieldgroup.FieldGroup.CommitException

Commit all changes made in the UI values to the underlying bean object

Throws:

com.vaadin.data.fieldgroup.FieldGroup.CommitException - if data cannot be committed