er.taggable.components
Class ERTagCloud

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          er.extensions.components.ERXComponent
              er.taggable.components.ERTagCloud

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, java.io.Serializable, java.lang.Cloneable

public class ERTagCloud
extends ERXComponent

ERTagCloud provides a simple tag cloud view. The contents of this component will be used as the renderer for each tag. You can use the example css file ERTagCloud.css for default styling. By default the class names will be "tagCloud1", "tagCloud2", etc. As an example: <wo:ERTagCloud entityName = "InventoryItem" tag = "$tag" tagClass = "$tagClass"> <wo:WOGenericContainer elementName = "span" class = "$tagClass"><wo:str value = "$tag"/></wo:WOGenericContainer> </wo:ERTagCloud>

See Also:

Serialized Form

Author:

mschrag

Bindings

tag	the name of the current tag being rendered
tagClass	the class name of the current tag
entityName	the name of the entity to load tags for
limit	the maximum number of tags to show
minimum	the minimum tag count required for a tag to be shown
categories	the tag category names to use (NSArray of Strings)
categoryCount	the number of categories to split into (default 5)
tagClassPrefix	the prefix to prepend to the tag cloud class name ("tagCloud" by default)
cache	if false, the computation of the tag cloud is not cached (this is EXPENSIVE)
additionalQualifier	an optional restricting qualifier
shouldResetTagCloud	forces recalculation of the tag cloud when the binding evaluates to true. After recalculation, the binding will be set to false again.

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.Null, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

ERTagCloud(com.webobjects.appserver.WOContext context)

Method Summary

com.webobjects.eocontrol.EOQualifier	additionalQualifier()
com.webobjects.foundation.NSArray<java.lang.String>	categories()
int	categoryCount()
java.lang.String	entityName()
int	limit()
int	minimum()
protected void	preAppendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Override to hook into appendToResponse after security checks but before the super.appendToResponse.
java.lang.String	repetitionTag()
void	setRepetitionTag(java.lang.String repetitionTag)
boolean	synchronizesVariablesWithBindings()
java.lang.String	tagClass()
java.lang.String	tagClassPrefix()
com.webobjects.foundation.NSDictionary<java.lang.String,java.lang.String>	tagCloud()
com.webobjects.foundation.NSArray<java.lang.String>	tagNames()

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, appendToResponse, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, invokeAction, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, primaryCSSFile, primaryJavascriptFile, reset, stringValueForBinding, stringValueForBinding, takeValuesFromRequest, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

_associationWithName, _childTemplate, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Constructor Detail

ERTagCloud

public ERTagCloud(com.webobjects.appserver.WOContext context)

Method Detail

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overrides:

synchronizesVariablesWithBindings in class com.webobjects.appserver.WOComponent

tagNames

public com.webobjects.foundation.NSArray<java.lang.String> tagNames()

entityName

public java.lang.String entityName()

setRepetitionTag

public void setRepetitionTag(java.lang.String repetitionTag)

repetitionTag

public java.lang.String repetitionTag()

tagClass

public java.lang.String tagClass()

minimum

public int minimum()

limit

public int limit()

categoryCount

public int categoryCount()

additionalQualifier

public com.webobjects.eocontrol.EOQualifier additionalQualifier()

categories

public com.webobjects.foundation.NSArray<java.lang.String> categories()

tagClassPrefix

public java.lang.String tagClassPrefix()

tagCloud

public com.webobjects.foundation.NSDictionary<java.lang.String,java.lang.String> tagCloud()

preAppendToResponse

protected void preAppendToResponse(com.webobjects.appserver.WOResponse response,
                                   com.webobjects.appserver.WOContext context)

Description copied from class: ERXComponent

Override to hook into appendToResponse after security checks but before the super.appendToResponse. It is not necessary to call super on this method.

Overrides:

preAppendToResponse in class ERXComponent

Parameters:

response - the current response

context - the current context