de.xima.fc.gui.component.inputtags

Class InputTags

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

javax.faces.component.html.HtmlInputText

de.xima.fc.gui.component.inputtags.InputTags

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.primefaces.component.api.InputHolder, org.primefaces.component.api.Widget

public class InputTags
extends javax.faces.component.html.HtmlInputText
implements org.primefaces.component.api.Widget, org.primefaces.component.api.InputHolder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InputTags.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static int	DEFAULT_ANIMATE_DELETE
static List<Object>	DEFAULT_AVAILABLE_TAGS
static boolean	DEFAULT_CLICK_DELETE
static String	DEFAULT_DELIMITER
static boolean	DEFAULT_FORCE_LOWERCASE
static int	DEFAULT_MAX_LENGTH
static int	DEFAULT_MAX_TAGS
static String	DEFAULT_PLACEHOLDER
static boolean	DEFAULT_REMOVE_DUPLICATES
static String	DEFAULT_RENDERER
static boolean	DEFAULT_SHOW_ON_FOCUS
static boolean	DEFAULT_SORTABLE
static boolean	DEFAULT_STRING_MODEL
static String	INVALID_MESSAGE_ID
static String	INVALID_MESSAGE_ID_LENGTH
static String	INVALID_MESSAGE_ID_NOT_AVAILABLE
static String	INVALID_MESSAGE_ID_TAG_TOO_LONG
static String	STYLE_CLASS

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
InputTags()

Method Summary

Modifier and Type	Method and Description
int	getAnimateDelete()
List	getAvailableTags()
String	getDelimiter()
String	getDelimiterPattern()
Collection<String>	getEventNames()
String	getFamily()
String	getInputClientId()
String	getLabelledBy()
List<?>	getListValue()
char	getMainDelimiter()
int	getMaxlength()
int	getMaxTags()
String	getPlaceholder()
String	getValidatableInputClientId()
String	getWidgetVar()
boolean	isClickDelete()
boolean	isForceLowercase()
boolean	isRemoveDuplicates()
boolean	isShowOnFocus()
boolean	isSortable()
boolean	isStringModel()
String	resolveWidgetVar()
void	setAnimateDelete(int animateDelete)
void	setAvailableTags(List availableTags)
void	setClickDelete(boolean clickDelete)
void	setDelimiter(String delimiter)
void	setForceLowercase(boolean forceLowercase)
void	setLabelledBy(String labelledBy)
void	setMaxTags(int maxTags)
void	setPlaceholder(String placeholder)
void	setRemoveDuplicates(boolean removeDuplicates)
void	setShowOnFocus(boolean showOnFocus)
void	setSortable(boolean sortable)
void	setStringModel(boolean stringModel)
void	setWidgetVar(String widgetVar)
protected void	validateValue(javax.faces.context.FacesContext context, Object value)

Methods inherited from class javax.faces.component.html.HtmlInputText

getAccesskey, getAlt, getAutocomplete, getDefaultEventName, getDir, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setAutocomplete, setDir, setDisabled, setLabel, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setRole, setSize, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

Constant Field Values

INVALID_MESSAGE_ID

public static final String INVALID_MESSAGE_ID

See Also:

Constant Field Values

INVALID_MESSAGE_ID_LENGTH

public static final String INVALID_MESSAGE_ID_LENGTH

See Also:

Constant Field Values

INVALID_MESSAGE_ID_NOT_AVAILABLE

public static final String INVALID_MESSAGE_ID_NOT_AVAILABLE

See Also:

Constant Field Values

INVALID_MESSAGE_ID_TAG_TOO_LONG

public static final String INVALID_MESSAGE_ID_TAG_TOO_LONG

See Also:

Constant Field Values

STYLE_CLASS

public static final String STYLE_CLASS

See Also:

Constant Field Values

DEFAULT_ANIMATE_DELETE

public static final int DEFAULT_ANIMATE_DELETE

See Also:

Constant Field Values

DEFAULT_AVAILABLE_TAGS

public static final List<Object> DEFAULT_AVAILABLE_TAGS

DEFAULT_CLICK_DELETE

public static final boolean DEFAULT_CLICK_DELETE

See Also:

Constant Field Values

DEFAULT_DELIMITER

public static final String DEFAULT_DELIMITER

See Also:

Constant Field Values

DEFAULT_FORCE_LOWERCASE

public static final boolean DEFAULT_FORCE_LOWERCASE

See Also:

Constant Field Values

DEFAULT_MAX_LENGTH

public static final int DEFAULT_MAX_LENGTH

See Also:

Constant Field Values

DEFAULT_MAX_TAGS

public static final int DEFAULT_MAX_TAGS

See Also:

Constant Field Values

DEFAULT_PLACEHOLDER

public static final String DEFAULT_PLACEHOLDER

See Also:

Constant Field Values

DEFAULT_SHOW_ON_FOCUS

public static final boolean DEFAULT_SHOW_ON_FOCUS

See Also:

Constant Field Values

DEFAULT_REMOVE_DUPLICATES

public static final boolean DEFAULT_REMOVE_DUPLICATES

See Also:

Constant Field Values

DEFAULT_SORTABLE

public static final boolean DEFAULT_SORTABLE

See Also:

Constant Field Values

DEFAULT_STRING_MODEL

public static final boolean DEFAULT_STRING_MODEL

See Also:

Constant Field Values

Constructor Detail

InputTags

public InputTags()

Method Detail

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.html.HtmlInputText

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getMainDelimiter

public char getMainDelimiter()

Returns:

The main delimiting character for tags, ie. the first character of the getDelimiter()s.

getDelimiterPattern

public String getDelimiterPattern()

Returns:

The pattern that matches any of the delimiter. Eg. if the getDelimiter() is ,;, this returns the pattern ,|;.

getListValue

public List<?> getListValue()

Returns:

The value of this component as a list. If UIInput.getValue() is not a List, convert to a String and split by the getMainDelimiter().

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface org.primefaces.component.api.Widget

getInputClientId

public String getInputClientId()

Specified by:

getInputClientId in interface org.primefaces.component.api.InputHolder

getValidatableInputClientId

public String getValidatableInputClientId()

Specified by:

getValidatableInputClientId in interface org.primefaces.component.api.InputHolder

getLabelledBy

public String getLabelledBy()

Specified by:

getLabelledBy in interface org.primefaces.component.api.InputHolder

setLabelledBy

public void setLabelledBy(String labelledBy)

Specified by:

setLabelledBy in interface org.primefaces.component.api.InputHolder

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String widgetVar)

getMaxlength

public int getMaxlength()

Overrides:

getMaxlength in class javax.faces.component.html.HtmlInputText

isStringModel

public boolean isStringModel()

Returns:

Whether the model (the value expression) uses a String instead of a List. Defaults to false.

setStringModel

public void setStringModel(boolean stringModel)

Parameters:

placeholder - Placeholder text for empty tag editor.

getPlaceholder

public String getPlaceholder()

Returns:

Placeholder text for empty tag editor. Defaults to no placeholder.

setPlaceholder

public void setPlaceholder(String placeholder)

Parameters:

placeholder - Placeholder text for empty tag editor.

isShowOnFocus

public boolean isShowOnFocus()

Returns:

If autocompletion is enabled via getAvailableTags(): Whether suggestions are shown as soon as the user focuses on the input field. Defaults to false.

setShowOnFocus

public void setShowOnFocus(boolean showOnFocus)

Parameters:

showOnFocus - If autocompletion is enabled via getAvailableTags(): Whether suggestions are shown as soon as the user focuses on the input field. Defaults to false.

getMaxTags

public int getMaxTags()

Returns:

Maximum number of allowed tags. 0 is not limit. Defaults to 0.

setMaxTags

public void setMaxTags(int maxTags)

Parameters:

maxTags - Maximum number of allowed tags.

isForceLowercase

public boolean isForceLowercase()

Returns:

Whether to lowercase all tags. Defaults to false.

setForceLowercase

public void setForceLowercase(boolean forceLowercase)

Parameters:

forceLowercase - Whether to lowercase all tags.

getDelimiter

public String getDelimiter()

Returns:

Required string of delimiters - characters for separating tags. The first character is used as default delimiter in the (hidden) original field. Defaults to ,;.

setDelimiter

public void setDelimiter(String delimiter)

Parameters:

delimiter - Required string of delimiters - characters for separating tags. The first character is used as default delimiter in the (hidden) original field.

isRemoveDuplicates

public boolean isRemoveDuplicates()

Returns:

Whether to automatically remove duplicate tags. Defaults to true.

setRemoveDuplicates

public void setRemoveDuplicates(boolean removeDuplicates)

Parameters:

removeDuplicates - Whether to automatically remove duplicate tags.

getAnimateDelete

public int getAnimateDelete()

Returns:

Animate duration for deletion of tags in milliseconds. Set to 0 for non-animated removal. Defaults to 175.

setAnimateDelete

public void setAnimateDelete(int animateDelete)

Parameters:

animateDelete - Animate duration for deletion of tags in milliseconds. Set to 0 for non-animated removal.

isClickDelete

public boolean isClickDelete()

Returns:

Whether to delete tags also on right click and on Ctrl+click. Defaults to false.

setClickDelete

public void setClickDelete(boolean clickDelete)

Parameters:

clickDelete - Whether to delete tags also on right click and on Ctrl+click.

isSortable

public boolean isSortable()

Returns:

If jQuery UI sortable is available and this option is set to true, tags are sortable by drag and drop. Defaults to true.

setSortable

public void setSortable(boolean sortable)

Parameters:

sortable - If jQuery UI sortable is available and this option is set to true, tags are sortable by drag and drop.

getAvailableTags

public List getAvailableTags()

Returns:

List of available tags. If given and not empty, autocomplete is activated and all tags not included in this list are disallowed and cannot be entered. Autocomplete required JQuery UI to be available.

setAvailableTags

public void setAvailableTags(List availableTags)

Parameters:

availableTags - List of available tags. If given and not empty, autocomplete is activated and all tags not included in this list are disallowed and cannot be entered.

validateValue

protected void validateValue(javax.faces.context.FacesContext context,
                             Object value)

Overrides:

validateValue in class javax.faces.component.UIInput