All Packages Class Hierarchy This Package Previous Next Index
Interface com.sgi.sysadm.ui.treeView.TreeViewProperties
- public interface TreeViewProperties
TreeViewProperties is an interface that contains all of the
properties used to customize the TreeView and its supporting
classes. Classes that wish access to the TreeView properties
should implement this interface.
These property names are usually appended to the prefix passed
to the TreeViewPane constructor. For example, the color of the text
in the tree would be specified by the property
<prefix>.textColor
where "<prefix>" is the value of the prefix argument
passed to the TreeViewPane constructor.
The structure of the tree is defined by properties in the
ResourceStack:
<prefix>.tree<n> specifies an array
of tree names,
one for each tree structure. For each treename so specified,
<prefix>.<treename>.level<n>
specifies an array of Category corresponding to each level in the tree.
The Category at level 0 of each tree must match the type of the root
Item of the TreeViewPane.
Each level of the tree is populated by the members of an Association
between the Item we're displaying and the Category at the next level.
For each Item in level <n>, we monitor the Association with
the Category at level <n+1>.
If it is necessary to use a Category instead of an Association at a
given level in the tree, specify it by setting the property
<prefix>.<treename>.level<n>.useAssoc = false
The default values for the properties contained here are defined in
com.sgi.sysadm.ui.treeView.TreeViewP.properties and may be
overridden by properties file(s) of the product.
- See Also:
- TreeViewPane
-
BACKGROUND
- The property <prefix>.background specifies the
color to be used as the background for the TreeViewPane.
-
CELL_BORDER_HEIGHT
- The property <prefix>.cellBorderHeight
specifies the height, in points, of the border around each Item in
the tree.
-
CELL_BORDER_WIDTH
- The property <prefix>.cellBorderWidth specifies
the width, in points, of the border around each Item in the tree.
-
CHILD_FONT
- The property <prefix>.childFont specifies the
name of the font to be used to display the name of all Items in the
tree (except for the Item at the root of the tree).
-
CLOSED_ICON
- The property <prefix>.closedIcon specifies the
package-qualified name of the icon to display when a node in the tree
has children and those children are not visible, that is, when the
node is closed.
-
ICON_HEIGHT
- The property <prefix>.iconHeight specifies the
height, in points, of the icon to be displayed at each node of the
tree.
-
ICON_WIDTH
- The property <prefix>.iconWidth specifies the
width, in points, of the icon to be displayed at each node of the
tree.
-
ITEM_COMPARATOR
- The property
<prefix>.<categoryname>.itemComparator
specifies the package-qualified name of a class which implements the
ItemComparator interface for a given category.
-
ITEM_TESTER
- The property
<prefix>.<treename>.itemTester
specifies the package-qualified name of a class which implements the
ItemComparator interface for a given category.
-
LEVEL
- The property
<prefix>.<treename>.level<n> is a
string array which specifies the package-qualified names of the
Categories of Items to be displayed at each level of the tree.
-
OPENED_ICON
- The property <prefix>.openedIcon specifies the
package-qualified name of the icon to display when a node in the tree
has children and those children are visible, that is, when the node
is open.
-
PANE_HEIGHT
- The property <prefix>.height specifies the
default height, in points, of the tree pane.
-
PANE_WIDTH
- The property <prefix>.width specifies the
default width, in points, of the tree pane.
-
ROOT_FILTER_ATTR
- The property
<prefix>.<treename>.level<n>.rootFilterAttr
is only used if USE_ASSOC is false.
-
ROOT_FONT
- The property <prefix>.rootFont specifies the
name of the font to be used to display the name of the Item at the
root node of the tree.
-
SELECT_COLOR
- The property <prefix>.selectColor specifies the
color to be used as the background of the selected Item in the tree.
-
SHOW_ROOT
- The property
<prefix>.<treename>.showRoot is a boolean
which specifies whether the root node in the tree is to be displayed
when this tree is displayed.
-
TEXT_COLOR
- The property <prefix>.textColor specifies the
color to be used to display the name of the Item at each node of the
tree.
-
TOOLTIP_TEXT
- The property <prefix>.toolTipText specifies the
string to be displayed as the ToolTip text for each node in the tree.
-
TREE
- The property <prefix>.tree<n> is a string
array that specifies the names of the trees to be displayed in the
TreeViewPane.
-
TREEVIEWPANE_PROPERTY_PREFIX
- The String TreeViewPane is used as the prefix for a number of
properties and has been made available to other classes as a
convenience.
-
USE_ASSOC
- The property
<prefix>.<treename>.level<n>.useAssoc
specifies whether to use an Association or a Category at this level
of the tree.
TEXT_COLOR
public static final String TEXT_COLOR
- The property <prefix>.textColor specifies the
color to be used to display the name of the Item at each node of the
tree.
SELECT_COLOR
public static final String SELECT_COLOR
- The property <prefix>.selectColor specifies the
color to be used as the background of the selected Item in the tree.
ROOT_FONT
public static final String ROOT_FONT
- The property <prefix>.rootFont specifies the
name of the font to be used to display the name of the Item at the
root node of the tree.
CHILD_FONT
public static final String CHILD_FONT
- The property <prefix>.childFont specifies the
name of the font to be used to display the name of all Items in the
tree (except for the Item at the root of the tree).
CELL_BORDER_HEIGHT
public static final String CELL_BORDER_HEIGHT
- The property <prefix>.cellBorderHeight
specifies the height, in points, of the border around each Item in
the tree.
CELL_BORDER_WIDTH
public static final String CELL_BORDER_WIDTH
- The property <prefix>.cellBorderWidth specifies
the width, in points, of the border around each Item in the tree.
ICON_WIDTH
public static final String ICON_WIDTH
- The property <prefix>.iconWidth specifies the
width, in points, of the icon to be displayed at each node of the
tree.
ICON_HEIGHT
public static final String ICON_HEIGHT
- The property <prefix>.iconHeight specifies the
height, in points, of the icon to be displayed at each node of the
tree.
TREE
public static final String TREE
- The property <prefix>.tree<n> is a string
array that specifies the names of the trees to be displayed in the
TreeViewPane. One tree can be displayed at a time.
SHOW_ROOT
public static final String SHOW_ROOT
- The property
<prefix>.<treename>.showRoot is a boolean
which specifies whether the root node in the tree is to be displayed
when this tree is displayed.
LEVEL
public static final String LEVEL
- The property
<prefix>.<treename>.level<n> is a
string array which specifies the package-qualified names of the
Categories of Items to be displayed at each level of the tree.
<treename> must have been specified using the TREE property. These Category names are used to
find the BLINK, STATE_ATTR, ITEM_COMPARATOR, DISPLAY_ATTR, and DISPLAY_ATTR_ARG properties.
USE_ASSOC
public static final String USE_ASSOC
- The property
<prefix>.<treename>.level<n>.useAssoc
specifies whether to use an Association or a Category at this level
of the tree. If it is necessary to use a Category instead of an
Association at a given level in the tree, specify it by setting the
following property:
<prefix>.<treename>.level<n>.useAssoc = false
ROOT_FILTER_ATTR
public static final String ROOT_FILTER_ATTR
- The property
<prefix>.<treename>.level<n>.rootFilterAttr
is only used if USE_ASSOC is false. If so,
ROOT_FILTER_ATTR specifies the name of an Attribute of the
rootItem. If the value of that Attribute of the root Item of
the tree matches the value of that Attribute in each Item in the
Category, then the Item is added to the tree.
ITEM_TESTER
public static final String ITEM_TESTER
- The property
<prefix>.<treename>.itemTester
specifies the package-qualified name of a class which implements the
ItemComparator interface for a given category. The class is used to
compare two Items in a Category in order to sort the Items in the
tree.
- See Also:
- ItemTester
TOOLTIP_TEXT
public static final String TOOLTIP_TEXT
- The property <prefix>.toolTipText specifies the
string to be displayed as the ToolTip text for each node in the tree.
BACKGROUND
public static final String BACKGROUND
- The property <prefix>.background specifies the
color to be used as the background for the TreeViewPane.
OPENED_ICON
public static final String OPENED_ICON
- The property <prefix>.openedIcon specifies the
package-qualified name of the icon to display when a node in the tree
has children and those children are visible, that is, when the node
is open.
CLOSED_ICON
public static final String CLOSED_ICON
- The property <prefix>.closedIcon specifies the
package-qualified name of the icon to display when a node in the tree
has children and those children are not visible, that is, when the
node is closed.
PANE_WIDTH
public static final String PANE_WIDTH
- The property <prefix>.width specifies the
default width, in points, of the tree pane.
PANE_HEIGHT
public static final String PANE_HEIGHT
- The property <prefix>.height specifies the
default height, in points, of the tree pane.
ITEM_COMPARATOR
public static final String ITEM_COMPARATOR
- The property
<prefix>.<categoryname>.itemComparator
specifies the package-qualified name of a class which implements the
ItemComparator interface for a given category. The class is used to
compare two Items in a Category in order to sort the Items in the
tree.
- See Also:
- ItemComparator
TREEVIEWPANE_PROPERTY_PREFIX
public static final String TREEVIEWPANE_PROPERTY_PREFIX
- The String TreeViewPane is used as the prefix for a number of
properties and has been made available to other classes as a
convenience.
All Packages Class Hierarchy This Package Previous Next Index