Package com.treemap.treeplot
Interface TreePlotSettings<Color,Font>
- All Superinterfaces:
PropertyChange
- All Known Implementing Classes:
AbstractTreePlotSettings
,DefaultTreePlotSettings
Keep track of all the settings that can be applied to a treeplot.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addPropertyChangeListener
(String propertyName, PropertyChangeListener listener) void
Add a listener for receiving interesting events about changes in the settings.com.macrofocus.igraphics.CPColor<Color>
Returns the backgroun color to use for drawing the treeplot.MutableProperty<com.macrofocus.igraphics.CPColor<Color>>
Gets the model used to hold the field used to represent the color.getDepth()
Returns the depth to use to lay out the treemap.getFieldSettings
(TreeMapField field) com.macrofocus.igraphics.CPColor<Color>
Returns the color to use for drawing the grid.MutableProperty<com.macrofocus.igraphics.CPColor<Color>>
Returns the thickness used for drawing the grid.Returns whether the groups should be displayed.Gets the model used to hold the list of fields to be use for grouping.com.macrofocus.igraphics.CPColor<Color>
Returns the color to use for drawing the borders.Returns the rendering scheme to use to draw the treemap.com.macrofocus.igraphics.CPColor<Color>
Returns the color to use for drawing the borders.boolean
getShowPopup
(TreeMapField field) Tells whether the specified field should be shown in the popup.Gets the model used to hold the field used to represent the size.com.macrofocus.igraphics.CPColor<Color>
Returns the background color to use for drawing the tooltips.Gets the model used to hold the list of fields to be use by the tooltip.Gets the value of the specified property.Gets the model used to indicate whether filtered nodes should be hidden.Gets the model used to indicate whether nodes that do not match the search criteria should be hidden.void
void
removePropertyChangeListener
(String propertyName, PropertyChangeListener listener) void
Remove all the listener from the list of listeners that should be notified about changes in the settings.void
Remove a listener from the list of listeners that should be notified about changes in the settings.void
void
setBackground
(com.macrofocus.igraphics.CPColor<Color> color) Sets the background color to use for drawing the treeplot.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
Defines the depth to use to lay out the treemap.void
setGridColor
(com.macrofocus.igraphics.CPColor<Color> color) Sets the color to use for drawing the grid.void
setGridThickness
(Double value) Sets the thickness used for drawing the grid.void
setGroupBy
(int... columns) Defines the fields to be use for grouping.void
setGroupBy
(Boolean groupBy) Sets whether the groups should be displayed.void
setGroupByByNames
(String... columnNames) Defines the fields to be use for grouping.void
setGroupByTreeMapFields
(TreeMapField[] fields) void
setHideFilterResults
(Boolean hideFilterResults) void
setHideSearchResults
(Boolean hideSearchResults) void
setProbingColor
(com.macrofocus.igraphics.CPColor<Color> color) Sets the color to use for drawing the borders.void
setRendering
(Rendering rendering) Defines the rendering scheme to use to draw the treemap.void
setSelectionColor
(com.macrofocus.igraphics.CPColor<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
(com.macrofocus.igraphics.CPColor<Color> color) Sets the background color to use for drawing the tooltips.void
setToolTipTreeMapFields
(TreeMapField[] fields)
-
Field Details
-
PROPERTY_SIZE_FIELD
- See Also:
-
PROPERTY_COLOR_FIELD
- See Also:
-
PROPERTY_TOOLTIP_FIELD
- See Also:
-
PROPERTY_GROUP_BY_FIELD
- See Also:
-
PROPERTY_DEPTH
- See Also:
-
PROPERTY_RENDERING
- See Also:
-
PROPERTY_TOOLTIP_BACKGROUND
- See Also:
-
PROPERTY_PROBING_COLOR
- See Also:
-
PROPERTY_SELECTION_COLOR
- See Also:
-
PROPERTY_HIDE_SEARCH_RESULTS
- See Also:
-
PROPERTY_HIDE_FILTER_RESULTS
- See Also:
-
PROPERTY_TREEPLOT_BACKGROUND_COLOR
- See Also:
-
PROPERTY_TREEPLOT_GRID_COLOR
- See Also:
-
PROPERTY_TREEPLOT_GRID_THICKNESS
- See Also:
-
PROPERTY_TREEPLOT_GROUPBY
- See Also:
-
PROPERTY_TREEPLOT_BUBBLE_SIZE
- See Also:
-
-
Method Details
-
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
-
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.
-
setSizeTreeMapField
-
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.
-
setColorTreeMapField
-
getToolTipTreeMapFields
TreeMapField[] getToolTipTreeMapFields()Gets the model used to hold the list of fields to be use by the tooltip.- Returns:
- the model of fields to be use by the tooltip.
-
setToolTipTreeMapFields
-
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
-
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
-
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:
-
setGroupByByNames
Defines the fields to be use for grouping.- Parameters:
columnNames
- the names of the columns to be used for grouping- See Also:
-
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:
-
setSizeByName
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:
-
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:
-
setColorByName
Defines the field to use for coloring.- Parameters:
columnName
- the name of the column to be used for coloring- See Also:
-
getDepth
Depth getDepth()Returns the depth to use to lay out the treemap.- Returns:
- the depth to use
- See Also:
-
setDepth
Defines the depth to use to lay out the treemap.- Parameters:
depth
- the depth to use- See Also:
-
getRendering
Rendering getRendering()Returns the rendering scheme to use to draw the treemap.- Returns:
- the rendering scheme to use
- See Also:
-
setRendering
Defines the rendering scheme to use to draw the treemap.- Parameters:
rendering
- the rendering scheme to use- See Also:
-
getTooltipBackground
com.macrofocus.igraphics.CPColor<Color> getTooltipBackground()Returns the background color to use for drawing the tooltips.- Returns:
- the color to be used
- See Also:
-
setTooltipBackground
Sets the background color to use for drawing the tooltips.- Parameters:
color
- the color to be used- See Also:
-
getProbingColor
com.macrofocus.igraphics.CPColor<Color> getProbingColor()Returns the color to use for drawing the borders.- Returns:
- the color to be used
- See Also:
-
setProbingColor
Sets the color to use for drawing the borders.- Parameters:
color
- the color to be used- See Also:
-
getSelectionColor
com.macrofocus.igraphics.CPColor<Color> getSelectionColor()Returns the color to use for drawing the borders.- Returns:
- the color to be used
- See Also:
-
setSelectionColor
Sets the color to use for drawing the borders.- Parameters:
color
- the color to be used- See Also:
-
getShowPopup
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
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
Gets the value of the specified property.- Parameters:
key
- the property name- Returns:
- the value
-
addTreeMapSettingsListener
Add a listener for receiving interesting events about changes in the settings.- Parameters:
listener
- the listener to add.
-
removeTreeMapSettingsListener
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
- Specified by:
addPropertyChangeListener
in interfacePropertyChange
-
addPropertyChangeListener
- Specified by:
addPropertyChangeListener
in interfacePropertyChange
-
removePropertyChangeListener
- Specified by:
removePropertyChangeListener
in interfacePropertyChange
-
removePropertyChangeListener
- Specified by:
removePropertyChangeListener
in interfacePropertyChange
-
getDefaultFieldSettings
TreeMapFieldSettings<Color,Font> getDefaultFieldSettings() -
getFieldSettings
-
resetToDefaults
void resetToDefaults() -
getBackground
com.macrofocus.igraphics.CPColor<Color> getBackground()Returns the backgroun color to use for drawing the treeplot.- Returns:
- the color to be used
-
setBackground
Sets the background color to use for drawing the treeplot.- Parameters:
color
- the color to be used
-
getBackgroundProperty
MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getBackgroundProperty() -
getGridColor
com.macrofocus.igraphics.CPColor<Color> getGridColor()Returns the color to use for drawing the grid.- Returns:
- the color to be used
-
setGridColor
Sets the color to use for drawing the grid.- Parameters:
color
- the color to be used
-
getGridColorProperty
MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getGridColorProperty() -
getGridThicknessInterval
MutableBoundedInterval getGridThicknessInterval() -
getGridThickness
Double getGridThickness()Returns the thickness used for drawing the grid.- Returns:
- the thickness
-
setGridThickness
Sets the thickness used for drawing the grid.- Parameters:
value
- the thickness
-
getGroupBy
Boolean getGroupBy()Returns whether the groups should be displayed.- Returns:
- the font to be used
-
setGroupBy
Sets whether the groups should be displayed.- Parameters:
groupBy
- true to display the groups; false to display the leaves
-
groupByProperty
MutableProperty<Boolean> groupByProperty() -
getBubbleSizeInterval
MutableBoundedInterval getBubbleSizeInterval()
-