TreeMapSettings

Overview

Package

Class

Tree

Deprecated

Index

Help

JIDE 3.5.15

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jidesoft.treemap
Interface TreeMapSettings

All Known Implementing Classes:: AbstractTreeMapSettings, DefaultTreeMapSettings

public interface TreeMapSettings

Keep track of all the settings that can be applied to a treemap.

Field Summary
`static String`	`PROPERTY_BACKGROUND_FIELD`
`static String`	`PROPERTY_COLOR_FIELD`
`static String`	`PROPERTY_DEPTH`
`static String`	`PROPERTY_DIMENSION`
`static String`	`PROPERTY_DIMENSION_FIXED`
`static String`	`PROPERTY_GROUP_BY_FIELD`
`static String`	`PROPERTY_HEIGHT_FIELD`
`static String`	`PROPERTY_HIDE_FILTER_RESULTS`
`static String`	`PROPERTY_HIDE_SEARCH_RESULTS`
`static String`	`PROPERTY_LABELS_FIELD`
`static String`	`PROPERTY_PROBING_COLOR`
`static String`	`PROPERTY_RENDERING`
`static String`	`PROPERTY_SELECTION_COLOR`
`static String`	`PROPERTY_SIZE_FIELD`
`static String`	`PROPERTY_TOOLTIP_BACKGROUND`

Method Summary
`void`	`addPropertyChangeListener(PropertyChangeListener listener)`
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)`
`void`	`addTreeMapSettingsListener(TreeMapSettingsListener listener)` Add a listener for receiving interesting events about changes in the settings.
`Aggregation`	`getAggregation()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Algorithm`	`getAlgorithm()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`TreeMapField`	`getBackgroundTreeMapField()` Gets the model used to hold the field used to display the background label.
`Color`	`getBorderColor()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`double`	`getBorderThickness()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`TreeMapField`	`getColorTreeMapField()` Gets the model used to hold the field used to represent the color.
`TreeMapFieldSettings`	`getDefaultFieldSettings()`
`Depth`	`getDepth()` Returns the depth to use to lay out the treemap.
`Dimension`	`getDimension()` Gets the size of the treemap.
`TreeMapFieldSettings`	`getFieldSettings(TreeMapField field)`
`TreeMapField[]`	`getGroupByTreeMapFields()` Gets the model used to hold the list of fields to be use for grouping.
`Color`	`getHeaderBackground()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Color`	`getHeaderEffectColor()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Font`	`getHeaderFont()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Color`	`getHeaderForeground()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`TreeMapField`	`getHeightTreeMapField()` Gets the model used to hold the field used to represent the height.
`Color`	`getLabelingEffectColor()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Font`	`getLabelingFont()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Color`	`getLabelingForeground()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`List<TreeMapField>`	`getLabelsTreeMapFields()` Gets the list of fields to be used for labeling.
`TreeMapField[]`	`getLabelTreeMapFields()` Gets the model used to hold the list of fields to be use for labeling.
`double`	`getLightSourceAmbient()` Returns the light source ambient intensity used for drawing the cushions.
`double`	`getLightSourceHeight()` Returns the light source height used for drawing the cushions.
`double`	`getLightSourceX()` Returns the light source X position used for drawing the cushions.
`double`	`getLightSourceY()` Returns the light source Y position used for drawing the cushions.
`double`	`getLightSourceZ()` Returns the light source Z position used for drawing the cushions.
`double`	`getMaximumHeight()` Gets the maximum height.
`Nesting`	`getNesting()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Ordering`	`getOrdering()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`List<TreeMapField>`	`getPopupTreeMapFields()` Gets the list of fields to be used in the popup.
`Color`	`getProbingColor()` Returns the color to use for drawing the borders.
`TreeMapView.Progressive`	`getProgressive()`
`Rendering`	`getRendering()` Returns the rendering scheme to use to draw the treemap.
`Scale`	`getScale()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Color`	`getSelectionColor()` Returns the color to use for drawing the borders.
`boolean`	`getShowPopup(TreeMapField field)` Tells whether the specified field should be shown in the popup.
`TreeMapField`	`getSizeTreeMapField()` Gets the model used to hold the field used to represent the size.
`Color`	`getTooltipBackground()` Returns the background color to use for drawing the tooltips.
`Font`	`getTooltipFont()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Color`	`getTooltipForeground()` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`Object`	`getValue(String key)` Gets the value of the specified property.
`Boolean`	`isDimensionFixed()`
`Boolean`	`isHideFilterResults()` Gets the model used to indicate whether filtered nodes should be hidden.
`Boolean`	`isHideSearchResults()` Gets the model used to indicate whether nodes that do not match the search criteria should be hidden.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)`
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)`
`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.
`void`	`resetToDefaults()`
`void`	`setAggregation(Aggregation aggregation)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setAlgorithm(Algorithm algorithm)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setBackground(int column)` Defines the field to use for background labeling.
`void`	`setBackgroundByName(String columnName)` Defines the field to use for background labeling.
`void`	`setBackgroundTreeMapField(TreeMapField field)`
`void`	`setBorderColor(Color color)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setBorderThickness(double value)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setColor(int column)` Defines the field to use for coloring.
`void`	`setColorByName(String columnName)` Defines the field to use for coloring.
`void`	`setColorTreeMapField(TreeMapField field)`
`void`	`setDepth(Depth depth)` Defines the depth to use to lay out the treemap.
`void`	`setDimension(Dimension dimension)` Sets the size of the treemap.
`void`	`setDimensionFixed(Boolean fixed)`
`void`	`setGroupBy(int... columns)` Defines the fields to be use for grouping.
`void`	`setGroupByByNames(String... columnNames)` Defines the fields to be use for grouping.
`void`	`setGroupByTreeMapFields(TreeMapField[] fields)`
`void`	`setHeaderBackground(Color color)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setHeaderEffectColor(Color color)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setHeaderFont(Font font)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setHeaderForeground(Color color)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setHeight(int column)` Defines the field to use for mapping the height.
`void`	`setHeightByName(String columnName)` Defines the field to use for mapping the height.
`void`	`setHeightTreeMapField(TreeMapField field)`
`void`	`setHideFilterResults(Boolean hideFilterResults)`
`void`	`setHideSearchResults(Boolean hideSearchResults)`
`void`	`setLabelingEffectColor(Color color)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setLabelingFont(Font font)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setLabelingForeground(Color color)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setLabels(int... columns)` Defines the fields to be use for labeling.
`void`	`setLabelsByNames(String... columnNames)` Defines the fields to be use for labeling.
`void`	`setLabelsTreeMapFields(TreeMapField[] fields)`
`void`	`setLightSourceAmbient(double value)` Sets the light source ambient intensity used for drawing the cushions.
`void`	`setLightSourceHeight(double value)` Sets the light source height used for drawing the cushions.
`void`	`setLightSourceX(double value)` Sets the light source X position used for drawing the cushions.
`void`	`setLightSourceY(double value)` Sets the light source Y position used for drawing the cushions.
`void`	`setLightSourceZ(double value)` Sets the light source Z position used for drawing the cushions.
`void`	`setMaximumHeight(double height)` Sets the maximum height.
`void`	`setNesting(Nesting nesting)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setOrdering(Ordering ordering)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setProbingColor(Color color)` Sets the color to use for drawing the borders.
`void`	`setProgressive(TreeMapView.Progressive progressive)`
`void`	`setRendering(Rendering rendering)` Defines the rendering scheme to use to draw the treemap.
`void`	`setScale(Scale scale)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setSelectionColor(Color color)` Sets the color to use for drawing the borders.
`void`	`setShowPopup(TreeMapField field, boolean show)` Sets whether the specified field should be displayed or no in the popup.
`void`	`setSize(int column)` Defines the field to use to represent the size.
`void`	`setSizeByName(String columnName)` Defines the field to use to represent the size.
`void`	`setSizeTreeMapField(TreeMapField field)`
`void`	`setTooltipBackground(Color color)` Sets the background color to use for drawing the tooltips.
`void`	`setTooltipFont(Font font)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.
`void`	`setTooltipForeground(Color color)` Deprecated. Use getDefaultTreeMapFieldSettings() instead.

Field Detail

PROPERTY_SIZE_FIELD

static final String PROPERTY_SIZE_FIELD

See Also:: Constant Field Values

PROPERTY_COLOR_FIELD

static final String PROPERTY_COLOR_FIELD

See Also:: Constant Field Values

PROPERTY_LABELS_FIELD

static final String PROPERTY_LABELS_FIELD

See Also:: Constant Field Values

PROPERTY_BACKGROUND_FIELD

static final String PROPERTY_BACKGROUND_FIELD

See Also:: Constant Field Values

PROPERTY_HEIGHT_FIELD

static final String PROPERTY_HEIGHT_FIELD

See Also:: Constant Field Values

PROPERTY_GROUP_BY_FIELD

static final String PROPERTY_GROUP_BY_FIELD

See Also:: Constant Field Values

PROPERTY_DEPTH

static final String PROPERTY_DEPTH

See Also:: Constant Field Values

PROPERTY_RENDERING

static final String PROPERTY_RENDERING

See Also:: Constant Field Values

PROPERTY_TOOLTIP_BACKGROUND

static final String PROPERTY_TOOLTIP_BACKGROUND

See Also:: Constant Field Values

PROPERTY_PROBING_COLOR

static final String PROPERTY_PROBING_COLOR

See Also:: Constant Field Values

PROPERTY_SELECTION_COLOR

static final String PROPERTY_SELECTION_COLOR

See Also:: Constant Field Values

PROPERTY_HIDE_SEARCH_RESULTS

static final String PROPERTY_HIDE_SEARCH_RESULTS

See Also:: Constant Field Values

PROPERTY_HIDE_FILTER_RESULTS

static final String PROPERTY_HIDE_FILTER_RESULTS

See Also:: Constant Field Values

PROPERTY_DIMENSION

static final String PROPERTY_DIMENSION

See Also:: Constant Field Values

PROPERTY_DIMENSION_FIXED

static final String PROPERTY_DIMENSION_FIXED

See Also:: Constant Field Values

Method Detail

isDimensionFixed

Boolean isDimensionFixed()

setDimensionFixed

void setDimensionFixed(Boolean fixed)

getDimension

Dimension getDimension()

Gets the size of the treemap.

Returns:: the size of the treemap.

setDimension

void setDimension(Dimension dimension)

Sets the size of the treemap.

Parameters:: dimension - the size of the treemap.

getProgressive

TreeMapView.Progressive getProgressive()

setProgressive

void setProgressive(TreeMapView.Progressive progressive)

getGroupByTreeMapFields

TreeMapField[] getGroupByTreeMapFields()

Gets the model used to hold the list of fields to be use for grouping.

Returns:: the model of fields to be use for grouping

setGroupByTreeMapFields

void setGroupByTreeMapFields(TreeMapField[] fields)

getSizeTreeMapField

TreeMapField getSizeTreeMapField()

Gets the model used to hold the field used to represent the size.

Returns:: the model holding the field that represent the size.

getColorTreeMapField

TreeMapField getColorTreeMapField()

Gets the model used to hold the field used to represent the color.

Returns:: the model holding the field that represent the color.

getLabelTreeMapFields

TreeMapField[] getLabelTreeMapFields()

Gets the model used to hold the list of fields to be use for labeling.

Returns:: the model of fields to be use for labeling.

getBackgroundTreeMapField

TreeMapField getBackgroundTreeMapField()

Gets the model used to hold the field used to display the background label.

Returns:: the model holding the field of the the background label.

getHeightTreeMapField

TreeMapField getHeightTreeMapField()

Gets the model used to hold the field used to represent the height.

Returns:: the model holding the field that represent the height.

isHideFilterResults

Boolean isHideFilterResults()

Gets the model used to indicate whether filtered nodes should be hidden.

Returns:: the model indicating whether filtered nodes should be hidden.

setHideFilterResults

void setHideFilterResults(Boolean hideFilterResults)

isHideSearchResults

Boolean isHideSearchResults()

Gets the model used to indicate whether nodes that do not match the search criteria should be hidden.

Returns:: the model indicating whether nodes that do not match the search criteria should be hidden.

setHideSearchResults

void setHideSearchResults(Boolean hideSearchResults)

getMaximumHeight

double getMaximumHeight()

Gets the maximum height.

Returns:: the maximum height.

setMaximumHeight

void setMaximumHeight(double height)

Sets the maximum height.

Parameters:: height - the maximum height.

setGroupBy

void setGroupBy(int... columns)

Defines the fields to be use for grouping.

Parameters:: columns - the indexes of the columns to be used for grouping
See Also:: DefaultTreeMapSettings.getGroupByTreeMapFields()

setGroupByByNames

void setGroupByByNames(String... columnNames)

Defines the fields to be use for grouping.

Parameters:: columnNames - the names of the columns to be used for grouping
See Also:: DefaultTreeMapSettings.getGroupByTreeMapFields()

setLabels

void setLabels(int... columns)

Defines the fields to be use for labeling.

Parameters:: columns - the indexes of the columns to be used for labeling
See Also:: DefaultTreeMapSettings.getLabelTreeMapFields()

setLabelsByNames

void setLabelsByNames(String... columnNames)

Defines the fields to be use for labeling.

Parameters:: columnNames - the names of the columns to be used for labeling
See Also:: DefaultTreeMapSettings.getLabelTreeMapFields()

getLabelsTreeMapFields

List<TreeMapField> getLabelsTreeMapFields()

Gets the list of fields to be used for labeling.

Returns:: the list of fields.

setLabelsTreeMapFields

void setLabelsTreeMapFields(TreeMapField[] fields)

setBackground

void setBackground(int column)

Defines the field to use for background labeling.

Parameters:: column - the index of the column to be used for background labeling
See Also:: DefaultTreeMapSettings.getBackgroundTreeMapField()

setBackgroundByName

void setBackgroundByName(String columnName)

Defines the field to use for background labeling.

Parameters:: columnName - the name of the column to be used for background labeling
See Also:: DefaultTreeMapSettings.getBackgroundTreeMapField()

setSize

void setSize(int column)

Defines the field to use to represent the size.

Parameters:: column - the index of the column to be used for representing the size
See Also:: DefaultTreeMapSettings.getSizeTreeMapField()

setSizeByName

void setSizeByName(String columnName)

Defines the field to use to represent the size.

Parameters:: columnName - the name of the column to be used for representing the size
See Also:: DefaultTreeMapSettings.getSizeTreeMapField()

setColor

void setColor(int column)

Defines the field to use for coloring.

Parameters:: column - the index of the column to be used for coloring
See Also:: DefaultTreeMapSettings.getColorTreeMapField()

setColorByName

void setColorByName(String columnName)

Defines the field to use for coloring.

Parameters:: columnName - the name of the column to be used for coloring
See Also:: DefaultTreeMapSettings.getColorTreeMapField()

setHeight

void setHeight(int column)

Defines the field to use for mapping the height.

Parameters:: column - the index of the column to be used for mapping the height
See Also:: DefaultTreeMapSettings.getHeightTreeMapField()

setHeightByName

void setHeightByName(String columnName)

Defines the field to use for mapping the height.

Parameters:: columnName - the name of the column to be used for mapping the height
See Also:: DefaultTreeMapSettings.getHeightTreeMapField()

setHeightTreeMapField

void setHeightTreeMapField(TreeMapField field)

setColorTreeMapField

void setColorTreeMapField(TreeMapField field)

setSizeTreeMapField

void setSizeTreeMapField(TreeMapField field)

setBackgroundTreeMapField

void setBackgroundTreeMapField(TreeMapField field)

getDepth

Depth getDepth()

Returns the depth to use to lay out the treemap.

Returns:: the depth to use
See Also:: DefaultTreeMapSettings.getDepth(), DepthFactory

setDepth

void setDepth(Depth depth)

Defines the depth to use to lay out the treemap.

Parameters:: depth - the depth to use
See Also:: DefaultTreeMapSettings.getDepth(), DepthFactory

getRendering

Rendering getRendering()

Returns the rendering scheme to use to draw the treemap.

Returns:: the rendering scheme to use
See Also:: DefaultTreeMapSettings.getRendering(), RenderingFactory

setRendering

void setRendering(Rendering rendering)

Defines the rendering scheme to use to draw the treemap.

Parameters:: rendering - the rendering scheme to use
See Also:: DefaultTreeMapSettings.getRendering(), RenderingFactory

getLightSourceHeight

double getLightSourceHeight()

Returns the light source height used for drawing the cushions.

Returns:: the height
See Also:: DefaultTreeMapSettings.getLightSourceHeight()

setLightSourceHeight

void setLightSourceHeight(double value)

Sets the light source height used for drawing the cushions.

Parameters:: value - the height
See Also:: DefaultTreeMapSettings.getLightSourceHeight()

getLightSourceAmbient

double getLightSourceAmbient()

Returns the light source ambient intensity used for drawing the cushions.

Returns:: the ambient intensity
See Also:: DefaultTreeMapSettings.getLightSourceAmbient()

setLightSourceAmbient

void setLightSourceAmbient(double value)

Sets the light source ambient intensity used for drawing the cushions.

Parameters:: value - the ambient intensity
See Also:: DefaultTreeMapSettings.getLightSourceAmbient()

getLightSourceX

double getLightSourceX()

Returns the light source X position used for drawing the cushions.

Returns:: the X position
See Also:: DefaultTreeMapSettings.getLightSourceX()

setLightSourceX

void setLightSourceX(double value)

Sets the light source X position used for drawing the cushions.

Parameters:: value - the X position
See Also:: DefaultTreeMapSettings.getLightSourceX()

getLightSourceY

double getLightSourceY()

Returns the light source Y position used for drawing the cushions.

Returns:: the Y position
See Also:: DefaultTreeMapSettings.getLightSourceY()

setLightSourceY

void setLightSourceY(double value)

Sets the light source Y position used for drawing the cushions.

Parameters:: value - the Y position
See Also:: DefaultTreeMapSettings.getLightSourceY()

getLightSourceZ

double getLightSourceZ()

Returns the light source Z position used for drawing the cushions.

Returns:: the Z position
See Also:: DefaultTreeMapSettings.getLightSourceZ()

setLightSourceZ

void setLightSourceZ(double value)

Sets the light source Z position used for drawing the cushions.

Parameters:: value - the Z position
See Also:: DefaultTreeMapSettings.getLightSourceZ()

getTooltipBackground

Color getTooltipBackground()

Returns the background color to use for drawing the tooltips.

Returns:: the color to be used
See Also:: DefaultTreeMapSettings.getTooltipBackground()

setTooltipBackground

void setTooltipBackground(Color color)

Sets the background color to use for drawing the tooltips.

Parameters:: color - the color to be used
See Also:: DefaultTreeMapSettings.getTooltipBackground()

getProbingColor

Color getProbingColor()

Returns the color to use for drawing the borders.

Returns:: the color to be used
See Also:: DefaultTreeMapSettings.getProbingColor()

setProbingColor

void setProbingColor(Color color)

Sets the color to use for drawing the borders.

Parameters:: color - the color to be used
See Also:: DefaultTreeMapSettings.getProbingColor()

getSelectionColor

Color getSelectionColor()

Returns the color to use for drawing the borders.

Returns:: the color to be used
See Also:: DefaultTreeMapSettings.getSelectionColor()

setSelectionColor

void setSelectionColor(Color color)

Sets the color to use for drawing the borders.

Parameters:: color - the color to be used
See Also:: DefaultTreeMapSettings.getSelectionColor()

getPopupTreeMapFields

List<TreeMapField> getPopupTreeMapFields()

Gets the list of fields to be used in the popup.

Returns:: the list of fields.

getShowPopup

boolean getShowPopup(TreeMapField field)

Tells whether the specified field should be shown in the popup.

Parameters:: field - the field.
Returns:: true if it should be displayed, false otherwise.

setShowPopup

void setShowPopup(TreeMapField field,
                  boolean show)

Sets whether the specified field should be displayed or no in the popup.

Parameters:: field - the field.; show - true if it should be displayed, false otherwise.

getValue

Object getValue(String key)

Gets the value of the specified property.

Parameters:: key - the property name
Returns:: the value

addTreeMapSettingsListener

void addTreeMapSettingsListener(TreeMapSettingsListener listener)

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

Parameters:: listener - the listener to add.

removeTreeMapSettingsListener

void removeTreeMapSettingsListener(TreeMapSettingsListener listener)

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

Parameters:: listener - the listener to remove.

removeTreeMapSettingsListener

void removeTreeMapSettingsListener()

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

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                  PropertyChangeListener listener)

getDefaultFieldSettings

TreeMapFieldSettings getDefaultFieldSettings()

getFieldSettings

TreeMapFieldSettings getFieldSettings(TreeMapField field)