com.qcadoo.view.api

Interface ComponentState

All Superinterfaces:

ComponentMessagesHolder

All Known Subinterfaces:

AwesomeDynamicListComponent, CheckBoxComponent, FieldComponent, FormComponent, GridComponent, InputWithActionComponent, LookupComponent, ViewDefinitionState

public interface ComponentState
extends ComponentMessagesHolder

ComponentState is instance of single view element. It is created by ComponentPattern in request scope.

ComponentState contains all informations about state of this component. Changing this data will also change state displayed to system user.

Since:

0.4.0

See Also:

com.qcadoo.view.internal.api.ComponentPattern

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ComponentState.MessageType Type of displayed message.

Method Summary

Modifier and Type	Method and Description
Object	getFieldValue() Returns value of element defined by this component or null if this component don't contains value
Locale	getLocale() Returns current localization
String	getName() Returns name of this component.
String	getUuid() Returns unique identifier of this component.
boolean	isEnabled() Returns true if element defined by this component is be enabled
boolean	isHasError() Returns true if this component has any error.
boolean	isVisible() Returns true if element defined by this component is visible and false if it is hidden.
void	performEvent(ViewDefinitionState viewDefinitionState, String event, String... args) Performs event on this component.
void	setEnabled(boolean enable) Defines if element defined by this component should be enabled.
void	setFieldValue(Object value) Sets new value of element defined by this component or do nothing if this component don't contains value
void	setVisible(boolean visible) Defines if element defined by this component should be visible.

Methods inherited from interface com.qcadoo.view.api.ComponentMessagesHolder

addMessage, addMessage, addMessage, addMessage, addMessage, addTranslatedMessage, addTranslatedMessage, addTranslatedMessage

Method Detail

getFieldValue

Object getFieldValue()

Returns value of element defined by this component or null if this component don't contains value

Returns:

value of element defined by this component

getLocale

Locale getLocale()

Returns current localization

Returns:

current localization

getName

String getName()

Returns name of this component.

Returns:

name of this component

getUuid

String getUuid()

Returns unique identifier of this component.

Returns:

unique identifier of this component

isEnabled

boolean isEnabled()

Returns true if element defined by this component is be enabled

Returns:

true if element defined by this component is enabled

isHasError

boolean isHasError()

Returns true if this component has any error.

Returns:

true if this component has any error

isVisible

boolean isVisible()

Returns true if element defined by this component is visible and false if it is hidden.

Returns:

true if element defined by this component is visible and false if it is hidden

performEvent

void performEvent(ViewDefinitionState viewDefinitionState,
                  String event,
                  String... args)

Performs event on this component. For internal usage only

Parameters:

viewDefinitionState - viewDefinitionState

event - name of event

args - arguments of event

setEnabled

void setEnabled(boolean enable)

Defines if element defined by this component should be enabled.

Parameters:

enable - true if element defined by this component should be enabled

setFieldValue

void setFieldValue(Object value)

Sets new value of element defined by this component or do nothing if this component don't contains value

Parameters:

value - new value of element defined by this component

setVisible

void setVisible(boolean visible)

Defines if element defined by this component should be visible.

Parameters:

visible - true if element defined by this component should be visible and false if it should be hidden