Class DefaultTreePlotSettings<Color,​Font>

    • Constructor Detail

      • DefaultTreePlotSettings

        public DefaultTreePlotSettings​(TreeMapModel model,
                                       com.macrofocus.igraphics.CPColorFactory<Color> colorFactory,
                                       com.macrofocus.igraphics.CPFontFactory<Font> fontFactory)
    • Method Detail

      • getGroupByTreeMapFields

        public 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

        public void setGroupByTreeMapFields​(TreeMapField[] fields)
      • getSizeTreeMapField

        public 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

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

        public 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

        public void setToolTipTreeMapFields​(TreeMapField[] fields)
      • isHideFilterResults

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

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

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

        public boolean getShowPopup​(TreeMapField field)
        Description copied from interface: TreePlotSettings
        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

        public void setShowPopup​(TreeMapField field,
                                 boolean show)
        Description copied from interface: TreePlotSettings
        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.
      • setSize

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

        public void setSizeTreeMapField​(TreeMapField field)
      • setSizeByName

        public 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

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

        public void setColorTreeMapField​(TreeMapField field)
      • setHideFilterResults

        public void setHideFilterResults​(java.lang.Boolean hideFilterResults)
      • setHideSearchResults

        public void setHideSearchResults​(java.lang.Boolean hideSearchResults)
      • setTooltipBackground

        public 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

        public 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

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

        public java.lang.Object getValue​(java.lang.String key)
        Description copied from interface: TreePlotSettings
        Gets the value of the specified property.
        Parameters:
        key - the property name
        Returns:
        the value
      • resetToDefaults

        public void resetToDefaults()
      • getBackground

        public com.macrofocus.igraphics.CPColor<Color> getBackground()
        Returns the backgroun color to use for drawing the treeplot.
        Returns:
        the color to be used
      • setBackground

        public 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

        public MutableProperty<com.macrofocus.igraphics.CPColor<Color>> getBackgroundProperty()
      • getGridColor

        public com.macrofocus.igraphics.CPColor<Color> getGridColor()
        Returns the color to use for drawing the grid.
        Returns:
        the color to be used
      • setGridColor

        public 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

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

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

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

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

        public 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
      • groupByProperty

        public MutableProperty<java.lang.Boolean> groupByProperty()