Package lumis.portalmanagement.doui.control.tag

Class TagControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.DataBoundControl

lumis.portalmanagement.doui.control.tag.TagControl

All Implemented Interfaces:

Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

AreaTagsControl, ConfigurationTagsControl

public class TagControl
extends DataBoundControl

Defines an input tag control that allows the user to enter any tag value. This is a data bound control.

The value node gets the control value as its inputed, while the tags node is filled in alphabetical ascending order. Example use:

<control type="lum_tag" id="tagId" sourceId="default"/> xml data available for xsl rendering: <control id="tags" sourceId="default" type="lum_tag"> <controls> <control type="lum_inputHidden" sourceId="default" id="areaTags.value"/> </controls> <data> <value>tag3, tag1, tag2</value> <tags> <tag> <name>tag1</name> </tag> <tag> <name>tag2</name> </tag> <tag> <name>tag3</name> </tag> </tags> </data> </control>

Since:

7.1.0

Version:

$Revision: 20941 $ $Date: 2018-02-07 13:54:42 -0200 (Wed, 07 Feb 2018) $

Field Summary

Fields inherited from class lumis.doui.control.DataControl

FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, ON_EVENT_VALIDATE, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

Constructors

Constructor	Description
TagControl()

Method Summary

Modifier and Type	Method	Description
void	buildSubControls()
protected IConverter	createConverter()	Creates the converter instance for this control.
protected String	getAutoCompleteResourceURL()	Returns the auto complete resource URL that will be used by the TagIt API to provide the auto complete.
IResource	getControlResource()
protected Object	getParameterValue(String parameterName)	Returns the value for this control, reading from request the parameters based on the specified name.
protected Class<?>	getValueClass()	Returns the class the possible values of this control are assignable to.
protected boolean	isAllowNewTags()	Define if is possible inform new tags (true) or only use predefined tags (false).
void	setRenderData()

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRequestHelpDefinition, getRuntimeDefaultSource, getSource, getSourceById, getSourceContext, getUnboundedConverter, init, loadFromRequest, setDefaultValue, setRawValue, setReload, setSourceParameter, setValid, setValueFromSource, setValueFromSource, update

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, getConverter, getDataType, getDefaultValue, getProcessActionIds, getRequestParameterName, getValue, getValue, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setSourceParameter, setSourceParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getStringsToLocalize, getType, getValidationScript, getWindowProperties, getWindowProperties, isRequired, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setName, setRuntimeAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.doui.control.IControl

createContainer, disconnect, getChildControls, getId, getName, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes

Methods inherited from interface lumis.doui.control.IDataControl

getConverter, getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue

Methods inherited from interface lumis.doui.render.IRenderer

getResources

Constructor Detail

TagControl

public TagControl()

Method Detail

getControlResource

public IResource getControlResource()
                             throws PortalException

Specified by:

getControlResource in interface IControl

Overrides:

getControlResource in class Control

Throws:

PortalException

getValueClass

protected Class<?> getValueClass()
                          throws PortalException

Description copied from class: DataControl

Returns the class the possible values of this control are assignable to.

This default implementation uses IDouiDataType.getValueClass() of the data type of this control.

Overrides:

getValueClass in class DataControl

Returns:

the class the possible values of this control are assignable to.

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl

Throws:

PortalException

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl

Throws:

PortalException

getAutoCompleteResourceURL

protected String getAutoCompleteResourceURL()

Returns the auto complete resource URL that will be used by the TagIt API to provide the auto complete.

Returns:

the auto complete resource URL that will be used by the TagIt API to provide the auto complete.

Since:

7.1.0

isAllowNewTags

protected boolean isAllowNewTags()

Define if is possible inform new tags (true) or only use predefined tags (false).

Returns:

true if is possible inform new tags and false otherwise. The default is true.

Since:

7.1.0

createConverter

protected IConverter createConverter()
                              throws PortalException

Description copied from class: DataControl

Creates the converter instance for this control.

Overrides:

createConverter in class DataBoundControl

Returns:

the converter instance or null if this control has no converter.

Throws:

PortalException

getParameterValue

protected Object getParameterValue(String parameterName)
                            throws PortalException

Description copied from class: DataControl

Returns the value for this control, reading from request the parameters based on the specified name.

DataControl.loadFromRequest() calls this method when necessary, to read the value to be set in the control.

Overrides:

getParameterValue in class DataControl

Parameters:

parameterName - the parameter name where the value is to be read from. For controls that require multiple request parameters, it is recommended to use the control's identifier as a prefix to its parameter names during render, and then can implement this method as using the given parameter name as the prefix.

Returns:

the value.

Throws:

PortalException