edu.wright.hendrix11.d3.wordCloud

Class WordCloudComponent

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

edu.wright.hendrix11.d3.MasterComponent

edu.wright.hendrix11.d3.wordCloud.WordCloudComponent

All Implemented Interfaces:

EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class WordCloudComponent
extends MasterComponent

Author:

Joe Hendrix

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, 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
WordCloudComponent()

Method Summary

Modifier and Type	Method and Description
String	getFamily()
String	getFont() Returns the font face for each word.
Integer	getHeight() Returns the height of the entire cloud.
Integer	getPadding() Returns the numerical padding for each word / String.
Integer	getScaleTo() Returns the number that the dataset will be scaled to, from 0 to this number.
Integer	getWidth() Returns the width of the entire cloud.
Map<String,Integer>	getWords() Returns the map of words (or rather, Strings, as they can have spaces) to the font size of that word.
Boolean	isForceStretch() Returns whether to scale the dataset when the largest value is less than the return value of getScaleTo().
void	setFont(String font) Sets the font face for each word.
void	setForceStretch(Boolean forceStretch) Sets whether to scale the dataset when the largest value is less than the return value of getScaleTo().
void	setHeight(Integer height) Sets the height of the entire cloud.
void	setPadding(Integer padding) Sets the numerical padding for each word / String.
void	setScaleTo(Integer scaleTo) Sets the number that the dataset will be scaled to, from 0 to this number.
void	setWidth(Integer width) Sets the width of the entire cloud.
void	setWords(Map<String,Integer> words) Sets the map of words (or rather, Strings, as they can have spaces) to the font size of that word.

Methods inherited from class edu.wright.hendrix11.d3.MasterComponent

getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, restoreState, saveAttachedState, saveState, 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, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

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

Constructor Detail

WordCloudComponent

public WordCloudComponent()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

getWidth

public Integer getWidth()

Returns the width of the entire cloud.

Returns:

the width of the entire cloud

setWidth

public void setWidth(Integer width)

Sets the width of the entire cloud.

Parameters:

width - the width of the entire cloud

getHeight

public Integer getHeight()

Returns the height of the entire cloud.

Returns:

the height of the entire cloud

setHeight

public void setHeight(Integer height)

Sets the height of the entire cloud.

Parameters:

height - the height of the entire cloud

getPadding

public Integer getPadding()

Returns the numerical padding for each word / String.

Returns:

the numerical padding for each word / String

setPadding

public void setPadding(Integer padding)

Sets the numerical padding for each word / String.

Parameters:

padding - the numerical padding for each word / String

getFont

public String getFont()

Returns the font face for each word.

Returns:

the font face for each word

setFont

public void setFont(String font)

Sets the font face for each word.

Parameters:

font - the font face for each word

getWords

public Map<String,Integer> getWords()

Returns the map of words (or rather, Strings, as they can have spaces) to the font size of that word. Typcially the size will be the number of occurences, but that is not a requirement.

Returns:

the map of words to the font size of that word

setWords

public void setWords(Map<String,Integer> words)

Sets the map of words (or rather, Strings, as they can have spaces) to the font size of that word. Typcially the size will be the number of occurences, but that is not a requirement.

Parameters:

words - the map of words to the font size of that word

getScaleTo

public Integer getScaleTo()

Returns the number that the dataset will be scaled to, from 0 to this number.

Returns:

the number that the dataset will be scaled to, from 0 to this number.

See Also:

isForceStretch()

setScaleTo

public void setScaleTo(Integer scaleTo)

Sets the number that the dataset will be scaled to, from 0 to this number.

Parameters:

scaleTo - the number that the dataset will be scaled to

See Also:

setForceStretch(java.lang.Boolean)

setForceStretch

public void setForceStretch(Boolean forceStretch)

Sets whether to scale the dataset when the largest value is less than the return value of getScaleTo().

If set to true and scaleTo is defined, then if the largest value is less than scaleTo, the dataset will be scaled. Otherwise, if scaling will only occur if the largest value is larger than scaleTo.

Parameters:

forceStretch - whether to scale the dataset when the largest value is not large enough

See Also:

getScaleTo()

isForceStretch

public Boolean isForceStretch()

Returns whether to scale the dataset when the largest value is less than the return value of getScaleTo().

If set to true and scaleTo is defined, then if the largest value is less than scaleTo, the dataset will be scaled. Otherwise, if scaling will only occur if the largest value is larger than scaleTo.

Returns:

whether to scale the dataset when the largest value is not large enough

See Also:

getScaleTo()