Interface TreeIconHandler


  • public interface TreeIconHandler

    Definition of an interface for components that determine the icons displayed by a tree component.

    When a tree is constructed an arbitrary number of named icons can be specified using nested TreeIconTag tags. When rendering the tree the TreeIconHandler is queried for each node to be displayed. It is passed in the current tree node and some flags describing its state (whether it is expanded or a leaf node). The return value is the name of an icon that was defined on construction time of the tree. The corresponding icon will then be displayed for this node.

    Version:
    $Id: TreeIconHandler.java 205 2012-01-29 18:29:57Z oheger $
    Author:
    Oliver Heger
    See Also:
    TreeTag, TreeIconTag
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getIconName​(org.apache.commons.configuration.tree.ConfigurationNode node, boolean expanded, boolean leaf)
      Returns the name of the icon for the specified node.
    • Method Detail

      • getIconName

        String getIconName​(org.apache.commons.configuration.tree.ConfigurationNode node,
                           boolean expanded,
                           boolean leaf)
        Returns the name of the icon for the specified node. The name must match exactly the name of an icon specified when the tree was constructed.
        Parameters:
        node - the current node
        expanded - a flag whether this node is expanded
        leaf - a flag whether this node is a leaf node
        Returns:
        the name of the icon to be displayed for this node