org.jboss.forge.addon.ui.input

Interface InputComponent<IMPLTYPE,VALUETYPE>

All Superinterfaces:

Faceted<HintsFacet>, MutableFaceted<HintsFacet>

All Known Subinterfaces:

SelectComponent<IMPLTYPE,VALUETYPE>, UIInput<VALUETYPE>, UIInputMany<VALUETYPE>, UISelectMany<VALUETYPE>, UISelectOne<VALUETYPE>

public interface InputComponent<IMPLTYPE,VALUETYPE>
extends MutableFaceted<HintsFacet>

This is the parent interface of all inputs.

Author:

Lincoln Baxter, III, George Gastaldi

Method Summary

Methods

Modifier and Type	Method and Description
IMPLTYPE	addValidator(UIValidator validator) Add a new UIValidator with which this InputComponent should be validated.
org.jboss.forge.furnace.spi.ListenerRegistration<ValueChangeListener>	addValueChangeListener(ValueChangeListener listener) Listens for changes in the value of this input
String	getDescription() Return a few sentences describing the purpose of this InputComponent.
String	getLabel() Return the label for this InputComponent.
String	getName() Return the name of this InputComponent.
String	getRequiredMessage() Return the message to be displayed when this InputComponent is required and no primary or default value has been set.
char	getShortName() Return the single character abbreviation representing this InputComponent.
Set<UIValidator>	getValidators() Return the current UIValidator with which this InputComponent should be validated.
Object	getValue() Returns the value associated with this component.
Converter<String,VALUETYPE>	getValueConverter() Get the current Converter instance with which this InputComponent value should be converted to and from String form.
Class<VALUETYPE>	getValueType() Return the Class type of this InputComponent.
boolean	hasDefaultValue() Return true if this InputComponent has been supplied with a default value.
boolean	hasValue() Return true if the primary value of this InputComponent has been set.
boolean	isEnabled() Return true if this InputComponent is enabled, and should be displayed in the user interface.
boolean	isRequired() Return true if a value or default value of this InputComponent must be set before the UICommand to which it belongs may be executed.
IMPLTYPE	setDescription(Callable<String> description) Set a few sentences describing the purpose of this InputComponent.
IMPLTYPE	setDescription(String description) Set a few sentences describing the purpose of this InputComponent.
IMPLTYPE	setEnabled(boolean b) Set this InputComponent to be enabled.
IMPLTYPE	setEnabled(Callable<Boolean> callable) Set the Callable object to supply the value when isEnabled() is called.
IMPLTYPE	setLabel(String label) Set the label for this InputComponent.
IMPLTYPE	setRequired(boolean required) Set this InputComponent to be a required input.
IMPLTYPE	setRequired(Callable<Boolean> required) Set the Callable object to supply the value when isRequired() is called.
IMPLTYPE	setRequiredMessage(Callable<String> message) Set the Callable object to supply the message to be displayed when this InputComponent is required and no primary or default value has been set.
IMPLTYPE	setRequiredMessage(String message) Set the message to be displayed when this InputComponent is required and no primary or default value has been set.
IMPLTYPE	setValueConverter(Converter<String,VALUETYPE> converter) Set the current Converter instance with which this InputComponent value should be converted to and from String form
void	validate(UIValidationContext context) Validate the current UIInput.

Methods inherited from interface org.jboss.forge.addon.facets.MutableFaceted

install, register, uninstall, unregister

Methods inherited from interface org.jboss.forge.addon.facets.Faceted

getFacet, getFacets, getFacets, hasAllFacets, hasAllFacets, hasFacet, supports

Method Detail

getLabel

String getLabel()

Return the label for this InputComponent. This is typically used when displaying inputs in more graphical layouts, or when a short description of the input is required.

getName

String getName()

Return the name of this InputComponent. This is typically used for text-based interactions, and may be canonicalized by the UIProvider implementation.

getDescription

String getDescription()

Return a few sentences describing the purpose of this InputComponent.

getValueType

Class<VALUETYPE> getValueType()

Return the Class type of this InputComponent.

hasDefaultValue

boolean hasDefaultValue()

Return true if this InputComponent has been supplied with a default value.

hasValue

boolean hasValue()

Return true if the primary value of this InputComponent has been set. (If true any default value will be ignored.) If a default value has been provided, this method will still return false if no primary value has been set.

isEnabled

boolean isEnabled()

Return true if this InputComponent is enabled, and should be displayed in the user interface.

isRequired

boolean isRequired()

Return true if a value or default value of this InputComponent must be set before the UICommand to which it belongs may be executed.

getRequiredMessage

String getRequiredMessage()

Return the message to be displayed when this InputComponent is required and no primary or default value has been set.

getShortName

char getShortName()

Return the single character abbreviation representing this InputComponent. This is typically used for hot-keys or text-based shorthand flags in non-graphical user interfaces.

getValidators

Set<UIValidator> getValidators()

Return the current UIValidator with which this InputComponent should be validated.

setEnabled

IMPLTYPE setEnabled(boolean b)

Set this InputComponent to be enabled.

setEnabled

IMPLTYPE setEnabled(Callable<Boolean> callable)

Set the Callable object to supply the value when isEnabled() is called.

setLabel

IMPLTYPE setLabel(String label)

Set the label for this InputComponent. This is typically used when displaying inputs in more graphical layouts, or when a short description of the input is required.

setDescription

IMPLTYPE setDescription(String description)

Set a few sentences describing the purpose of this InputComponent.

setDescription

IMPLTYPE setDescription(Callable<String> description)

Set a few sentences describing the purpose of this InputComponent.

setRequired

IMPLTYPE setRequired(boolean required)

Set this InputComponent to be a required input.

setRequired

IMPLTYPE setRequired(Callable<Boolean> required)

Set the Callable object to supply the value when isRequired() is called.

setRequiredMessage

IMPLTYPE setRequiredMessage(String message)

Set the message to be displayed when this InputComponent is required and no primary or default value has been set.

setRequiredMessage

IMPLTYPE setRequiredMessage(Callable<String> message)

Set the Callable object to supply the message to be displayed when this InputComponent is required and no primary or default value has been set.

getValueConverter

Converter<String,VALUETYPE> getValueConverter()

Get the current Converter instance with which this InputComponent value should be converted to and from String form.

setValueConverter

IMPLTYPE setValueConverter(Converter<String,VALUETYPE> converter)

Set the current Converter instance with which this InputComponent value should be converted to and from String form

addValidator

IMPLTYPE addValidator(UIValidator validator)

Add a new UIValidator with which this InputComponent should be validated.

getValue

Object getValue()

Returns the value associated with this component. If the value is not set, the default value is returned. If the default value is not set, null is returned

addValueChangeListener

org.jboss.forge.furnace.spi.ListenerRegistration<ValueChangeListener> addValueChangeListener(ValueChangeListener listener)

Listens for changes in the value of this input

validate

void validate(UIValidationContext context)

Validate the current UIInput.

Parameters:

validator - the UIValidationContext object that holds validation errors