com.haulmont.cuba.desktop.gui.components

Class DesktopAbstractField<C extends javax.swing.JComponent>

java.lang.Object

com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent<C>

com.haulmont.cuba.desktop.gui.components.DesktopAbstractField<C>

All Implemented Interfaces:

DesktopComponent, Component, Component.BelongToFrame, Component.Editable, Component.HasCaption, Component.HasIcon, Component.HasValue, Component.HasXmlDescriptor, Component.Validatable, Component.Wrapper, DatasourceComponent, Field

Direct Known Subclasses:

DesktopAbstractOptionsField, DesktopAbstractTextField, DesktopAbstractUploadField, DesktopCheckBox, DesktopDateField, DesktopListEditor, DesktopPickerField, DesktopTimeField, DesktopTokenList

public abstract class DesktopAbstractField<C extends javax.swing.JComponent>
extends DesktopAbstractComponent<C>
implements Field

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

SWING_PROPERTY_CLASS, SWING_PROPERTY_ID

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
DesktopAbstractField()

Method Summary

Modifier and Type	Method and Description
void	addListener(ValueListener listener)
void	addValidator(Field.Validator validator) Add Field.Validator instance.
void	addValueChangeListener(Component.ValueChangeListener listener)
java.lang.String	getRequiredMessage()
java.util.Collection<Field.Validator>	getValidators()
boolean	isEditable()
boolean	isRequired()
boolean	isValid()
void	removeListener(ValueListener listener)
void	removeValidator(Field.Validator validator)
void	removeValueChangeListener(Component.ValueChangeListener listener)
void	setEditable(boolean editable)
void	setParent(Component parent) INTERNAL. Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.
void	setRequired(boolean required)
void	setRequiredMessage(java.lang.String msg) A message that will be displayed to user if the field is required but has null value
void	updateMissingValueState()
void	validate()

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getComposition, getDebugId, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getTabIndex, getWidth, getWidthUnits, getXmlDescriptor, isComponentVisible, isEnabled, isEnabledItself, isParentEnabled, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setContainer, setDebugId, setEnabled, setExpanded, setFrame, setHeight, setIcon, setId, setParentEnabled, setResponsive, setStyleName, setTabIndex, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasValue

getValue, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditableWithParent

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Validatable

isValidateOnCommit

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon

Constructor Detail

DesktopAbstractField

public DesktopAbstractField()

Method Detail

addListener

public void addListener(ValueListener listener)

Specified by:

addListener in interface Component.HasValue

removeListener

public void removeListener(ValueListener listener)

Specified by:

removeListener in interface Component.HasValue

addValueChangeListener

public void addValueChangeListener(Component.ValueChangeListener listener)

Specified by:

addValueChangeListener in interface Component.HasValue

removeValueChangeListener

public void removeValueChangeListener(Component.ValueChangeListener listener)

Specified by:

removeValueChangeListener in interface Component.HasValue

addValidator

public void addValidator(Field.Validator validator)

Description copied from interface: Field

Add Field.Validator instance.

Specified by:

addValidator in interface Field

removeValidator

public void removeValidator(Field.Validator validator)

Specified by:

removeValidator in interface Field

getValidators

public java.util.Collection<Field.Validator> getValidators()

Specified by:

getValidators in interface Field

Returns:

unmodifiable collection with Field validators

isValid

public boolean isValid()

Specified by:

isValid in interface Component.Validatable

validate

public void validate()
              throws ValidationException

Specified by:

validate in interface Component.Validatable

Throws:

ValidationException

isRequired

public boolean isRequired()

Specified by:

isRequired in interface Field

Returns:

whether the field must contain a non-null value

setRequired

public void setRequired(boolean required)

Specified by:

setRequired in interface Field

updateMissingValueState

public void updateMissingValueState()

setRequiredMessage

public void setRequiredMessage(java.lang.String msg)

Description copied from interface: Field

A message that will be displayed to user if the field is required but has null value

Specified by:

setRequiredMessage in interface Field

getRequiredMessage

public java.lang.String getRequiredMessage()

Specified by:

getRequiredMessage in interface Field

isEditable

public boolean isEditable()

Specified by:

isEditable in interface Component.Editable

setEditable

public void setEditable(boolean editable)

Specified by:

setEditable in interface Component.Editable

setParent

public void setParent(Component parent)

Description copied from interface: Component

INTERNAL.
Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.

Specified by:

setParent in interface Component

Overrides:

setParent in class DesktopAbstractComponent<C extends javax.swing.JComponent>

Parameters:

parent - Parent component