com.jidesoft.treemap
Interface TreeMapFieldSettings

All Known Implementing Classes:

AbstractTreeMapFieldSettings, DefaultTreeMapFieldSettings, OverridingTreeMapFieldSettings

public interface TreeMapFieldSettings

Field Summary

static String	PROPERTY_AGGREGATION
static String	PROPERTY_ALGORITHM
static String	PROPERTY_BORDER_COLOR
static String	PROPERTY_BORDER_THICKNESS
static String	PROPERTY_COLORMAP
static String	PROPERTY_FORMAT
static String	PROPERTY_HEADER_BACKGROUND
static String	PROPERTY_HEADER_EFFECT
static String	PROPERTY_HEADER_EFFECT_COLOR
static String	PROPERTY_HEADER_EFFECTOPACITY
static String	PROPERTY_HEADER_FONT
static String	PROPERTY_HEADER_FOREGROUND
static String	PROPERTY_HEADER_HORIZONTALALIGNMENT
static String	PROPERTY_HEADER_MINIMUMCHARACTERSTODISPLAY
static String	PROPERTY_HEADER_RENDERING
static String	PROPERTY_HEADER_VERTICALALIGNMENT
static String	PROPERTY_LABELING
static String	PROPERTY_LABELING_EFFECT
static String	PROPERTY_LABELING_EFFECT_COLOR
static String	PROPERTY_LABELING_EFFECTOPACITY
static String	PROPERTY_LABELING_FONT
static String	PROPERTY_LABELING_FOREGROUND
static String	PROPERTY_LABELING_HORIZONTALALIGNMENT
static String	PROPERTY_LABELING_MINIMUMCHARACTERSTODISPLAY
static String	PROPERTY_LABELING_RENDERING
static String	PROPERTY_LABELING_VERTICALALIGNMENT
static String	PROPERTY_NESTING
static String	PROPERTY_ORDERING
static String	PROPERTY_SCALE
static String	PROPERTY_TOOLTIP_FONT
static String	PROPERTY_TOOLTIP_FOREGROUND
static String	PROPERTY_TOOLTIP_RENDERING
static String	PROPERTY_TOOLTIP_SHOWLABEL

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Aggregation	getAggregation() Returns the aggregation scheme to use to aggregate values of the treemap.
Algorithm	getAlgorithm() Returns the algorithm to use to lay out the treemap.
Color	getBorderColor() Returns the color to use for drawing the borders.
double	getBorderThickness() Returns the thickness used for drawing the borders.
MutableColorMap	getColorMap() Gets the color map for the specified column.
Format	getFormat() Gets the format used to display values of the specified column.
Color	getHeaderBackground() Returns the background color to use for drawing the headers.
EnhancedJLabel.Effect	getHeaderEffect()
Color	getHeaderEffectColor() Returns the effect color to use for drawing the headers.
Float	getHeaderEffectOpacity()
Font	getHeaderFont() Returns the font used for labeling the headings.
Color	getHeaderForeground() Returns the foreground color to use for drawing the headers.
Integer	getHeaderHorizontalAlignment()
Integer	getHeaderMinimumCharactersToDisplay()
EnhancedJLabel.Rendering	getHeaderRendering()
Integer	getHeaderVerticalAlignment()
Labeling	getLabeling() Returns the labeling scheme to use to draw the treemap.
EnhancedJLabel.Effect	getLabelingEffect()
Color	getLabelingEffectColor() Returns the effect color to use for drawing the labels.
Float	getLabelingEffectOpacity()
Font	getLabelingFont() Returns the font used for labeling.
Color	getLabelingForeground() Returns the foreground color to use for drawing the labels.
Integer	getLabelingHorizontalAlignment()
Integer	getLabelingMinimumCharactersToDisplay()
EnhancedJLabel.Rendering	getLabelingRendering()
Integer	getLabelingVerticalAlignment()
Nesting	getNesting() Returns the nesting to use to lay out the treemap.
Ordering	getOrdering() Returns the ordering to use to lay out the treemap.
Scale	getScale() Returns the scaling scheme to use to project values the treemap.
boolean	getShowTooltipLabel() Tells whether the label of the specified field should be shown in the popup.
Font	getTooltipFont() Returns the font used for labeling the tooltips.
Color	getTooltipForeground() Returns the foreground color to use for drawing the tooltips.
EnhancedJLabel.Rendering	getTooltipRendering()
Object	getValue(String key) Gets the value of the specified property.
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	setAggregation(Aggregation aggregation) Defines the aggregation scheme to use to aggregate values of the treemap.
void	setAlgorithm(Algorithm algorithm) Defines the algorithm to use to lay out the treemap.
void	setBorderColor(Color color) Sets the color to use for drawing the borders.
void	setBorderThickness(double value) Sets the thickness used for drawing the borders.
void	setColorMap(MutableColorMap colorMap) Sets the color map to use for the specified column.
void	setFormat(Format format) Sets the format used to display values of the specified column.
void	setHeaderBackground(Color color) Sets the background color to use for drawing the headers.
void	setHeaderEffect(EnhancedJLabel.Effect effect)
void	setHeaderEffectColor(Color color) Sets the background color to use for drawing the headers.
void	setHeaderEffectOpacity(Float opacity)
void	setHeaderFont(Font font) Sets the font used for labeling the headings.
void	setHeaderForeground(Color color) Sets the foreground color to use for drawing the headers.
void	setHeaderHorizontalAlignment(Integer alignment)
void	setHeaderMinimumCharactersToDisplay(Integer minimumCharactersToDisplay)
void	setHeaderRendering(EnhancedJLabel.Rendering rendering)
void	setHeaderVerticalAlignment(Integer alignment)
void	setLabeling(Labeling labeling) Defines the labeling scheme to use to draw the treemap.
void	setLabelingEffect(EnhancedJLabel.Effect effect)
void	setLabelingEffectColor(Color color) Sets the effect color to use for drawing the labels.
void	setLabelingEffectOpacity(Float opacity)
void	setLabelingFont(Font font) Sets the font used for labeling.
void	setLabelingForeground(Color color) Sets the foreground color to use for drawing the labels.
void	setLabelingHorizontalAlignment(Integer alignment)
void	setLabelingMinimumCharactersToDisplay(Integer minimumCharactersToDisplay)
void	setLabelingRendering(EnhancedJLabel.Rendering rendering)
void	setLabelingVerticalAlignment(Integer alignment)
void	setNesting(Nesting nesting) Defines the nesting to use to lay out the treemap.
void	setOrdering(Ordering ordering) Defines the ordering to use to lay out the treemap.
void	setScale(Scale scale) Defines the scaling scheme to use to project values the treemap.
void	setShowTooltipLabel(boolean show) Sets whether the label of the specified field should be displayed or no in the popup.
void	setTooltipFont(Font font) Sets the font used for labeling the tooltips.
void	setTooltipForeground(Color color) Sets the foreground color to use for drawing the tooltips.
void	setTooltipRendering(EnhancedJLabel.Rendering rendering)

Field Detail

PROPERTY_ALGORITHM

static final String PROPERTY_ALGORITHM

See Also:

Constant Field Values

PROPERTY_AGGREGATION

static final String PROPERTY_AGGREGATION

See Also:

Constant Field Values

PROPERTY_SCALE

static final String PROPERTY_SCALE

See Also:

Constant Field Values

PROPERTY_NESTING

static final String PROPERTY_NESTING

See Also:

Constant Field Values

PROPERTY_ORDERING

static final String PROPERTY_ORDERING

See Also:

Constant Field Values

PROPERTY_LABELING

static final String PROPERTY_LABELING

See Also:

Constant Field Values

PROPERTY_LABELING_FOREGROUND

static final String PROPERTY_LABELING_FOREGROUND

See Also:

Constant Field Values

PROPERTY_LABELING_EFFECT_COLOR

static final String PROPERTY_LABELING_EFFECT_COLOR

See Also:

Constant Field Values

PROPERTY_LABELING_FONT

static final String PROPERTY_LABELING_FONT

See Also:

Constant Field Values

PROPERTY_LABELING_EFFECT

static final String PROPERTY_LABELING_EFFECT

See Also:

Constant Field Values

PROPERTY_LABELING_HORIZONTALALIGNMENT

static final String PROPERTY_LABELING_HORIZONTALALIGNMENT

See Also:

Constant Field Values

PROPERTY_LABELING_VERTICALALIGNMENT

static final String PROPERTY_LABELING_VERTICALALIGNMENT

See Also:

Constant Field Values

PROPERTY_LABELING_RENDERING

static final String PROPERTY_LABELING_RENDERING

See Also:

Constant Field Values

PROPERTY_LABELING_MINIMUMCHARACTERSTODISPLAY

static final String PROPERTY_LABELING_MINIMUMCHARACTERSTODISPLAY

See Also:

Constant Field Values

PROPERTY_LABELING_EFFECTOPACITY

static final String PROPERTY_LABELING_EFFECTOPACITY

See Also:

Constant Field Values

PROPERTY_HEADER_FOREGROUND

static final String PROPERTY_HEADER_FOREGROUND

See Also:

Constant Field Values

PROPERTY_HEADER_EFFECT_COLOR

static final String PROPERTY_HEADER_EFFECT_COLOR

See Also:

Constant Field Values

PROPERTY_HEADER_BACKGROUND

static final String PROPERTY_HEADER_BACKGROUND

See Also:

Constant Field Values

PROPERTY_HEADER_FONT

static final String PROPERTY_HEADER_FONT

See Also:

Constant Field Values

PROPERTY_HEADER_EFFECT

static final String PROPERTY_HEADER_EFFECT

See Also:

Constant Field Values

PROPERTY_HEADER_HORIZONTALALIGNMENT

static final String PROPERTY_HEADER_HORIZONTALALIGNMENT

See Also:

Constant Field Values

PROPERTY_HEADER_VERTICALALIGNMENT

static final String PROPERTY_HEADER_VERTICALALIGNMENT

See Also:

Constant Field Values

PROPERTY_HEADER_RENDERING

static final String PROPERTY_HEADER_RENDERING

See Also:

Constant Field Values

PROPERTY_HEADER_MINIMUMCHARACTERSTODISPLAY

static final String PROPERTY_HEADER_MINIMUMCHARACTERSTODISPLAY

See Also:

Constant Field Values

PROPERTY_HEADER_EFFECTOPACITY

static final String PROPERTY_HEADER_EFFECTOPACITY

See Also:

Constant Field Values

PROPERTY_TOOLTIP_FOREGROUND

static final String PROPERTY_TOOLTIP_FOREGROUND

See Also:

Constant Field Values

PROPERTY_TOOLTIP_FONT

static final String PROPERTY_TOOLTIP_FONT

See Also:

Constant Field Values

PROPERTY_TOOLTIP_RENDERING

static final String PROPERTY_TOOLTIP_RENDERING

See Also:

Constant Field Values

PROPERTY_BORDER_COLOR

static final String PROPERTY_BORDER_COLOR

See Also:

Constant Field Values

PROPERTY_BORDER_THICKNESS

static final String PROPERTY_BORDER_THICKNESS

See Also:

Constant Field Values

PROPERTY_FORMAT

static final String PROPERTY_FORMAT

See Also:

Constant Field Values

PROPERTY_TOOLTIP_SHOWLABEL

static final String PROPERTY_TOOLTIP_SHOWLABEL

See Also:

Constant Field Values

PROPERTY_COLORMAP

static final String PROPERTY_COLORMAP

See Also:

Constant Field Values

Method Detail

getAlgorithm

Algorithm getAlgorithm()

Returns the algorithm to use to lay out the treemap.

Returns:

the algorithm to use

See Also:

DefaultTreeMapSettings.getAlgorithm(), AlgorithmFactory

setAlgorithm

void setAlgorithm(Algorithm algorithm)

Defines the algorithm to use to lay out the treemap.

Parameters:

algorithm - the algorithm to use

See Also:

DefaultTreeMapSettings.getAlgorithm(), AlgorithmFactory

getAggregation

Aggregation getAggregation()

Returns the aggregation scheme to use to aggregate values of the treemap.

Returns:

athe aggregation scheme to use

See Also:

DefaultTreeMapSettings.getAggregation(), AggregationFactory

setAggregation

void setAggregation(Aggregation aggregation)

Defines the aggregation scheme to use to aggregate values of the treemap.

Parameters:

aggregation - the aggregation scheme to use

See Also:

DefaultTreeMapSettings.getAggregation(), AggregationFactory

getScale

Scale getScale()

Returns the scaling scheme to use to project values the treemap.

Returns:

the scale scheme to use

See Also:

DefaultTreeMapSettings.getScale(), ScaleFactory

setScale

void setScale(Scale scale)

Defines the scaling scheme to use to project values the treemap.

Parameters:

scale - the scale scheme to use

See Also:

DefaultTreeMapSettings.getScale(), ScaleFactory

getNesting

Nesting getNesting()

Returns the nesting to use to lay out the treemap.

Returns:

the nesting scheme to use

See Also:

DefaultTreeMapSettings.getNesting(), NestingFactory

setNesting

void setNesting(Nesting nesting)

Defines the nesting to use to lay out the treemap.

Parameters:

nesting - the nesting scheme to use

See Also:

DefaultTreeMapSettings.getNesting(), NestingFactory

getOrdering

Ordering getOrdering()

Returns the ordering to use to lay out the treemap.

Returns:

the ordering to use

See Also:

DefaultTreeMapSettings.getOrdering(), OrderingFactory

setOrdering

void setOrdering(Ordering ordering)

Defines the ordering to use to lay out the treemap.

Parameters:

ordering - the ordering to use

See Also:

DefaultTreeMapSettings.getOrdering(), OrderingFactory

getLabeling

Labeling getLabeling()

Returns the labeling scheme to use to draw the treemap.

Returns:

the labeling scheme to use

See Also:

DefaultTreeMapFieldSettings.getLabeling(), LabelingFactory

setLabeling

void setLabeling(Labeling labeling)

Defines the labeling scheme to use to draw the treemap.

Parameters:

labeling - the labeling scheme to use

See Also:

DefaultTreeMapFieldSettings.getLabeling(), LabelingFactory

getLabelingFont

Font getLabelingFont()

Returns the font used for labeling.

Returns:

the font to be used

See Also:

DefaultTreeMapSettings.getLabelingFont()

setLabelingFont

void setLabelingFont(Font font)

Sets the font used for labeling.

Parameters:

font - the font to be used

See Also:

DefaultTreeMapSettings.getLabelingFont()

getLabelingForeground

Color getLabelingForeground()

Returns the foreground color to use for drawing the labels.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getLabelingForeground()

setLabelingForeground

void setLabelingForeground(Color color)

Sets the foreground color to use for drawing the labels.

Parameters:

color - the color to be used

See Also:

DefaultTreeMapSettings.getLabelingForeground()

getLabelingEffectColor

Color getLabelingEffectColor()

Returns the effect color to use for drawing the labels.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getLabelingEffectColor()

setLabelingEffectColor

void setLabelingEffectColor(Color color)

Sets the effect color to use for drawing the labels.

Parameters:

color - the color to be used

See Also:

DefaultTreeMapSettings.getLabelingEffectColor()

getLabelingEffect

EnhancedJLabel.Effect getLabelingEffect()

setLabelingEffect

void setLabelingEffect(EnhancedJLabel.Effect effect)

getLabelingHorizontalAlignment

Integer getLabelingHorizontalAlignment()

setLabelingHorizontalAlignment

void setLabelingHorizontalAlignment(Integer alignment)

getLabelingVerticalAlignment

Integer getLabelingVerticalAlignment()

setLabelingVerticalAlignment

void setLabelingVerticalAlignment(Integer alignment)

getLabelingRendering

EnhancedJLabel.Rendering getLabelingRendering()

setLabelingRendering

void setLabelingRendering(EnhancedJLabel.Rendering rendering)

getLabelingMinimumCharactersToDisplay

Integer getLabelingMinimumCharactersToDisplay()

setLabelingMinimumCharactersToDisplay

void setLabelingMinimumCharactersToDisplay(Integer minimumCharactersToDisplay)

getLabelingEffectOpacity

Float getLabelingEffectOpacity()

setLabelingEffectOpacity

void setLabelingEffectOpacity(Float opacity)

getHeaderFont

Font getHeaderFont()

Returns the font used for labeling the headings.

Returns:

the font to be used

See Also:

DefaultTreeMapSettings.getHeaderFont()

setHeaderFont

void setHeaderFont(Font font)

Sets the font used for labeling the headings.

Parameters:

font - the font to be used

See Also:

DefaultTreeMapSettings.getHeaderFont()

getHeaderForeground

Color getHeaderForeground()

Returns the foreground color to use for drawing the headers.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getHeaderForeground()

setHeaderForeground

void setHeaderForeground(Color color)

Sets the foreground color to use for drawing the headers.

Parameters:

color - the color to be used

See Also:

DefaultTreeMapSettings.getHeaderForeground()

getHeaderBackground

Color getHeaderBackground()

Returns the background color to use for drawing the headers.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getHeaderBackground()

setHeaderBackground

void setHeaderBackground(Color color)

Sets the background color to use for drawing the headers.

Parameters:

color - the color to be used

See Also:

DefaultTreeMapSettings.getHeaderBackground()

getHeaderEffectColor

Color getHeaderEffectColor()

Returns the effect color to use for drawing the headers.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getHeaderEffectColor()

setHeaderEffectColor

void setHeaderEffectColor(Color color)

Sets the background color to use for drawing the headers.

Parameters:

color - the color to be used

See Also:

DefaultTreeMapSettings.getHeaderEffectColor()

getHeaderEffect

EnhancedJLabel.Effect getHeaderEffect()

setHeaderEffect

void setHeaderEffect(EnhancedJLabel.Effect effect)

getHeaderHorizontalAlignment

Integer getHeaderHorizontalAlignment()

setHeaderHorizontalAlignment

void setHeaderHorizontalAlignment(Integer alignment)

getHeaderVerticalAlignment

Integer getHeaderVerticalAlignment()

setHeaderVerticalAlignment

void setHeaderVerticalAlignment(Integer alignment)

getHeaderRendering

EnhancedJLabel.Rendering getHeaderRendering()

setHeaderRendering

void setHeaderRendering(EnhancedJLabel.Rendering rendering)

getHeaderMinimumCharactersToDisplay

Integer getHeaderMinimumCharactersToDisplay()

setHeaderMinimumCharactersToDisplay

void setHeaderMinimumCharactersToDisplay(Integer minimumCharactersToDisplay)

getHeaderEffectOpacity

Float getHeaderEffectOpacity()

setHeaderEffectOpacity

void setHeaderEffectOpacity(Float opacity)

getTooltipFont

Font getTooltipFont()

Returns the font used for labeling the tooltips.

Returns:

the font to be used

See Also:

DefaultTreeMapSettings.getTooltipFont()

setTooltipFont

void setTooltipFont(Font font)

Sets the font used for labeling the tooltips.

Parameters:

font - the font to be used

See Also:

DefaultTreeMapSettings.getTooltipFont()

getTooltipForeground

Color getTooltipForeground()

Returns the foreground color to use for drawing the tooltips.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getTooltipForeground()

setTooltipForeground

void setTooltipForeground(Color color)

Sets the foreground color to use for drawing the tooltips.

Parameters:

color - the color to be used

See Also:

DefaultTreeMapSettings.getTooltipForeground()

getTooltipRendering

EnhancedJLabel.Rendering getTooltipRendering()

setTooltipRendering

void setTooltipRendering(EnhancedJLabel.Rendering rendering)

getBorderColor

Color getBorderColor()

Returns the color to use for drawing the borders.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getBorderColor()

setBorderColor

void setBorderColor(Color color)

Sets the color to use for drawing the borders.

Parameters:

color - the color to be used

See Also:

DefaultTreeMapSettings.getBorderColor()

getBorderThickness

double getBorderThickness()

Returns the thickness used for drawing the borders.

Returns:

the height

See Also:

DefaultTreeMapSettings.getBorderThickness()

setBorderThickness

void setBorderThickness(double value)

Sets the thickness used for drawing the borders.

Parameters:

value - the height

See Also:

DefaultTreeMapSettings.getBorderThickness()

getFormat

Format getFormat()

Gets the format used to display values of the specified column.

Returns:

the format to be used.

setFormat

void setFormat(Format format)

Sets the format used to display values of the specified column.

Parameters:

format - the format to be used.

getShowTooltipLabel

boolean getShowTooltipLabel()

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

Returns:

true if it should be displayed, false otherwise.

setShowTooltipLabel

void setShowTooltipLabel(boolean show)

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

Parameters:

show - true if it should be displayed, false otherwise.

getColorMap

MutableColorMap getColorMap()

Gets the color map for the specified column.

Returns:

the color map to use.

setColorMap

void setColorMap(MutableColorMap colorMap)

Sets the color map to use for the specified column.

Parameters:

colorMap - the colorMap to use.

getValue

Object getValue(String key)

Gets the value of the specified property.

Parameters:

key - the property name

Returns:

the value

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                  PropertyChangeListener listener)