com.jidesoft.treemap
Class AbstractTreeMapSettings

java.lang.Object
  com.jidesoft.treemap.AbstractTreeMapSettings

All Implemented Interfaces:

TreeMapSettings

Direct Known Subclasses:

DefaultTreeMapSettings

public abstract class AbstractTreeMapSettings
extends Object
implements TreeMapSettings

This class provides a skeletal implementation of the TreeMapSettings interface to minimize the effort required to implement this interface.

Field Summary

Fields inherited from interface com.jidesoft.treemap.TreeMapSettings

PROPERTY_BACKGROUND_FIELD, PROPERTY_COLOR_FIELD, PROPERTY_DEPTH, PROPERTY_DIMENSION, PROPERTY_DIMENSION_FIXED, PROPERTY_GROUP_BY_FIELD, PROPERTY_HEIGHT_FIELD, PROPERTY_HIDE_FILTER_RESULTS, PROPERTY_HIDE_SEARCH_RESULTS, PROPERTY_LABELS_FIELD, PROPERTY_PROBING_COLOR, PROPERTY_RENDERING, PROPERTY_SELECTION_COLOR, PROPERTY_SIZE_FIELD, PROPERTY_TOOLTIP_BACKGROUND

Constructor Summary

protected

AbstractTreeMapSettings()

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.
void	addTreeMapSettingsListener(TreeMapSettingsListener listener) Add a listener for receiving interesting events about changes in the settings.
protected void	firePropertyChange(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties.
protected void	firePropertyChange(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties.
protected void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes for Object properties.
PropertyChangeListener[]	getPropertyChangeListeners() Returns an array of all the property change listeners registered on this component.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName) Returns an array of all the listeners which have been associated with the named property.
protected void	notifySettingsChanged(TreeMapSettingsEvent event)
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list for a specific property.
void	removeTreeMapSettingsListener() Remove all the listener from the list of listeners that should be notified about changes in the settings.
void	removeTreeMapSettingsListener(TreeMapSettingsListener listener) Remove a listener from the list of listeners that should be notified about changes in the settings.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jidesoft.treemap.TreeMapSettings

getAggregation, getAlgorithm, getBackgroundTreeMapField, getBorderColor, getBorderThickness, getColorTreeMapField, getDefaultFieldSettings, getDepth, getDimension, getFieldSettings, getGroupByTreeMapFields, getHeaderBackground, getHeaderEffectColor, getHeaderFont, getHeaderForeground, getHeightTreeMapField, getLabelingEffectColor, getLabelingFont, getLabelingForeground, getLabelsTreeMapFields, getLabelTreeMapFields, getLightSourceAmbient, getLightSourceHeight, getLightSourceX, getLightSourceY, getLightSourceZ, getMaximumHeight, getNesting, getOrdering, getPopupTreeMapFields, getProbingColor, getProgressive, getRendering, getScale, getSelectionColor, getShowPopup, getSizeTreeMapField, getTooltipBackground, getTooltipFont, getTooltipForeground, getValue, isDimensionFixed, isHideFilterResults, isHideSearchResults, resetToDefaults, setAggregation, setAlgorithm, setBackground, setBackgroundByName, setBackgroundTreeMapField, setBorderColor, setBorderThickness, setColor, setColorByName, setColorTreeMapField, setDepth, setDimension, setDimensionFixed, setGroupBy, setGroupByByNames, setGroupByTreeMapFields, setHeaderBackground, setHeaderEffectColor, setHeaderFont, setHeaderForeground, setHeight, setHeightByName, setHeightTreeMapField, setHideFilterResults, setHideSearchResults, setLabelingEffectColor, setLabelingFont, setLabelingForeground, setLabels, setLabelsByNames, setLabelsTreeMapFields, setLightSourceAmbient, setLightSourceHeight, setLightSourceX, setLightSourceY, setLightSourceZ, setMaximumHeight, setNesting, setOrdering, setProbingColor, setProgressive, setRendering, setScale, setSelectionColor, setShowPopup, setSize, setSizeByName, setSizeTreeMapField, setTooltipBackground, setTooltipFont, setTooltipForeground

Constructor Detail

AbstractTreeMapSettings

protected AbstractTreeMapSettings()

Method Detail

addTreeMapSettingsListener

public void addTreeMapSettingsListener(TreeMapSettingsListener listener)

Add a listener for receiving interesting events about changes in the settings.

Specified by:

addTreeMapSettingsListener in interface TreeMapSettings

Parameters:

listener - the listener to add.

removeTreeMapSettingsListener

public void removeTreeMapSettingsListener(TreeMapSettingsListener listener)

Remove a listener from the list of listeners that should be notified about changes in the settings.

Specified by:

removeTreeMapSettingsListener in interface TreeMapSettings

Parameters:

listener - the listener to remove.

removeTreeMapSettingsListener

public void removeTreeMapSettingsListener()

Remove all the listener from the list of listeners that should be notified about changes in the settings.

Specified by:

removeTreeMapSettingsListener in interface TreeMapSettings

notifySettingsChanged

protected void notifySettingsChanged(TreeMapSettingsEvent event)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a PropertyChangeListener to the listener list.

Specified by:

addPropertyChangeListener in interface TreeMapSettings

Parameters:

listener - the PropertyChangeListener to be added

See Also:

removePropertyChangeListener(java.beans.PropertyChangeListener), getPropertyChangeListeners(), addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener from the listener list. This method should be used to remove PropertyChangeListeners that were registered for all bound properties of this class.

If listener is null, no exception is thrown and no action is performed.

Specified by:

removePropertyChangeListener in interface TreeMapSettings

Parameters:

listener - the PropertyChangeListener to be removed

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener), getPropertyChangeListeners(), removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

Returns an array of all the property change listeners registered on this component.

Returns:

all of this component's PropertyChangeListeners or an empty array if no property change listeners are currently registered

Since:

1.4

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener), removePropertyChangeListener(java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String), PropertyChangeSupport.getPropertyChangeListeners()

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Adds a PropertyChangeListener to the listener list for a specific property.

Specified by:

addPropertyChangeListener in interface TreeMapSettings

Parameters:

propertyName - one of the property names listed above

listener - the PropertyChangeListener to be added

See Also:

removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String), addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Removes a PropertyChangeListener from the listener list for a specific property. This method should be used to remove PropertyChangeListeners that were registered for a specific bound property.

If listener is null, no exception is thrown and no action is performed.

Specified by:

removePropertyChangeListener in interface TreeMapSettings

Parameters:

propertyName - a valid property name

listener - the PropertyChangeListener to be removed

See Also:

addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener), getPropertyChangeListeners(java.lang.String), removePropertyChangeListener(java.beans.PropertyChangeListener)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

Returns an array of all the listeners which have been associated with the named property.

Parameters:

propertyName - the property name

Returns:

all of the PropertyChangeListeners associated with the named property or an empty array if no listeners have been added

Since:

1.4

See Also:

addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener), removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener), getPropertyChangeListeners()

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  Object oldValue,
                                  Object newValue)

Support for reporting bound property changes for Object properties. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.

Parameters:

propertyName - the property whose value has changed

oldValue - the property's previous value

newValue - the property's new value

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  boolean oldValue,
                                  boolean newValue)

Support for reporting bound property changes for boolean properties. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.

Parameters:

propertyName - the property whose value has changed

oldValue - the property's previous value

newValue - the property's new value

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  int oldValue,
                                  int newValue)

Support for reporting bound property changes for integer properties. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.

Parameters:

propertyName - the property whose value has changed

oldValue - the property's previous value

newValue - the property's new value