er.coolcomponents

Class CCTagEditor

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.extensions.components.ERXDynamicElement

er.ajax.AjaxDynamicElement

er.coolcomponents.CCTagEditor

All Implemented Interfaces:

IAjaxElement

public class CCTagEditor
extends AjaxDynamicElement

WebObjects wrapper for Insignia tag editor component and Horsey auto-completion, MIT license. To be used in conjunction with ERAjaxTagField, which contains the ERTaggable-specific code.

See Also:

Insignia, Horsey

Author:

fpeters (WebObjects wrapper only)

Bindings

Name	Description
value,	the string representing the list of tags
deletion	optional, default is true, whether each tag should carry an icon for easy deletion
delimiter	optional, default is space, the separator between tags
render	optional, a method that's called whenever a tag should be rendered
readTag	optional, a method that retrieves the tag from the DOM element
parse	optional, a method that transforms user input into a tag
validate	optional, a method that validates the parsed tag value
convertOnFocus	optional, default is true, whether the tags are being converted when the focus event fires on elements other than the tag input

Nested Class Summary

Nested classes/interfaces inherited from class er.extensions.components.ERXDynamicElement

ERXDynamicElement.ContextData<T>

Field Summary

Fields inherited from class er.extensions.components.ERXDynamicElement

log

Fields inherited from class com.webobjects.appserver._private.WODynamicGroup

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

Constructors

Constructor and Description
CCTagEditor(String name, NSDictionary<String,WOAssociation> associations, WOElement children)

Method Summary

Modifier and Type	Method and Description
protected void	addRequiredWebResources(WOResponse response, WOContext context) Override this method to append the needed scripts for this component.
void	appendToResponse(WOResponse response, WOContext context) Build span, input, and JavaScript into response.
String	availableTags(WOContext context)
protected NSMutableDictionary<String,String>	createOptions(WOContext context) Produce dictionary for options object
protected String	formValueName(WOContext context)
WOActionResults	handleRequest(WORequest request, WOContext context) Handles server action.
String	id(WOContext context) Return the value of the id binding if it exists or a safe identifier otherwise.
protected void	setValueFromFormValue(WORequest request, WOContext context) Sets the value binding based on the form value.

Methods inherited from class er.ajax.AjaxDynamicElement

_containerID, addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, invokeAction, shouldHandleRequest

Methods inherited from class er.extensions.components.ERXDynamicElement

afterProcessing, appendTagAttributeToResponse, arrayValueForBinding, arrayValueForBinding, associations, beforeProcessing, bindingIsSettable, bindingNamed, booleanValueForBinding, booleanValueForBinding, hasBinding, integerValueForBinding, nameInContext, secureInContext, setValueForBinding, stringValueForBinding, stringValueForBinding, valueForBinding, valueForBinding

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, appendChildrenToResponse, childrenElements, EmptyGroup, hasChildrenElements, invokeChildrenAction, takeChildrenValuesFromRequest, takeValuesFromRequest, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface er.ajax.IAjaxElement

valueForBinding, valueForBinding

Constructor Detail

CCTagEditor

public CCTagEditor(String name,
                   NSDictionary<String,WOAssociation> associations,
                   WOElement children)

Method Detail

addRequiredWebResources

protected void addRequiredWebResources(WOResponse response,
                                       WOContext context)

Description copied from class: AjaxDynamicElement

Override this method to append the needed scripts for this component.

Specified by:

addRequiredWebResources in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

appendToResponse

public void appendToResponse(WOResponse response,
                             WOContext context)

Build span, input, and JavaScript into response.

Overrides:

appendToResponse in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

See Also:

AjaxDynamicElement.appendToResponse(com.webobjects.appserver.WOResponse, com.webobjects.appserver.WOContext)

availableTags

public String availableTags(WOContext context)

createOptions

protected NSMutableDictionary<String,String> createOptions(WOContext context)

Produce dictionary for options object

Parameters:

context - WOContext providing component to resolve bindings in

Returns:

binding values converted into Ajax options

handleRequest

public WOActionResults handleRequest(WORequest request,
                                     WOContext context)

Handles server action. Sets the value binding and calls the optional action method.

Specified by:

handleRequest in interface IAjaxElement

Specified by:

handleRequest in class AjaxDynamicElement

Parameters:

request - the current request

context - context of the transaction

Returns:

null, this component returns nothing to the client

See Also:

AjaxDynamicElement.handleRequest(com.webobjects.appserver.WORequest, com.webobjects.appserver.WOContext), WODynamicGroup.takeValuesFromRequest(WORequest, WOContext)

setValueFromFormValue

protected void setValueFromFormValue(WORequest request,
                                     WOContext context)

Sets the value binding based on the form value.

Parameters:

request - the WORequest to get the form values from

context - WOContext used to determine component used in

See Also:

WODynamicGroup.takeValuesFromRequest(WORequest, WOContext), handleRequest(WORequest, WOContext)

formValueName

protected String formValueName(WOContext context)

Parameters:

context - WOContext used to determine component used in

Returns:

optional value for formValueName, or calculated value if unbound

id

public String id(WOContext context)

Description copied from class: ERXDynamicElement

Return the value of the id binding if it exists or a safe identifier otherwise.

Overrides:

id in class ERXDynamicElement

Parameters:

context - WOContext used to determine component used in

Returns:

optional value for id, or calculated value if unbound