Package com.macrofocus.treeplot

Interface TreePlotSettings<Color,​Font>

    • Field Detail

      • PROPERTY_COLOR_FIELD

        static final java.lang.String PROPERTY_COLOR_FIELD
        See Also:
        Constant Field Values

      • PROPERTY_TOOLTIP_FIELD

        static final java.lang.String PROPERTY_TOOLTIP_FIELD
        See Also:
        Constant Field Values

      • PROPERTY_GROUP_BY_FIELD

        static final java.lang.String PROPERTY_GROUP_BY_FIELD
        See Also:
        Constant Field Values

      • PROPERTY_TOOLTIP_BACKGROUND

        static final java.lang.String PROPERTY_TOOLTIP_BACKGROUND
        See Also:
        Constant Field Values

      • PROPERTY_PROBING_COLOR

        static final java.lang.String PROPERTY_PROBING_COLOR
        See Also:
        Constant Field Values

      • PROPERTY_SELECTION_COLOR

        static final java.lang.String PROPERTY_SELECTION_COLOR
        See Also:
        Constant Field Values

      • PROPERTY_HIDE_SEARCH_RESULTS

        static final java.lang.String PROPERTY_HIDE_SEARCH_RESULTS
        See Also:
        Constant Field Values

      • PROPERTY_HIDE_FILTER_RESULTS

        static final java.lang.String PROPERTY_HIDE_FILTER_RESULTS
        See Also:
        Constant Field Values

      • PROPERTY_TREEPLOT_BACKGROUND_COLOR

        static final java.lang.String PROPERTY_TREEPLOT_BACKGROUND_COLOR
        See Also:
        Constant Field Values

      • PROPERTY_TREEPLOT_GRID_COLOR

        static final java.lang.String PROPERTY_TREEPLOT_GRID_COLOR
        See Also:
        Constant Field Values

      • PROPERTY_TREEPLOT_GRID_THICKNESS

        static final java.lang.String PROPERTY_TREEPLOT_GRID_THICKNESS
        See Also:
        Constant Field Values

      • PROPERTY_TREEPLOT_GROUPBY

        static final java.lang.String PROPERTY_TREEPLOT_GROUPBY
        See Also:
        Constant Field Values

      • PROPERTY_TREEPLOT_BUBBLE_SIZE

        static final java.lang.String PROPERTY_TREEPLOT_BUBBLE_SIZE
        See Also:
        Constant Field Values

    • Method Detail

      • 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.

      • setSizeTreeMapField

        void setSizeTreeMapField​(TreeMapField field)

      • 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

        void setColorTreeMapField​(TreeMapField field)

      • 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

        void setToolTipTreeMapFields​(TreeMapField[] fields)

      • isHideFilterResults

        java.lang.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​(java.lang.Boolean hideFilterResults)

      • isHideSearchResults

        java.lang.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​(java.lang.Boolean hideSearchResults)

      • setGroupByByNames

        void setGroupByByNames​(java.lang.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()

      • 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​(java.lang.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()

      • setColorByName

        void setColorByName​(java.lang.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()

      • setTooltipBackground

        void setTooltipBackground​(com.macrofocus.igraphics.CPColor<Color> color)
        Sets the background color to use for drawing the tooltips.
        Parameters:
        color - the color to be used
        See Also:
        DefaultTreeMapSettings.getTooltipBackground()

      • setProbingColor

        void setProbingColor​(com.macrofocus.igraphics.CPColor<Color> color)
        Sets the color to use for drawing the borders.
        Parameters:
        color - the color to be used
        See Also:
        DefaultTreeMapSettings.getProbingColor()

      • setSelectionColor

        void setSelectionColor​(com.macrofocus.igraphics.CPColor<Color> color)
        Sets the color to use for drawing the borders.
        Parameters:
        color - the color to be used
        See Also:
        DefaultTreeMapSettings.getSelectionColor()

      • 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

        java.lang.Object getValue​(java.lang.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​(java.lang.String propertyName,
                               java.beans.PropertyChangeListener listener)
        Specified by:
        addPropertyChangeListener in interface PropertyChange

      • removePropertyChangeListener

        void removePropertyChangeListener​(java.lang.String propertyName,
                                  java.beans.PropertyChangeListener listener)
        Specified by:
        removePropertyChangeListener in interface PropertyChange

      • 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

        void setBackground​(com.macrofocus.igraphics.CPColor<Color> color)
        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

        void setGridColor​(com.macrofocus.igraphics.CPColor<Color> color)
        Sets the color to use for drawing the grid.
        Parameters:
        color - the color to be used

      • getGridColorProperty

        MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getGridColorProperty()

      • getGridThickness

        java.lang.Double getGridThickness()
        Returns the thickness used for drawing the grid.
        Returns:
        the thickness

      • setGridThickness

        void setGridThickness​(java.lang.Double value)
        Sets the thickness used for drawing the grid.
        Parameters:
        value - the thickness

      • getGroupBy

        java.lang.Boolean getGroupBy()
        Returns whether the groups should be displayed.
        Returns:
        the font to be used

      • setGroupBy

        void setGroupBy​(java.lang.Boolean groupBy)
        Sets whether the groups should be displayed.
        Parameters:
        groupBy - true to display the groups; false to display the leaves