netcharts.pro.common
Class NFDwell

java.lang.Object
  |
  +--netcharts.pro.common.NFBaseClass
        |
        +--netcharts.pro.common.NFDwell

All Implemented Interfaces:

java.lang.Cloneable

public class NFDwell

extends NFBaseClass

The NFDwell property describes the appearance of popup labels on a chart,to include the text and the background region. See NFActiveLabel for details on popup labels.

Constructor Summary

NFDwell()
Constructs a default dwell object

NFDwell(java.util.Hashtable state)
Constructs a dwell object using CDL parameters

NFDwell(NFModalLabel label, NFRegion region)
Constructs a dwell object using the given NFModalLabel text object and background NFRegion object.

Method Summary

java.lang.Object	clone() Clone this dwell object.
java.util.Vector	getCDLVector() NFDwell is a compound object representing multiple CDL parameters.
boolean	getDwellEnabled() Returns the state of dwell (popup) chart functionality.
NFModalLabel	getLabel() Return dwell label
NFRegion	getRegion() Return dwell region
void	setDwellEnabled(boolean enabled) Enables or disables the dwell (popup) chart functionality.
void	setLabel(NFModalLabel label) Set label for this dwell object
void	setRegion(NFRegion region) Set region for this dwell object.

Methods inherited from class netcharts.pro.common.NFBaseClass

getModified, getUserObject, setModified, setUserObject

Methods inherited from class java.lang.Object

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

Constructor Detail

NFDwell

public NFDwell()

Constructs a default dwell object

NFDwell

public NFDwell(NFModalLabel label,
               NFRegion region)

Constructs a dwell object using the given NFModalLabel text object and background NFRegion object.

Parameters:

label - The label object containing the state and text style.

region - The region object describing the title background.

NFDwell

public NFDwell(java.util.Hashtable state)

Constructs a dwell object using CDL parameters

Parameters:

state - Hashtable containing CDL parameters. particular title (e.g. LeftTitle)

Method Detail

setDwellEnabled

public void setDwellEnabled(boolean enabled)

Enables or disables the dwell (popup) chart functionality.

Parameters:

enabled. - If true, dwell popups will be available.

getDwellEnabled

public boolean getDwellEnabled()

Returns the state of dwell (popup) chart functionality.

Returns:

enabled. If true, dwell popups will be available.

setLabel

public void setLabel(NFModalLabel label)

Set label for this dwell object

Parameters:

label - NFModalLabel object.

getLabel

public NFModalLabel getLabel()

Return dwell label

Returns:

label or null if not set

setRegion

public void setRegion(NFRegion region)

Set region for this dwell object.

Parameters:

region -

getRegion

public NFRegion getRegion()

Return dwell region

Returns:

region or null if not set

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone this dwell object. Performs a deep copy of this object.

Overrides:

clone in class NFBaseClass

Returns:

copy of this object

getCDLVector

public java.util.Vector getCDLVector()

NFDwell is a compound object representing multiple CDL parameters. This method returns a vector containing CDL representations for all attributes described in this NFDwell

Returns:

Vector of NFKeyValue objects