com.ibm.xsp.domino.app.tagcloud
Class TagCloudContent

java.lang.Object
  com.ibm.xsp.domino.app.tagcloud.TagCloudContent

public class TagCloudContent
extends java.lang.Object

Tag Cloud Content object. This class is here to support the creation of well performing TagClouds in Notes/Domino.

Field Summary

static java.lang.String	CSS_BASE_NAME
static ProfilerType	profilerCheck
static ProfilerType	profilerCompute

Constructor Summary

TagCloudContent(com.ibm.domino.xsp.module.nsf.NSFComponentModule module, java.lang.String tcId, java.lang.Object properties)
First constructor.

Method Summary

protected boolean	_needsRefresh()
protected TagCloudContent	_refreshTagCloud()
void	dump()
TagCloudEntry[]	getEntries() Get the list of entries.
java.lang.Object	getRepeatValue()
boolean	isConstructing() Check if the tag cloud is being constructed.
boolean	isRefreshing() Check if the tag cloud is being refreshed.
boolean	isSliderVisible()
boolean	needsRefresh() Check if the tag cloud needs refresh.
void	refresh(TagCloudContainer container, boolean waitForCompletion) Refresh the tag cloud.
boolean	shouldWaitForCompletion() Check if the refresh should wait for the completion.

Methods inherited from class java.lang.Object

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

Field Detail

profilerCheck

public static final ProfilerType profilerCheck

profilerCompute

public static final ProfilerType profilerCompute

CSS_BASE_NAME

public static final java.lang.String CSS_BASE_NAME

See Also:

Constant Field Values

Constructor Detail

TagCloudContent

public TagCloudContent(com.ibm.domino.xsp.module.nsf.NSFComponentModule module,
                       java.lang.String tcId,
                       java.lang.Object properties)

First constructor. This constructor is only called once, the very first time, while the cloud is in "constructing" mode. Then, clones are created when refresh is needed.

Method Detail

dump

public void dump()

isConstructing

public boolean isConstructing()

Check if the tag cloud is being constructed.

isRefreshing

public boolean isRefreshing()

Check if the tag cloud is being refreshed.

getEntries

public TagCloudEntry[] getEntries()

Get the list of entries.

isSliderVisible

public boolean isSliderVisible()

getRepeatValue

public java.lang.Object getRepeatValue()

needsRefresh

public boolean needsRefresh()

Check if the tag cloud needs refresh.

_needsRefresh

protected boolean _needsRefresh()

shouldWaitForCompletion

public boolean shouldWaitForCompletion()

Check if the refresh should wait for the completion.

refresh

public void refresh(TagCloudContainer container,
                    boolean waitForCompletion)

Refresh the tag cloud.

_refreshTagCloud

protected TagCloudContent _refreshTagCloud()
                                    throws com.ibm.domino.napi.NException

Throws:

com.ibm.domino.napi.NException