com.jidesoft.treemap
Class DefaultTreeMapFieldSettings

java.lang.Object
  com.jidesoft.treemap.AbstractTreeMapFieldSettings
      com.jidesoft.treemap.DefaultTreeMapFieldSettings

All Implemented Interfaces:

TreeMapFieldSettings

public class DefaultTreeMapFieldSettings
extends AbstractTreeMapFieldSettings

Field Summary

protected Aggregation	_aggregation
protected Algorithm	_algorithm
protected Color	_borderColor
protected MutableColorMap	_colorMap
protected Format	_format
protected Color	_headerBackground
protected Color	_headerEffectColor
protected Font	_headerFont
protected Color	_headerForeground
protected Labeling	_labeling
protected Color	_labelingBackground
protected Font	_labelingFont
protected Color	_labelingForeground
protected Nesting	_nesting
protected Ordering	_ordering
protected Scale	_scale
protected Font	_tooltipFont
protected Color	_tooltipForeground
protected Boolean	_tooltipShowLabel
protected MutableBoundedInterval	borderThickness
EnhancedJLabel.Effect	headerEffect
protected Float	headerEffectOpacity
Integer	headerHorizontalAlignment
protected Integer	headerMinimumCharactersToDisplay
EnhancedJLabel.Rendering	headerRendering
Integer	headerVerticalAlignment
EnhancedJLabel.Effect	labelingEffect
protected Float	labelingEffectOpacity
Integer	labelingHorizontalAlignment
protected Integer	labelingMinimumCharactersToDisplay
EnhancedJLabel.Rendering	labelingRendering
Integer	labelingVerticalAlignment
EnhancedJLabel.Rendering	tooltipRendering

Fields inherited from interface com.jidesoft.treemap.TreeMapFieldSettings

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

Constructor Summary

DefaultTreeMapFieldSettings()

Method Summary

protected MutableColorMap	createDefaultColorMap(TreeMapField field)
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.
static Font	getDefaultHeaderFont()
static Font	getDefaultLabelingFont()
static Font	getDefaultTooltipFont()
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	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)

Methods inherited from class com.jidesoft.treemap.AbstractTreeMapFieldSettings

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

borderThickness

protected final MutableBoundedInterval borderThickness

_algorithm

protected Algorithm _algorithm

_aggregation

protected Aggregation _aggregation

_scale

protected Scale _scale

_nesting

protected Nesting _nesting

_ordering

protected Ordering _ordering

_labeling

protected Labeling _labeling

_labelingFont

protected Font _labelingFont

_labelingForeground

protected Color _labelingForeground

_labelingBackground

protected Color _labelingBackground

labelingEffect

public EnhancedJLabel.Effect labelingEffect

labelingHorizontalAlignment

public Integer labelingHorizontalAlignment

labelingVerticalAlignment

public Integer labelingVerticalAlignment

labelingRendering

public EnhancedJLabel.Rendering labelingRendering

labelingMinimumCharactersToDisplay

protected Integer labelingMinimumCharactersToDisplay

labelingEffectOpacity

protected Float labelingEffectOpacity

_headerFont

protected Font _headerFont

_headerForeground

protected Color _headerForeground

_headerEffectColor

protected Color _headerEffectColor

_headerBackground

protected Color _headerBackground

headerEffect

public EnhancedJLabel.Effect headerEffect

headerHorizontalAlignment

public Integer headerHorizontalAlignment

headerVerticalAlignment

public Integer headerVerticalAlignment

headerRendering

public EnhancedJLabel.Rendering headerRendering

headerMinimumCharactersToDisplay

protected Integer headerMinimumCharactersToDisplay

headerEffectOpacity

protected Float headerEffectOpacity

_tooltipFont

protected Font _tooltipFont

_tooltipForeground

protected Color _tooltipForeground

_tooltipShowLabel

protected Boolean _tooltipShowLabel

tooltipRendering

public EnhancedJLabel.Rendering tooltipRendering

_borderColor

protected Color _borderColor

_format

protected Format _format

_colorMap

protected MutableColorMap _colorMap

Constructor Detail

DefaultTreeMapFieldSettings

public DefaultTreeMapFieldSettings()

Method Detail

getDefaultHeaderFont

public static Font getDefaultHeaderFont()

getDefaultLabelingFont

public static Font getDefaultLabelingFont()

getDefaultTooltipFont

public static Font getDefaultTooltipFont()

getAlgorithm

public Algorithm getAlgorithm()

Returns the algorithm to use to lay out the treemap.

Returns:

the algorithm to use

See Also:

DefaultTreeMapSettings.getAlgorithm(), AlgorithmFactory

setAlgorithm

public 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

public 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

public 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

public 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

public 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

public Nesting getNesting()

Returns the nesting to use to lay out the treemap.

Returns:

the nesting scheme to use

See Also:

DefaultTreeMapSettings.getNesting(), NestingFactory

setNesting

public 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

public Ordering getOrdering()

Returns the ordering to use to lay out the treemap.

Returns:

the ordering to use

See Also:

DefaultTreeMapSettings.getOrdering(), OrderingFactory

setOrdering

public 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

public Labeling getLabeling()

Returns the labeling scheme to use to draw the treemap.

Returns:

the labeling scheme to use

See Also:

getLabeling(), LabelingFactory

setLabeling

public void setLabeling(Labeling labeling)

Defines the labeling scheme to use to draw the treemap.

Parameters:

labeling - the labeling scheme to use

See Also:

getLabeling(), LabelingFactory

getLabelingFont

public Font getLabelingFont()

Returns the font used for labeling.

Returns:

the font to be used

See Also:

DefaultTreeMapSettings.getLabelingFont()

setLabelingFont

public void setLabelingFont(Font font)

Sets the font used for labeling.

Parameters:

font - the font to be used

See Also:

DefaultTreeMapSettings.getLabelingFont()

getLabelingForeground

public Color getLabelingForeground()

Returns the foreground color to use for drawing the labels.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getLabelingForeground()

setLabelingForeground

public 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

public Color getLabelingEffectColor()

Returns the effect color to use for drawing the labels.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getLabelingEffectColor()

setLabelingEffectColor

public 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

public EnhancedJLabel.Effect getLabelingEffect()

setLabelingEffect

public void setLabelingEffect(EnhancedJLabel.Effect effect)

getLabelingHorizontalAlignment

public Integer getLabelingHorizontalAlignment()

setLabelingHorizontalAlignment

public void setLabelingHorizontalAlignment(Integer alignment)

getLabelingVerticalAlignment

public Integer getLabelingVerticalAlignment()

setLabelingVerticalAlignment

public void setLabelingVerticalAlignment(Integer alignment)

getLabelingRendering

public EnhancedJLabel.Rendering getLabelingRendering()

setLabelingRendering

public void setLabelingRendering(EnhancedJLabel.Rendering rendering)

getLabelingMinimumCharactersToDisplay

public Integer getLabelingMinimumCharactersToDisplay()

setLabelingMinimumCharactersToDisplay

public void setLabelingMinimumCharactersToDisplay(Integer minimumCharactersToDisplay)

getLabelingEffectOpacity

public Float getLabelingEffectOpacity()

setLabelingEffectOpacity

public void setLabelingEffectOpacity(Float opacity)

getHeaderBackground

public Color getHeaderBackground()

Returns the background color to use for drawing the headers.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getHeaderBackground()

setHeaderBackground

public 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()

getHeaderFont

public Font getHeaderFont()

Returns the font used for labeling the headings.

Returns:

the font to be used

See Also:

DefaultTreeMapSettings.getHeaderFont()

setHeaderFont

public void setHeaderFont(Font font)

Sets the font used for labeling the headings.

Parameters:

font - the font to be used

See Also:

DefaultTreeMapSettings.getHeaderFont()

getHeaderForeground

public Color getHeaderForeground()

Returns the foreground color to use for drawing the headers.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getHeaderForeground()

setHeaderForeground

public 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()

getHeaderEffectColor

public Color getHeaderEffectColor()

Returns the effect color to use for drawing the headers.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getHeaderEffectColor()

setHeaderEffectColor

public 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

public EnhancedJLabel.Effect getHeaderEffect()

setHeaderEffect

public void setHeaderEffect(EnhancedJLabel.Effect effect)

getHeaderHorizontalAlignment

public Integer getHeaderHorizontalAlignment()

setHeaderHorizontalAlignment

public void setHeaderHorizontalAlignment(Integer alignment)

getHeaderVerticalAlignment

public Integer getHeaderVerticalAlignment()

setHeaderVerticalAlignment

public void setHeaderVerticalAlignment(Integer alignment)

getHeaderRendering

public EnhancedJLabel.Rendering getHeaderRendering()

setHeaderRendering

public void setHeaderRendering(EnhancedJLabel.Rendering rendering)

getHeaderMinimumCharactersToDisplay

public Integer getHeaderMinimumCharactersToDisplay()

setHeaderMinimumCharactersToDisplay

public void setHeaderMinimumCharactersToDisplay(Integer minimumCharactersToDisplay)

getHeaderEffectOpacity

public Float getHeaderEffectOpacity()

setHeaderEffectOpacity

public void setHeaderEffectOpacity(Float opacity)

getTooltipFont

public Font getTooltipFont()

Returns the font used for labeling the tooltips.

Returns:

the font to be used

See Also:

DefaultTreeMapSettings.getTooltipFont()

setTooltipFont

public void setTooltipFont(Font font)

Sets the font used for labeling the tooltips.

Parameters:

font - the font to be used

See Also:

DefaultTreeMapSettings.getTooltipFont()

getTooltipForeground

public Color getTooltipForeground()

Returns the foreground color to use for drawing the tooltips.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getTooltipForeground()

setTooltipForeground

public 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

public EnhancedJLabel.Rendering getTooltipRendering()

setTooltipRendering

public void setTooltipRendering(EnhancedJLabel.Rendering rendering)

getBorderColor

public Color getBorderColor()

Returns the color to use for drawing the borders.

Returns:

the color to be used

See Also:

DefaultTreeMapSettings.getBorderColor()

setBorderColor

public 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

public double getBorderThickness()

Returns the thickness used for drawing the borders.

Returns:

the height

See Also:

DefaultTreeMapSettings.getBorderThickness()

setBorderThickness

public void setBorderThickness(double value)

Sets the thickness used for drawing the borders.

Parameters:

value - the height

See Also:

DefaultTreeMapSettings.getBorderThickness()

getFormat

public Format getFormat()

Description copied from interface: TreeMapFieldSettings

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

Returns:

the format to be used.

setFormat

public void setFormat(Format format)

Description copied from interface: TreeMapFieldSettings

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

Parameters:

format - the format to be used.

getColorMap

public MutableColorMap getColorMap()

Description copied from interface: TreeMapFieldSettings

Gets the color map for the specified column.

Returns:

the color map to use.

setColorMap

public void setColorMap(MutableColorMap colorMap)

Description copied from interface: TreeMapFieldSettings

Sets the color map to use for the specified column.

Parameters:

colorMap - the colorMap to use.

createDefaultColorMap

protected MutableColorMap createDefaultColorMap(TreeMapField field)

getShowTooltipLabel

public boolean getShowTooltipLabel()

Description copied from interface: TreeMapFieldSettings

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

Returns:

true if it should be displayed, false otherwise.

setShowTooltipLabel

public void setShowTooltipLabel(boolean show)

Description copied from interface: TreeMapFieldSettings

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.

getValue

public Object getValue(String key)

Description copied from interface: TreeMapFieldSettings

Gets the value of the specified property.

Parameters:

key - the property name

Returns:

the value