OdsxFilteredTreeNode

java.lang.Object
- com.highqsoft.fwk.Fwk
- - com.highqsoft.fwk.FwkDescription
  - - com.highqsoft.fwk.FwkPropertyChange
    - - com.highqsoft.fwk.FwkPersistence
      - com.highqsoft.odsx.OdsxFilteredTreeNode

All Implemented Interfaces:

FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInstructionInterface, FwkInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkPropertyChangeListenerInterface, FwkTransferableInterface, FwkVetoableChangeInterface, OdsxSelectorTreeNodeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.util.EventListener, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode
```
public class OdsxFilteredTreeNode
extends FwkPersistence
implements java.lang.Cloneable, javax.swing.tree.MutableTreeNode, java.io.Serializable, OdsxSelectorTreeNodeInterface
```
A OdsxFilteredTreeNode is a node in a tree data structure that is able to filter its children.
A tree node may have at most one parent and 0 or more children. OdsxFilteredTreeNode provides operations for examining and modifying a node's parent and children and also operations for examining the tree that the node is a part of. A node's tree is the set of all nodes that can be reached by starting at the node and following all the possible links to parents and children. A node with no parent is the root of its tree; a node with no children is a leaf. A tree may consist of many subtrees, each node acting as the root for its own subtree.
This class provides enumerations for efficiently traversing a tree or subtree in various orders or for following the path between two nodes. A OdsxFilteredTreeNode may also hold a reference to a user object, the use of which is left to the user. Asking a OdsxFilteredTreeNode for its string representation with toString() returns the string representation of its user object.

Since:

$Date: 2017/04/06 13:29:49 $

Version:

$Revision: 1.19 $

Author:

Andreas Hofmann

See Also:
javax.swing.tree.OdsxFilteredTreeNode, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowsChildren` true if the node is able to have children
`protected java.util.Vector`	`children` array of children, may be null if this node has no children
`static java.util.Enumeration`	`EMPTY_ENUMERATION` An enumeration that is always empty.
`protected boolean`	`isLeaf`
`protected boolean`	`isLoaded`
`protected OdsxFilterInterface`	`odsFilter` The optional filter.
`protected OdsxSelectorInterface`	`odsSelector` The ods selector.
`protected OdsxSelectorTreeNodeInterface`	`parent` This node's parent, or null if this node has no parent
`protected OdsxPresentableElementInterface`	`presentable` the presetable element.
`protected java.lang.Object`	`userObject` The optional user value.
`static java.lang.String`	`version`
`protected OdsxSelectorTreeNodeInterface[]`	`visibleChildren` The array containing the visible children.

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange
source

Fields inherited from class com.highqsoft.fwk.FwkDescription
author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface
AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Constructor Summary

Constructors
Constructor and Description
`OdsxFilteredTreeNode()` Creates a tree node that has no parent and no children, but which allows children.
`OdsxFilteredTreeNode(OdsxPresentableElementInterface presentable)` Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
`OdsxFilteredTreeNode(OdsxPresentableElementInterface presentable, OdsxFilterInterface odsFilter)` Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
`OdsxFilteredTreeNode(OdsxPresentableElementInterface presentable, OdsxFilterInterface odsFilter, OdsxSelectorInterface odsSelector)` Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
`OdsxFilteredTreeNode(OdsxPresentableElementInterface presentable, OdsxFilterInterface odsFilter, OdsxSelectorInterface odsSelector, boolean allowsChildren)` Creates a tree node with no parent, no children, initialized with the specified user object, and that allows children only if specified.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(OdsxFilteredTreeNode newChild)` Removes `newChild` from its parent and makes it a child of this node by adding it to the end of this node's child array.
`void`	`addCommand(FwkCommandInterface command)` Add the command to the command array.
`void`	`addCommand(int index, FwkCommandInterface command)` Insert a command at the specified position.
`void`	`addToGroup(int index, java.lang.String groupIdent, java.lang.String commandName)` Add a command to a group.
`void`	`addToGroup(java.lang.String groupIdent, java.lang.String commandName)` Add a command to a group.
`java.util.Enumeration`	`breadthFirstEnumeration()` Creates and returns an enumeration that traverses the subtree rooted at this node in breadth-first order.
`java.util.Enumeration`	`children()` Creates and returns a forward-order enumeration of this node's children.
`java.lang.Object`	`clone()` Overridden to make clone public.
`boolean`	`commandsAvailable()` This method returns a boolean that indicates whether the command array is initialized.
`int`	`compareTo(java.lang.Object obj)` Compare object.
`void`	`delete(boolean flag)` Delete a node.
`void`	`deleteGroup(java.lang.String groupIdent)` Delete command group.
`java.util.Enumeration`	`depthFirstEnumeration()` Creates and returns an enumeration that traverses the subtree rooted at this node in depth-first order.
`boolean`	`equals(java.lang.Object o)`
`void`	`firePropertyChange(java.lang.String propName)` Fire a property change using the root node.
`boolean`	`getAllowsChildren()` Returns true if this node is allowed to have children.
`java.lang.String`	`getAuthor()` Get the author name.
`java.lang.String`	`getBuild()` Get the build number.
`javax.swing.tree.TreeNode`	`getChildAfter(javax.swing.tree.TreeNode aChild)` Returns the child in this node's child array that immediately follows `aChild`, which must be a child of this node.
`javax.swing.tree.TreeNode`	`getChildAt(int index)` Returns the child at the specified index in this node's child array.
`javax.swing.tree.TreeNode`	`getChildBefore(javax.swing.tree.TreeNode aChild)` Returns the child in this node's child array that immediately precedes `aChild`, which must be a child of this node.
`int`	`getChildCount()` Returns the number of children of this node.
`int`	`getChildIndexByPath(javax.swing.tree.TreePath path)` Get child index by path
`java.awt.Color`	`getColor()` Get the color of the item.
`FwkCommandInterface`	`getCommand(java.lang.String commandName)` Return the command that matches the given command name.
`FwkCommandInterface[]`	`getCommands()` Retrieve the command array of the component.
`java.lang.String`	`getCompany()` Get the company name.
`java.lang.String`	`getCompanyInternetAddress()` Get the internet address of the company.
`java.lang.String`	`getCopyright()` Get the copyright.
`java.lang.String`	`getCreationDate()` Get the creation date.
`java.lang.String`	`getCreationDate(java.lang.String formatString)` Get the creation date.
`java.lang.String`	`getDateFormatString()` Get the date format string.
`int`	`getDepth()` Returns the depth of the tree rooted at this node -- the longest distance from this node to a leaf.
`java.lang.String`	`getDescription()` Get the description.
`OdsxFilterInterface`	`getFilter()` Returns this node's filter.
`javax.swing.tree.TreeNode`	`getFirstChild()` Returns this node's first child.
`OdsxFilteredTreeNode`	`getFirstLeaf()` Finds and returns the first leaf that is a descendant of this node -- either this node or its first child's first leaf.
`FwkCommandInterface[]`	`getGroup(java.lang.String groupIdent)` Retrieve the command group.
`FwkIconInterface`	`getIcon()` Get the icon image.
`FwkIconInterface`	`getIcon(int type)` Get the image icon of the application
`java.lang.String`	`getIconKey()` Get the property keyword of the icon.
`java.lang.String`	`getIconKey(int type)` Get the property keyword of the icon.
`int`	`getIndex(javax.swing.tree.TreeNode aChild)` Returns the index of the specified child in this node's child array.
`javax.swing.tree.TreeNode`	`getLastChild()` Returns this node's last child.
`OdsxFilteredTreeNode`	`getLastLeaf()` Finds and returns the last leaf that is a descendant of this node -- either this node or its last child's last leaf.
`int`	`getLeafCount()` Returns the total number of leaves that are descendants of this node.
`int`	`getLevel()` Returns the number of levels above this node -- the distance from the root to this node.
`java.lang.String`	`getName()` Return the name of the ASAM-FWK object.
`OdsxFilteredTreeNode`	`getNextLeaf()` Returns the leaf after this node or null if this node is the last leaf in the tree.
`OdsxFilteredTreeNode`	`getNextNode()` Returns the node that follows this node in a preorder traversal of this node's tree.
`OdsxFilteredTreeNode`	`getNextSibling()` Returns the next sibling of this node in the parent's children array.
`javax.swing.tree.TreeNode`	`getParent()` Returns this node's parent or null if this node has no parent.
`javax.swing.tree.TreeNode[]`	`getPath()` Returns the path from the root, to get to this node.
`protected javax.swing.tree.TreeNode[]`	`getPathToRoot(javax.swing.tree.TreeNode aNode, int depth)` Builds the parents of node up to and including the root node, where the original node is the last element in the returned array.
`OdsxPresentableElementInterface`	`getPresentableElement()` Returns this node's presentable element.
`java.lang.Object[]`	`getPresentablePath()` Returns the presentable path, from the root, to get to this node.
`java.lang.String`	`getPresentationString()` Retrieves the representation string.
`java.lang.String`	`getPresentationString(java.util.Locale locale)` Retrieves the representation string.
`OdsxFilteredTreeNode`	`getPreviousLeaf()` Returns the leaf before this node or null if this node is the first leaf in the tree.
`OdsxFilteredTreeNode`	`getPreviousNode()` Returns the node that precedes this node in a preorder traversal of this node's tree.
`OdsxFilteredTreeNode`	`getPreviousSibling()` Returns the previous sibling of this node in the parent's children array.
`javax.swing.tree.TreeNode`	`getRoot()` Returns the root of the tree that contains this node.
`javax.swing.tree.TreeNode`	`getSharedAncestor(OdsxFilteredTreeNode aNode)` Returns the nearest common ancestor to this node and `aNode`.
`int`	`getSiblingCount()` Returns the number of siblings of this node.
`java.lang.String`	`getSupportEMail()` Get the support e-mail.
`java.lang.String`	`getTitle()` Get the title.
`java.lang.String`	`getTitleName()` Get the title name.
`java.lang.String`	`getTranslatedName()` Returns the filtered name of the element.
`java.lang.Object`	`getUserObject()` Returns this node's userObject.
`java.lang.Object[]`	`getUserObjectPath()` Returns the user object path, from the root, to get to this node.
`java.lang.String`	`getVersion()` Return the version string of the FWK component.
`boolean`	`groupExists(java.lang.String groupIdent)` Check whether a group exists.
`void`	`insert(javax.swing.tree.MutableTreeNode newChild, int childIndex)` Inserts `newChild` to its present parent (if it has a parent), sets the child's parent to this node, and then adds the child to this node's child array at index `childIndex`.
`boolean`	`isApplicationElement()` Return a boolean whether the node implements OdsxApplicationElementInterface.
`boolean`	`isColumn()` Return a boolean whether the node implements OdsxColumnInterface.
`boolean`	`isEnabled()` Check if the element is enabled by this filter.
`boolean`	`isInstanceElement()` Return a boolean whether the node implements OdsxInstanceElementInterface.
`boolean`	`isLeaf()` Return whether the current node is a leaf.
`boolean`	`isLoaded()` Return whether the current node is already loaded.
`boolean`	`isNodeAncestor(javax.swing.tree.TreeNode anotherNode)` Returns true if `anotherNode` is an ancestor of this node -- if it is this node, this node's parent, or an ancestor of this node's parent.
`boolean`	`isNodeChild(javax.swing.tree.TreeNode aNode)` Returns true if `aNode` is a child of this node.
`boolean`	`isNodeDescendant(OdsxFilteredTreeNode anotherNode)` Returns true if `anotherNode` is a descendant of this node -- if it is this node, one of this node's children, or a descendant of one of this node's children.
`boolean`	`isNodeRelated(OdsxFilteredTreeNode aNode)` Returns true if and only if `aNode` is in the same tree as this node.
`boolean`	`isNodeSibling(javax.swing.tree.TreeNode anotherNode)` Returns true if `anotherNode` is a sibling of (has the same parent as) this node.
`boolean`	`isRoot()` Returns true if this node is the root of the tree.
`boolean`	`isSessionElement()` Return a boolean whether the node implements OdsxSessionElementInterface.
`boolean`	`isVisible()` Check if the element is visible by this filter.
`protected void`	`loadChildren()` Messaged the first time getChildCount is messaged.
`protected void`	`loadVisibleChildren()` The private method to determine the list of visible children.
`static void`	`main(java.lang.String[] args)` The Main body to test the class.
`java.util.Enumeration`	`pathFromAncestorEnumeration(javax.swing.tree.TreeNode ancestor)` Creates and returns an enumeration that follows the path from `ancestor` to this node.
`java.util.Enumeration`	`postorderEnumeration()` Creates and returns an enumeration that traverses the subtree rooted at this node in postorder.
`java.util.Enumeration`	`preorderEnumeration()` Creates and returns an enumeration that traverses the subtree rooted at this node in preorder.
`void`	`propertyChange(java.beans.PropertyChangeEvent ev)` The propertyChange clallback.
`void`	`reloadChildren()` Reload the children.
`void`	`reloadChildren(boolean enforce)` Reload the children.
`void`	`remove(int childIndex)` Removes the child at the specified index from this node's children and sets that node's parent to null.
`void`	`remove(javax.swing.tree.MutableTreeNode aChild)` Removes `aChild` from this node's child array, giving it a null parent.
`void`	`removeAllChildren()` Removes all of this node's children, setting their parents to null.
`void`	`removeCommand(FwkCommandInterface command)` Remove a sub-command.
`void`	`removeFromGroup(java.lang.String groupIdent, java.lang.String commandName)` Remove a command from a group.
`void`	`removeFromParent()` Removes the subtree rooted at this node from the tree, giving this node a null parent.
`void`	`setAllowsChildren(boolean allows)` Determines whether or not this node is allowed to have children.
`void`	`setAuthor(java.lang.String author)` Set the author name.
`void`	`setBuild(java.lang.String buildnr)` Set the build number.
`void`	`setColor(java.awt.Color color)` Set the color of the item.
`protected void`	`setCommandProperties(FwkCommandInterface[] commands)` Set the command properties.
`void`	`setCommands(FwkCommandInterface[] commands)` Set the sub-commands of the command.
`void`	`setCompany(java.lang.String company)` Set the company name.
`void`	`setCompanyInternetAddress(java.lang.String address)` Set the internet address of the company.
`void`	`setCopyright(java.lang.String copyright)` Set the copyright.
`void`	`setCreationDate(java.lang.String dateString, java.lang.String formatString)` Set the Date of the application.
`void`	`setDateFormatString(java.lang.String formatString)` Set the Date format string.
`void`	`setDescription(java.lang.String description)` Set the description of the application.
`void`	`setDescriptor(FwkDescriptionInterface descriptor)` Initialize the object with values of the given FwkDescription.
`void`	`setFilter(OdsxFilterInterface odsFilter)` Sets the ods filter for this node.
`void`	`setFilter(OdsxFilterInterface odsFilter, boolean flag)` Sets the ods filter for this node.
`void`	`setIcon(FwkIconInterface icon)` Set the icon image.
`void`	`setIcon(FwkIconInterface icon, int type)` Set the image icon of the application
`void`	`setIconKey(java.lang.String key)` Set the property keyword of the icon.
`void`	`setIconKey(java.lang.String key, int type)` Set the property keyword of the icon.
`void`	`setName(java.lang.String name)` Set the name of the ASAM-FWK object.
`void`	`setParent(javax.swing.tree.MutableTreeNode newParent)` Sets this node's parent to `newParent` but does not change the parent's child array.
`void`	`setPresentableElement(OdsxPresentableElementInterface presentable)` Sets the presentable element for this node to `presentable`.
`void`	`setSupportEMail(java.lang.String eMail)` Get the support e-mail.
`void`	`setTitleName(java.lang.String titlename)` Set the title name of the application.
`void`	`setTranslatedName(java.lang.String value)` Returns the filtered name of the element.
`void`	`setUserObject(java.lang.Object userObject)` Sets the user object for this node to `userObject`.
`void`	`setVisible(boolean flag)` Set the visibility of the node.
`java.lang.String`	`toString()` Returns the result of sending `toString()` to this node's user object, or null if this node has no user object.
`void`	`updateNode()` Update node

Methods inherited from class com.highqsoft.fwk.FwkDescription
getClassName, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate

Methods inherited from class com.highqsoft.fwk.Fwk
getNiceVersion, release

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface
clearCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface
release

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface
getClassName, setClassName, setCreationDate

Methods inherited from interface java.awt.datatransfer.Transferable
getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner
lostOwnership

- Field Detail
  - version
```
public static final java.lang.String version
```
    See Also:
    Constant Field Values
  - EMPTY_ENUMERATION
```
public static final java.util.Enumeration EMPTY_ENUMERATION
```
    An enumeration that is always empty. This is used when an enumeration of a leaf node's children is requested.
  - parent
```
protected OdsxSelectorTreeNodeInterface parent
```
    This node's parent, or null if this node has no parent
  - children
```
protected java.util.Vector children
```
    array of children, may be null if this node has no children
  - visibleChildren
```
protected OdsxSelectorTreeNodeInterface[] visibleChildren
```
    The array containing the visible children.
  - presentable
```
protected transient OdsxPresentableElementInterface presentable
```
    the presetable element.
  - odsSelector
```
protected OdsxSelectorInterface odsSelector
```
    The ods selector.
  - userObject
```
protected java.lang.Object userObject
```
    The optional user value.
  - odsFilter
```
protected OdsxFilterInterface odsFilter
```
    The optional filter.
  - allowsChildren
```
protected boolean allowsChildren
```
    true if the node is able to have children
  - isLeaf
```
protected boolean isLeaf
```
  - isLoaded
```
protected boolean isLoaded
```
- Constructor Detail
  - OdsxFilteredTreeNode
```
public OdsxFilteredTreeNode()
```
    Creates a tree node that has no parent and no children, but which allows children.
  - OdsxFilteredTreeNode
```
public OdsxFilteredTreeNode(OdsxPresentableElementInterface presentable)
```
    Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
    
    Parameters:
    presentable - the presentable element.
  - OdsxFilteredTreeNode
```
public OdsxFilteredTreeNode(OdsxPresentableElementInterface presentable,
                    OdsxFilterInterface odsFilter)
```
    Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object. The children will be filtered by the specified filter.
    
    Parameters:
    presentable - the presentable element.
    odsFilter - the filter
  - OdsxFilteredTreeNode
```
public OdsxFilteredTreeNode(OdsxPresentableElementInterface presentable,
                    OdsxFilterInterface odsFilter,
                    OdsxSelectorInterface odsSelector)
```
    Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object. The children will be filtered by the specified filter.
    
    Parameters:
    presentable - the presentable element.
    odsFilter - the filter
    odsSelector - the ods selector
  - OdsxFilteredTreeNode
```
public OdsxFilteredTreeNode(OdsxPresentableElementInterface presentable,
                    OdsxFilterInterface odsFilter,
                    OdsxSelectorInterface odsSelector,
                    boolean allowsChildren)
```
    Creates a tree node with no parent, no children, initialized with the specified user object, and that allows children only if specified. The children will be filtered by the specified filter.
    
    Parameters:
    presentable - the presentable element
    odsFilter - the filter
    odsSelector - the ods selector
    allowsChildren - if true, the node is allowed to have child nodes -- otherwise, it is always a leaf node
- Method Detail
  - getVersion
```
public java.lang.String getVersion()
```
    Description copied from interface: FwkInterface
    
    Return the version string of the FWK component.
    
    Specified by:
    
    getVersion in interface FwkInterface
    
    Overrides:
    
    getVersion in class FwkPersistence
  - firePropertyChange
```
public void firePropertyChange(java.lang.String propName)
```
    Fire a property change using the root node.
    
    Parameters:
    the - property name.
  - setColor
```
public void setColor(java.awt.Color color)
```
    Set the color of the item.
    
    Specified by:
    
    setColor in interface OdsxSelectorTreeNodeInterface
    
    Parameters:
    color - The new color of the element.
  - getColor
```
public java.awt.Color getColor()
```
    Get the color of the item.
    
    Specified by:
    
    getColor in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    The current solor of the element.
  - isEnabled
```
public boolean isEnabled()
```
    Check if the element is enabled by this filter.
    
    Specified by:
    
    isEnabled in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    True if the element passes the filter.
  - isVisible
```
public boolean isVisible()
```
    Check if the element is visible by this filter.
    
    Specified by:
    
    isVisible in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    True if the element is visible.
  - setVisible
```
public void setVisible(boolean flag)
```
    Set the visibility of the node.
    
    Specified by:
    
    setVisible in interface OdsxSelectorTreeNodeInterface
    
    Parameters:
    flag - true if the node should be visible.
  - getTranslatedName
```
public java.lang.String getTranslatedName()
```
    Returns the filtered name of the element.
    
    Specified by:
    
    getTranslatedName in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    The filtered name value.
  - setTranslatedName
```
public void setTranslatedName(java.lang.String value)
```
    Returns the filtered name of the element.
    
    Specified by:
    
    setTranslatedName in interface OdsxSelectorTreeNodeInterface
    
    Parameters:
    value - The new translated name of the element.
  - isInstanceElement
```
public boolean isInstanceElement()
```
    Return a boolean whether the node implements OdsxInstanceElementInterface.
    
    Specified by:
    
    isInstanceElement in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    true if the node is an instance element.
  - isColumn
```
public boolean isColumn()
```
    Return a boolean whether the node implements OdsxColumnInterface.
    
    Specified by:
    
    isColumn in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    true if the node is an instance element.
  - isApplicationElement
```
public boolean isApplicationElement()
```
    Return a boolean whether the node implements OdsxApplicationElementInterface.
    
    Specified by:
    
    isApplicationElement in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    true if the node is an application element.
  - isSessionElement
```
public boolean isSessionElement()
```
    Return a boolean whether the node implements OdsxSessionElementInterface.
    
    Specified by:
    
    isSessionElement in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    true if the node is an application element.
  - delete
```
public void delete(boolean flag)
```
    Delete a node.
    
    Specified by:
    
    delete in interface OdsxSelectorTreeNodeInterface
    
    Parameters:
    flag - true if the element should be deleted with references.
  - isLeaf
```
public boolean isLeaf()
```
    Return whether the current node is a leaf. This value is always false until the loading of children fails.
    
    Specified by:
    
    isLeaf in interface OdsxSelectorTreeNodeInterface
    
    Specified by:
    
    isLeaf in interface javax.swing.tree.TreeNode
    
    Returns:
    isLeaf The flag indicating if the current node is a leaf.
  - isLoaded
```
public boolean isLoaded()
```
    Return whether the current node is already loaded. This value is always false until the loading of children.
    
    Returns:
    true if the node is loaded.
  - loadChildren
```
protected void loadChildren()
```
    Messaged the first time getChildCount is messaged.
  - insert
```
public void insert(javax.swing.tree.MutableTreeNode newChild,
          int childIndex)
```
    Inserts newChild to its present parent (if it has a parent), sets the child's parent to this node, and then adds the child to this node's child array at index childIndex. newChild must not be null and must not be an ancestor of this node.
    
    Specified by:
    
    insert in interface javax.swing.tree.MutableTreeNode
    
    Parameters:
    newChild - the OdsxFilteredTreeNode to insert under this node
    childIndex - the index in this node's child array where this node is to be inserted
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if childIndex is out of bounds
    
    java.lang.IllegalArgumentException - if newChild is null or is an ancestor of this node
    
    java.lang.IllegalStateException - if this node does not allow children
    See Also:
    isNodeDescendant(com.highqsoft.odsx.OdsxFilteredTreeNode)
  - remove
```
public void remove(int childIndex)
```
    Removes the child at the specified index from this node's children and sets that node's parent to null. The child node to remove must be a OdsxFilteredTreeNode.
    
    Specified by:
    
    remove in interface javax.swing.tree.MutableTreeNode
    
    Parameters:
    childIndex - the index in this node's child array of the child to remove
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if childIndex is out of bounds
  - setParent
```
public void setParent(javax.swing.tree.MutableTreeNode newParent)
```
    Sets this node's parent to newParent but does not change the parent's child array. This method is called from insert() and remove() to reassign a child's parent, it should not be messaged from anywhere else.
    
    Specified by:
    
    setParent in interface javax.swing.tree.MutableTreeNode
    
    Parameters:
    newParent - this node's new parent
  - getParent
```
public javax.swing.tree.TreeNode getParent()
```
    Returns this node's parent or null if this node has no parent.
    
    Specified by:
    
    getParent in interface javax.swing.tree.TreeNode
    
    Returns:
    this node's parent TreeNode, or null if this node has no parent
  - loadVisibleChildren
```
protected void loadVisibleChildren()
```
    The private method to determine the list of visible children.
  - updateNode
```
public void updateNode()
```
    Update node
    
    Specified by:
    
    updateNode in interface OdsxSelectorTreeNodeInterface
  - reloadChildren
```
public void reloadChildren()
```
    Reload the children.
    
    Specified by:
    
    reloadChildren in interface OdsxSelectorTreeNodeInterface
  - reloadChildren
```
public void reloadChildren(boolean enforce)
```
    Reload the children.
    
    Specified by:
    
    reloadChildren in interface OdsxSelectorTreeNodeInterface
    
    Parameters:
    force - if true force the loading.
  - getChildAt
```
public javax.swing.tree.TreeNode getChildAt(int index)
```
    Returns the child at the specified index in this node's child array.
    
    Specified by:
    
    getChildAt in interface javax.swing.tree.TreeNode
    
    Parameters:
    index - an index into this node's child array
    
    Returns:
    the TreeNode in this node's child array at the specified index
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds
  - getChildCount
```
public int getChildCount()
```
    Returns the number of children of this node.
    
    Specified by:
    
    getChildCount in interface javax.swing.tree.TreeNode
    
    Returns:
    an int giving the number of children of this node
  - getIndex
```
public int getIndex(javax.swing.tree.TreeNode aChild)
```
    Returns the index of the specified child in this node's child array. If the specified node is not a child of this node, returns -1. This method performs a linear search and is O(n) where n is the number of children.
    
    Specified by:
    
    getIndex in interface javax.swing.tree.TreeNode
    
    Parameters:
    aChild - the TreeNode to search for among this node's children
    
    Returns:
    an int giving the index of the node in this node's child array, or -1 if the specified node is a not a child of this node
    
    Throws:
    
    java.lang.IllegalArgumentException - if aChild is null
  - children
```
public java.util.Enumeration children()
```
    Creates and returns a forward-order enumeration of this node's children. Modifying this node's child array invalidates any child enumerations created before the modification.
    
    Specified by:
    
    children in interface javax.swing.tree.TreeNode
    
    Returns:
    an Enumeration of this node's children
  - setAllowsChildren
```
public void setAllowsChildren(boolean allows)
```
    Determines whether or not this node is allowed to have children. If allows is false, all of this node's children are removed.
    Note: By default, a node allows children.
    
    Parameters:
    allows - true if this node is allowed to have children
  - getAllowsChildren
```
public boolean getAllowsChildren()
```
    Returns true if this node is allowed to have children.
    
    Specified by:
    
    getAllowsChildren in interface javax.swing.tree.TreeNode
    
    Returns:
    true if this node allows children, else false
  - setPresentableElement
```
public void setPresentableElement(OdsxPresentableElementInterface presentable)
```
    Sets the presentable element for this node to presentable.
    
    Specified by:
    
    setPresentableElement in interface OdsxSelectorTreeNodeInterface
    
    Parameters:
    presentable - the presentable element.
    See Also:
    #getPresentable, toString()
  - getPresentableElement
```
public OdsxPresentableElementInterface getPresentableElement()
```
    Returns this node's presentable element.
    
    Specified by:
    
    getPresentableElement in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    the presentable element stored at this node by the user
    See Also:
    #setPresentable, toString()
  - setFilter
```
public void setFilter(OdsxFilterInterface odsFilter)
```
    Sets the ods filter for this node.
    
    Specified by:
    
    setFilter in interface OdsxSelectorTreeNodeInterface
    
    Parameters:
    filter - the ods filter.
    See Also:
    getFilter()
  - setFilter
```
public void setFilter(OdsxFilterInterface odsFilter,
             boolean flag)
```
    Sets the ods filter for this node.
    
    Specified by:
    
    setFilter in interface OdsxSelectorTreeNodeInterface
    
    Parameters:
    filter - the ods filter.
    flag - if true the filter will be set recurtsivly.
    See Also:
    getFilter()
  - getFilter
```
public OdsxFilterInterface getFilter()
```
    Returns this node's filter.
    
    Specified by:
    
    getFilter in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    the OdsxFilter belongs to that node.
    See Also:
    setFilter(com.highqsoft.interfaces.odsx.OdsxFilterInterface)
  - setUserObject
```
public void setUserObject(java.lang.Object userObject)
```
    Sets the user object for this node to userObject.
    
    Specified by:
    
    setUserObject in interface javax.swing.tree.MutableTreeNode
    
    Parameters:
    userObject - the user value.
    See Also:
    getUserObject()
  - getUserObject
```
public java.lang.Object getUserObject()
```
    Returns this node's userObject.
    
    Returns:
    the Object stored at this node by the user
    See Also:
    setUserObject(java.lang.Object)
  - removeFromParent
```
public void removeFromParent()
```
    Removes the subtree rooted at this node from the tree, giving this node a null parent. Does nothing if this node is the root of its tree.
    
    Specified by:
    
    removeFromParent in interface javax.swing.tree.MutableTreeNode
  - remove
```
public void remove(javax.swing.tree.MutableTreeNode aChild)
```
    Removes aChild from this node's child array, giving it a null parent.
    
    Specified by:
    
    remove in interface javax.swing.tree.MutableTreeNode
    
    Parameters:
    aChild - a child of this node to remove
    
    Throws:
    
    java.lang.IllegalArgumentException - if aChild is null or is not a child of this node
  - removeAllChildren
```
public void removeAllChildren()
```
    Removes all of this node's children, setting their parents to null. If this node has no children, this method does nothing.
  - add
```
public void add(OdsxFilteredTreeNode newChild)
```
    Removes newChild from its parent and makes it a child of this node by adding it to the end of this node's child array.
    
    Parameters:
    newChild - node to add as a child of this node
    
    Throws:
    
    java.lang.IllegalArgumentException - if newChild is null
    
    java.lang.IllegalStateException - if this node does not allow children
    See Also:
    insert(javax.swing.tree.MutableTreeNode, int)
  - isNodeAncestor
```
public boolean isNodeAncestor(javax.swing.tree.TreeNode anotherNode)
```
    Returns true if anotherNode is an ancestor of this node -- if it is this node, this node's parent, or an ancestor of this node's parent. (Note that a node is considered an ancestor of itself.) If anotherNode is null, this method returns false. This operation is at worst O(h) where h is the distance from the root to this node.
    
    Parameters:
    anotherNode - node to test as an ancestor of this node
    
    Returns:
    true if this node is a descendant of anotherNode
    See Also:
    isNodeDescendant(com.highqsoft.odsx.OdsxFilteredTreeNode), getSharedAncestor(com.highqsoft.odsx.OdsxFilteredTreeNode)
  - isNodeDescendant
```
public boolean isNodeDescendant(OdsxFilteredTreeNode anotherNode)
```
    Returns true if anotherNode is a descendant of this node -- if it is this node, one of this node's children, or a descendant of one of this node's children. Note that a node is considered a descendant of itself. If anotherNode is null, returns false. This operation is at worst O(h) where h is the distance from the root to anotherNode.
    
    Parameters:
    anotherNode - node to test as descendant of this node
    
    Returns:
    true if this node is an ancestor of anotherNode
    See Also:
    isNodeAncestor(javax.swing.tree.TreeNode), getSharedAncestor(com.highqsoft.odsx.OdsxFilteredTreeNode)
  - getSharedAncestor
```
public javax.swing.tree.TreeNode getSharedAncestor(OdsxFilteredTreeNode aNode)
```
    Returns the nearest common ancestor to this node and aNode. Returns null, if no such ancestor exists -- if this node and aNode are in different trees or if aNode is null. A node is considered an ancestor of itself.
    
    Parameters:
    aNode - node to find common ancestor with
    
    Returns:
    nearest ancestor common to this node and aNode, or null if none
    See Also:
    isNodeAncestor(javax.swing.tree.TreeNode), isNodeDescendant(com.highqsoft.odsx.OdsxFilteredTreeNode)
  - isNodeRelated
```
public boolean isNodeRelated(OdsxFilteredTreeNode aNode)
```
    Returns true if and only if aNode is in the same tree as this node. Returns false if aNode is null.
    
    Returns:
    true if aNode is in the same tree as this node; false if aNode is null
    See Also:
    getSharedAncestor(com.highqsoft.odsx.OdsxFilteredTreeNode), getRoot()
  - getDepth
```
public int getDepth()
```
    Returns the depth of the tree rooted at this node -- the longest distance from this node to a leaf. If this node has no children, returns 0. This operation is much more expensive than getLevel() because it must effectively traverse the entire tree rooted at this node.
    
    Returns:
    the depth of the tree whose root is this node
    See Also:
    getLevel()
  - getLevel
```
public int getLevel()
```
    Returns the number of levels above this node -- the distance from the root to this node. If this node is the root, returns 0.
    
    Returns:
    the number of levels above this node
    See Also:
    getDepth()
  - getPath
```
public javax.swing.tree.TreeNode[] getPath()
```
    Returns the path from the root, to get to this node. The last element in the path is this node.
    
    Returns:
    an array of TreeNode objects giving the path, where the first element in the path is the root and the last element is this node.
  - getPathToRoot
```
protected javax.swing.tree.TreeNode[] getPathToRoot(javax.swing.tree.TreeNode aNode,
                                        int depth)
```
    Builds the parents of node up to and including the root node, where the original node is the last element in the returned array. The length of the returned array gives the node's depth in the tree.
    
    Parameters:
    aNode - the TreeNode to get the path for
    depth - an int giving the number of steps already taken towards the root (on recursive calls), used to size the returned array
    
    Returns:
    an array of TreeNodes giving the path from the root to the specified node
  - getPresentablePath
```
public java.lang.Object[] getPresentablePath()
```
    Returns the presentable path, from the root, to get to this node. If some of the TreeNodes in the path have null user objects, the returned path will contain nulls.
  - getChildIndexByPath
```
public int getChildIndexByPath(javax.swing.tree.TreePath path)
```
    Get child index by path
    
    Specified by:
    
    getChildIndexByPath in interface OdsxSelectorTreeNodeInterface
    
    Returns:
    the child index by given the path of the child.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - getUserObjectPath
```
public java.lang.Object[] getUserObjectPath()
```
    Returns the user object path, from the root, to get to this node. If some of the TreeNodes in the path have null user objects, the returned path will contain nulls.
  - getRoot
```
public javax.swing.tree.TreeNode getRoot()
```
    Returns the root of the tree that contains this node. The root is the ancestor with a null parent.
    
    Returns:
    the root of the tree that contains this node
    See Also:
    isNodeAncestor(javax.swing.tree.TreeNode)
  - isRoot
```
public boolean isRoot()
```
    Returns true if this node is the root of the tree. The root is the only node in the tree with a null parent; every tree has exactly one root.
    
    Returns:
    true if this node is the root of its tree
  - getNextNode
```
public OdsxFilteredTreeNode getNextNode()
```
    Returns the node that follows this node in a preorder traversal of this node's tree. Returns null if this node is the last node of the traversal. This is an inefficient way to traverse the entire tree; use an enumeration, instead.
    
    Returns:
    the node that follows this node in a preorder traversal, or null if this node is last
    See Also:
    preorderEnumeration()
  - getPreviousNode
```
public OdsxFilteredTreeNode getPreviousNode()
```
    Returns the node that precedes this node in a preorder traversal of this node's tree. Returns null if this node is the first node of the traveral -- the root of the tree. This is an inefficient way to traverse the entire tree; use an enumeration, instead.
    
    Returns:
    the node that precedes this node in a preorder traversal, or null if this node is the first
    See Also:
    preorderEnumeration()
  - preorderEnumeration
```
public java.util.Enumeration preorderEnumeration()
```
    Creates and returns an enumeration that traverses the subtree rooted at this node in preorder. The first node returned by the enumeration's nextElement() method is this node.
    Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
    
    Returns:
    an enumeration for traversing the tree in preorder
    See Also:
    postorderEnumeration()
  - postorderEnumeration
```
public java.util.Enumeration postorderEnumeration()
```
    Creates and returns an enumeration that traverses the subtree rooted at this node in postorder. The first node returned by the enumeration's nextElement() method is the leftmost leaf. This is the same as a depth-first traversal.
    Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
    
    Returns:
    an enumeration for traversing the tree in postorder
    See Also:
    depthFirstEnumeration(), preorderEnumeration()
  - breadthFirstEnumeration
```
public java.util.Enumeration breadthFirstEnumeration()
```
    Creates and returns an enumeration that traverses the subtree rooted at this node in breadth-first order. The first node returned by the enumeration's nextElement() method is this node.
    Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
    
    Returns:
    an enumeration for traversing the tree in breadth-first order
    See Also:
    depthFirstEnumeration()
  - depthFirstEnumeration
```
public java.util.Enumeration depthFirstEnumeration()
```
    Creates and returns an enumeration that traverses the subtree rooted at this node in depth-first order. The first node returned by the enumeration's nextElement() method is the leftmost leaf. This is the same as a postorder traversal.
    Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
    
    Returns:
    an enumeration for traversing the tree in depth-first order
    See Also:
    breadthFirstEnumeration(), postorderEnumeration()
  - pathFromAncestorEnumeration
```
public java.util.Enumeration pathFromAncestorEnumeration(javax.swing.tree.TreeNode ancestor)
```
    Creates and returns an enumeration that follows the path from ancestor to this node. The enumeration's nextElement() method first returns ancestor, then the child of ancestor that is an ancestor of this node, and so on, and finally returns this node. Creation of the enumeration is O(m) where m is the number of nodes between this node and ancestor, inclusive. Each nextElement() message is O(1).
    Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
    
    Returns:
    an enumeration for following the path from an ancestor of this node to this one
    
    Throws:
    
    java.lang.IllegalArgumentException - if ancestor is not an ancestor of this node
    See Also:
    isNodeAncestor(javax.swing.tree.TreeNode), isNodeDescendant(com.highqsoft.odsx.OdsxFilteredTreeNode)
  - isNodeChild
```
public boolean isNodeChild(javax.swing.tree.TreeNode aNode)
```
    Returns true if aNode is a child of this node. If aNode is null, this method returns false.
    
    Returns:
    true if aNode is a child of this node; false if aNode is null
  - getFirstChild
```
public javax.swing.tree.TreeNode getFirstChild()
```
    Returns this node's first child. If this node has no children, throws NoSuchElementException.
    
    Returns:
    the first child of this node
    
    Throws:
    
    java.util.NoSuchElementException - if this node has no children
  - getLastChild
```
public javax.swing.tree.TreeNode getLastChild()
```
    Returns this node's last child. If this node has no children, throws NoSuchElementException.
    
    Returns:
    the last child of this node
    
    Throws:
    
    java.util.NoSuchElementException - if this node has no children
  - getChildAfter
```
public javax.swing.tree.TreeNode getChildAfter(javax.swing.tree.TreeNode aChild)
```
    Returns the child in this node's child array that immediately follows aChild, which must be a child of this node. If aChild is the last child, returns null. This method performs a linear search of this node's children for aChild and is O(n) where n is the number of children; to traverse the entire array of children, use an enumeration instead.
    
    Returns:
    the child of this node that immediately follows aChild
    
    Throws:
    
    java.lang.IllegalArgumentException - if aChild is null or is not a child of this node
    See Also:
    children
  - getChildBefore
```
public javax.swing.tree.TreeNode getChildBefore(javax.swing.tree.TreeNode aChild)
```
    Returns the child in this node's child array that immediately precedes aChild, which must be a child of this node. If aChild is the first child, returns null. This method performs a linear search of this node's children for aChild and is O(n) where n is the number of children.
    
    Returns:
    the child of this node that immediately precedes aChild
    
    Throws:
    
    java.lang.IllegalArgumentException - if aChild is null or is not a child of this node
  - isNodeSibling
```
public boolean isNodeSibling(javax.swing.tree.TreeNode anotherNode)
```
    Returns true if anotherNode is a sibling of (has the same parent as) this node. A node is its own sibling. If anotherNode is null, returns false.
    
    Parameters:
    anotherNode - node to test as sibling of this node
    
    Returns:
    true if anotherNode is a sibling of this node
  - getSiblingCount
```
public int getSiblingCount()
```
    Returns the number of siblings of this node. A node is its own sibling (if it has no parent or no siblings, this method returns 1).
    
    Returns:
    the number of siblings of this node
  - getNextSibling
```
public OdsxFilteredTreeNode getNextSibling()
```
    Returns the next sibling of this node in the parent's children array. Returns null if this node has no parent or is the parent's last child. This method performs a linear search that is O(n) where n is the number of children; to traverse the entire array, use the parent's child enumeration instead.
    
    Returns:
    the sibling of this node that immediately follows this node
    See Also:
    children
  - getPreviousSibling
```
public OdsxFilteredTreeNode getPreviousSibling()
```
    Returns the previous sibling of this node in the parent's children array. Returns null if this node has no parent or is the parent's first child. This method performs a linear search that is O(n) where n is the number of children.
    
    Returns:
    the sibling of this node that immediately precedes this node
  - getFirstLeaf
```
public OdsxFilteredTreeNode getFirstLeaf()
```
    Finds and returns the first leaf that is a descendant of this node -- either this node or its first child's first leaf. Returns this node if it is a leaf.
    
    Returns:
    the first leaf in the subtree rooted at this node
    See Also:
    isLeaf, isNodeDescendant(com.highqsoft.odsx.OdsxFilteredTreeNode)
  - getLastLeaf
```
public OdsxFilteredTreeNode getLastLeaf()
```
    Finds and returns the last leaf that is a descendant of this node -- either this node or its last child's last leaf. Returns this node if it is a leaf.
    
    Returns:
    the last leaf in the subtree rooted at this node
    See Also:
    isLeaf, isNodeDescendant(com.highqsoft.odsx.OdsxFilteredTreeNode)
  - getNextLeaf
```
public OdsxFilteredTreeNode getNextLeaf()
```
    Returns the leaf after this node or null if this node is the last leaf in the tree.
    In this implementation of the MutableNode interface, this operation is very inefficient. In order to determine the next node, this method first performs a linear search in the parent's child-list in order to find the current node.
    That implementation makes the operation suitable for short traversals from a known position. But to traverse all of the leaves in the tree, you should use depthFirstEnumeration to enumerate the nodes in the tree and use isLeaf on each node to determine which are leaves.
    
    Returns:
    returns the next leaf past this node
    See Also:
    depthFirstEnumeration(), isLeaf
  - getPreviousLeaf
```
public OdsxFilteredTreeNode getPreviousLeaf()
```
    Returns the leaf before this node or null if this node is the first leaf in the tree.
    In this implementation of the MutableNode interface, this operation is very inefficient. In order to determine the previous node, this method first performs a linear search in the parent's child-list in order to find the current node.
    That implementation makes the operation suitable for short traversals from a known position. But to traverse all of the leaves in the tree, you should use depthFirstEnumeration to enumerate the nodes in the tree and use isLeaf on each node to determine which are leaves.
    
    Returns:
    returns the leaf before this node
    See Also:
    depthFirstEnumeration(), isLeaf
  - getLeafCount
```
public int getLeafCount()
```
    Returns the total number of leaves that are descendants of this node. If this node is a leaf, returns 1. This method is O(n) where n is the number of descendants of this node.
    
    Returns:
    the number of leaves beneath this node
    See Also:
    isNodeAncestor(javax.swing.tree.TreeNode)
  - toString
```
public java.lang.String toString()
```
    Returns the result of sending toString() to this node's user object, or null if this node has no user object.
    
    Overrides:
    
    toString in class FwkDescription
    
    See Also:
    #getPresentable
  - clone
```
public java.lang.Object clone()
```
    Overridden to make clone public. Returns a shallow copy of this node; the new node has no parent or children and has a reference to the same user object, if any.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    a copy of this node
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent ev)
```
    The propertyChange clallback.
    
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
  - compareTo
```
public int compareTo(java.lang.Object obj)
```
    Compare object.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Overrides:
    
    compareTo in class FwkPersistence
    
    Parameters:
    obj - The object that should be compared with this.
    
    Returns:
    The result of the string compare of the names.
  - getAuthor
```
public java.lang.String getAuthor()
```
    Get the author name.
    
    Specified by:
    
    getAuthor in interface FwkDescriptionInterface
    
    Overrides:
    
    getAuthor in class FwkPersistence
    
    Returns:
    The name of the author.
    See Also:
    setAuthor(String)
  - getBuild
```
public java.lang.String getBuild()
```
    Get the build number.
    
    Specified by:
    
    getBuild in interface FwkDescriptionInterface
    
    Overrides:
    
    getBuild in class FwkPersistence
    
    Returns:
    The string representing the build number.
    See Also:
    #setBuild(int)
  - getCompany
```
public java.lang.String getCompany()
```
    Get the company name.
    
    Specified by:
    
    getCompany in interface FwkDescriptionInterface
    
    Overrides:
    
    getCompany in class FwkPersistence
    
    Returns:
    The name of the company.
    See Also:
    setCompany(String)
  - getCompanyInternetAddress
```
public java.lang.String getCompanyInternetAddress()
```
    Get the internet address of the company.
    
    Specified by:
    
    getCompanyInternetAddress in interface FwkDescriptionInterface
    
    Overrides:
    
    getCompanyInternetAddress in class FwkPersistence
    
    Returns:
    A string containing the internet address of the company.
  - getCopyright
```
public java.lang.String getCopyright()
```
    Get the copyright.
    
    Specified by:
    
    getCopyright in interface FwkDescriptionInterface
    
    Overrides:
    
    getCopyright in class FwkPersistence
    
    Returns:
    The copyright string.
    See Also:
    setCopyright(String)
  - getCreationDate
```
public java.lang.String getCreationDate()
```
    Get the creation date.
    
    Specified by:
    
    getCreationDate in interface FwkDescriptionInterface
    
    Overrides:
    
    getCreationDate in class FwkPersistence
    
    Returns:
    The date of the creation.
    See Also:
    #setCreationDate(Date)
  - getCreationDate
```
public java.lang.String getCreationDate(java.lang.String formatString)
```
    Get the creation date.
    
    Specified by:
    
    getCreationDate in interface FwkDescriptionInterface
    
    Overrides:
    
    getCreationDate in class FwkPersistence
    
    Parameters:
    formatString - The date format string
    
    Returns:
    The date of the creation.
    See Also:
    #java.text.SimpleDateFormat, #setCreationDate(Date)
  - getDateFormatString
```
public java.lang.String getDateFormatString()
```
    Get the date format string.
    
    Specified by:
    
    getDateFormatString in interface FwkDescriptionInterface
    
    Overrides:
    
    getDateFormatString in class FwkPersistence
    
    Returns:
    The date format string.
  - getDescription
```
public java.lang.String getDescription()
```
    Get the description.
    
    Specified by:
    
    getDescription in interface FwkDescriptionInterface
    
    Overrides:
    
    getDescription in class FwkPersistence
    
    Returns:
    The description of the application.
    See Also:
    setDescription(String)
  - getIcon
```
public FwkIconInterface getIcon()
```
    Get the icon image.
    
    Specified by:
    
    getIcon in interface FwkDescriptionInterface
    
    Overrides:
    
    getIcon in class FwkPersistence
    
    Returns:
    The icon of the application.
    See Also:
    setIcon(FwkIconInterface)
  - getIcon
```
public FwkIconInterface getIcon(int type)
```
    Get the image icon of the application
    
    Specified by:
    
    getIcon in interface FwkDescriptionInterface
    
    Overrides:
    
    getIcon in class FwkPersistence
    
    Parameters:
    type - The type of the icon, use the predefined values (see above).
    
    Returns:
    Icon
    See Also:
    #setIcon(Icon)
  - getIconKey
```
public java.lang.String getIconKey()
```
    Get the property keyword of the icon.
    
    Specified by:
    
    getIconKey in interface FwkDescriptionInterface
    
    Overrides:
    
    getIconKey in class FwkPersistence
    
    Returns:
    The keyword for the icon.
  - getIconKey
```
public java.lang.String getIconKey(int type)
```
    Get the property keyword of the icon.
    
    Specified by:
    
    getIconKey in interface FwkDescriptionInterface
    
    Overrides:
    
    getIconKey in class FwkPersistence
    
    Parameters:
    type - The type of the icon, use the predefined values (see above).
    
    Returns:
    The keyword for the icon.
  - getName
```
public java.lang.String getName()
```
    Return the name of the ASAM-FWK object.
    
    Specified by:
    
    getName in interface FwkDescriptionInterface
    
    Overrides:
    
    getName in class FwkPersistence
    
    Returns:
    The name of the object.
    See Also:
    FwkPersistence.setName(String)
  - getPresentationString
```
public java.lang.String getPresentationString(java.util.Locale locale)
```
    Retrieves the representation string. The presentation string is a complete representation of the object including its data. This feature is required for copy/paste and drag/drop operations. The locale parameter allows to make the representation string locale language dependent.
    
    Specified by:
    
    getPresentationString in interface FwkDescriptionInterface
    
    Specified by:
    
    getPresentationString in interface FwkPresentationInterface
    
    Overrides:
    
    getPresentationString in class FwkDescription
    
    Parameters:
    locale - The Locale object or null.
    
    Returns:
    The localized presentation string.
  - getPresentationString
```
public java.lang.String getPresentationString()
```
    Retrieves the representation string. The presentation string is a complete representation of the object including its data. This feature is required for copy/paste and drag/drop operations. The locale parameter allows to make the representation string locale language dependent.
    
    Specified by:
    
    getPresentationString in interface FwkDescriptionInterface
    
    Specified by:
    
    getPresentationString in interface FwkPresentationInterface
    
    Overrides:
    
    getPresentationString in class FwkDescription
    
    Returns:
    The presentation string.
  - getSupportEMail
```
public java.lang.String getSupportEMail()
```
    Get the support e-mail.
    
    Specified by:
    
    getSupportEMail in interface FwkDescriptionInterface
    
    Overrides:
    
    getSupportEMail in class FwkPersistence
    
    Returns:
    A string containing the support e-mail.
  - getTitle
```
public java.lang.String getTitle()
```
    Get the title.
    There is no method to set the title because the title will be loaded from the property bus using the titleName as keyword.
    
    Specified by:
    
    getTitle in interface FwkDescriptionInterface
    
    Overrides:
    
    getTitle in class FwkPersistence
    
    Returns:
    The title of the application.
  - getTitleName
```
public java.lang.String getTitleName()
```
    Get the title name.
    
    Specified by:
    
    getTitleName in interface FwkDescriptionInterface
    
    Overrides:
    
    getTitleName in class FwkPersistence
    
    Returns:
    The title name of the graphical user interface.
    See Also:
    setTitleName(String)
  - setAuthor
```
public void setAuthor(java.lang.String author)
```
    Set the author name.
    There ist currently no functionality.
    
    Specified by:
    
    setAuthor in interface FwkDescriptionInterface
    
    Overrides:
    
    setAuthor in class FwkPersistence
    
    Parameters:
    author - The name of the author.
    See Also:
    getAuthor()
  - setBuild
```
public void setBuild(java.lang.String buildnr)
```
    Set the build number.
    There ist currently no functionality.
    
    Specified by:
    
    setBuild in interface FwkDescriptionInterface
    
    Overrides:
    
    setBuild in class FwkPersistence
    
    Parameters:
    The - string of the build number.
    See Also:
    getBuild()
  - setCompany
```
public void setCompany(java.lang.String company)
```
    Set the company name.
    There ist currently no functionality.
    
    Specified by:
    
    setCompany in interface FwkDescriptionInterface
    
    Overrides:
    
    setCompany in class FwkPersistence
    
    Parameters:
    company - The name of the company.
    See Also:
    getCompany()
  - setCompanyInternetAddress
```
public void setCompanyInternetAddress(java.lang.String address)
```
    Set the internet address of the company.
    There ist currently no functionality.
    
    Specified by:
    
    setCompanyInternetAddress in interface FwkDescriptionInterface
    
    Overrides:
    
    setCompanyInternetAddress in class FwkPersistence
  - setCopyright
```
public void setCopyright(java.lang.String copyright)
```
    Set the copyright.
    There ist currently no functionality.
    
    Specified by:
    
    setCopyright in interface FwkDescriptionInterface
    
    Overrides:
    
    setCopyright in class FwkPersistence
    
    Parameters:
    The - copyright string.
    See Also:
    getCopyright()
  - setCreationDate
```
public void setCreationDate(java.lang.String dateString,
                   java.lang.String formatString)
```
    Set the Date of the application.
    There ist currently no functionality.
    
    Specified by:
    
    setCreationDate in interface FwkDescriptionInterface
    
    Overrides:
    
    setCreationDate in class FwkPersistence
    
    Parameters:
    dateString - The Date of the application.
    formatString - The format string.
    See Also:
    #java.text.SimpleDateFormat, getCreationDate()
  - setDateFormatString
```
public void setDateFormatString(java.lang.String formatString)
```
    Set the Date format string.
    
    Specified by:
    
    setDateFormatString in interface FwkDescriptionInterface
    
    Overrides:
    
    setDateFormatString in class FwkPersistence
    
    Parameters:
    formatString - The format string.
    See Also:
    #java.text.SimpleDateFormat, getCreationDate()
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Set the description of the application.
    There ist currently no functionality.
    
    Specified by:
    
    setDescription in interface FwkDescriptionInterface
    
    Overrides:
    
    setDescription in class FwkPersistence
    
    Parameters:
    description - The description of the application.
    See Also:
    getDescription()
  - setDescriptor
```
public void setDescriptor(FwkDescriptionInterface descriptor)
                   throws FwkException
```
    Initialize the object with values of the given FwkDescription.
    There ist currently no functionality.
    
    Specified by:
    
    setDescriptor in interface FwkDescriptionInterface
    
    Overrides:
    
    setDescriptor in class FwkPersistence
    
    Parameters:
    desciptor - The FwkDescription from that the value should be copied.
    
    Throws:
    
    FwkException
  - setIcon
```
public void setIcon(FwkIconInterface icon)
```
    Set the icon image.
    
    Specified by:
    
    setIcon in interface FwkDescriptionInterface
    
    Overrides:
    
    setIcon in class FwkPersistence
    
    Parameters:
    The - icon of the application.
    See Also:
    getIcon()
  - setIcon
```
public void setIcon(FwkIconInterface icon,
           int type)
```
    Set the image icon of the application
    
    Specified by:
    
    setIcon in interface FwkDescriptionInterface
    
    Overrides:
    
    setIcon in class FwkPersistence
    
    Parameters:
    icon - The icon to be set.
    type - The type of the icon, use predefined values defined above. If this value is out of range, no icon will be set.
    See Also:
    getIcon()
  - setIconKey
```
public void setIconKey(java.lang.String key)
```
    Set the property keyword of the icon.
    
    Specified by:
    
    setIconKey in interface FwkDescriptionInterface
    
    Overrides:
    
    setIconKey in class FwkPersistence
    
    Parameters:
    key - The keyword for the icon.
  - setIconKey
```
public void setIconKey(java.lang.String key,
              int type)
```
    Set the property keyword of the icon.
    
    Specified by:
    
    setIconKey in interface FwkDescriptionInterface
    
    Overrides:
    
    setIconKey in class FwkPersistence
    
    Parameters:
    key - The keyword for the icon.
    type - The type of the icon, use predefined values defined above.
  - setName
```
public void setName(java.lang.String name)
```
    Set the name of the ASAM-FWK object.
    
    Specified by:
    
    setName in interface FwkDescriptionInterface
    
    Overrides:
    
    setName in class FwkPersistence
    
    Parameters:
    name - The name of the object.
    See Also:
    getName()
  - setSupportEMail
```
public void setSupportEMail(java.lang.String eMail)
```
    Get the support e-mail.
    There ist currently no functionality.
    
    Specified by:
    
    setSupportEMail in interface FwkDescriptionInterface
    
    Overrides:
    
    setSupportEMail in class FwkPersistence
    
    Parameters:
    eMail - A string containing the support e-mail.
  - setTitleName
```
public void setTitleName(java.lang.String titlename)
```
    Set the title name of the application.
    There ist currently no functionality.
    
    Specified by:
    
    setTitleName in interface FwkDescriptionInterface
    
    Overrides:
    
    setTitleName in class FwkPersistence
    
    Parameters:
    titlename - The title name of the application.
    See Also:
    getTitleName()
  - addCommand
```
public void addCommand(FwkCommandInterface command)
```
    Add the command to the command array.
    
    Specified by:
    
    addCommand in interface FwkInstructionInterface
    
    Overrides:
    
    addCommand in class FwkPersistence
    
    Parameters:
    command - The command to be added.
  - addCommand
```
public void addCommand(int index,
              FwkCommandInterface command)
```
    Insert a command at the specified position. If the position is out of range. The method inserts the command at the beginning or appends it to existing array.
    
    Specified by:
    
    addCommand in interface FwkInstructionInterface
    
    Overrides:
    
    addCommand in class FwkPersistence
    
    Parameters:
    index - The position where the command has to be inserted.
    command - The command to be added.
  - getCommand
```
public FwkCommandInterface getCommand(java.lang.String commandName)
```
    Return the command that matches the given command name.
    
    Specified by:
    
    getCommand in interface FwkInstructionInterface
    
    Overrides:
    
    getCommand in class FwkPersistence
    
    Parameters:
    commandName - The name of the requested command.
    
    Returns:
    The command or null if no matching command found.
  - getCommands
```
public FwkCommandInterface[] getCommands()
```
    Retrieve the command array of the component.
    
    Specified by:
    
    getCommands in interface FwkInstructionInterface
    
    Overrides:
    
    getCommands in class FwkPersistence
    
    Returns:
    The array containing the commands.
  - setCommandProperties
```
protected void setCommandProperties(FwkCommandInterface[] commands)
```
    Set the command properties.
    
    Parameters:
    the - command array.
  - removeCommand
```
public void removeCommand(FwkCommandInterface command)
```
    Remove a sub-command. This method fires a property change event on the property RemoveCommand. The new value object of the event is this the old value object is the removed sub-command.
    
    Specified by:
    
    removeCommand in interface FwkInstructionInterface
    
    Overrides:
    
    removeCommand in class FwkPersistence
    
    Parameters:
    command - The sub-command to be removed.
  - setCommands
```
public void setCommands(FwkCommandInterface[] commands)
```
    Set the sub-commands of the command. All existing sub-commands will be removed.
    
    Specified by:
    
    setCommands in interface FwkInstructionInterface
    
    Overrides:
    
    setCommands in class FwkPersistence
    
    Parameters:
    commands - The array containing the sub-commands.
    See Also:
    FwkInstructionInterface.addCommand(FwkCommandInterface command)
  - commandsAvailable
```
public boolean commandsAvailable()
```
    This method returns a boolean that indicates whether the command array is initialized.
    
    Specified by:
    
    commandsAvailable in interface FwkInstructionInterface
    
    Overrides:
    
    commandsAvailable in class FwkPersistence
    
    Returns:
    true if the command array is already initialized.
  - addToGroup
```
public void addToGroup(int index,
              java.lang.String groupIdent,
              java.lang.String commandName)
```
    Add a command to a group.
    
    Specified by:
    
    addToGroup in interface FwkInstructionInterface
    
    Overrides:
    
    addToGroup in class FwkPersistence
    
    Parameters:
    index - Index where the command should be placed.
    groupIdent - The string identified of the group.
    commandName - The name of the command.
  - addToGroup
```
public void addToGroup(java.lang.String groupIdent,
              java.lang.String commandName)
```
    Add a command to a group.
    
    Specified by:
    
    addToGroup in interface FwkInstructionInterface
    
    Overrides:
    
    addToGroup in class FwkPersistence
    
    Parameters:
    groupIdent - The string identified of the group.
    commandName - The name of the command.
  - removeFromGroup
```
public void removeFromGroup(java.lang.String groupIdent,
                   java.lang.String commandName)
```
    Remove a command from a group.
    
    Specified by:
    
    removeFromGroup in interface FwkInstructionInterface
    
    Overrides:
    
    removeFromGroup in class FwkPersistence
    
    Parameters:
    groupIdent - The string identified of the group.
    commandName - The name of the command.
  - deleteGroup
```
public void deleteGroup(java.lang.String groupIdent)
```
    Delete command group.
    
    Specified by:
    
    deleteGroup in interface FwkInstructionInterface
    
    Overrides:
    
    deleteGroup in class FwkPersistence
    
    Parameters:
    groupIdent - The string identified of the group.
  - getGroup
```
public FwkCommandInterface[] getGroup(java.lang.String groupIdent)
```
    Retrieve the command group.
    
    Specified by:
    
    getGroup in interface FwkInstructionInterface
    
    Overrides:
    
    getGroup in class FwkPersistence
    
    Parameters:
    groupIdent - The string identified of the group.
    
    Returns:
    An array containing the group commands or null if empty.
  - groupExists
```
public boolean groupExists(java.lang.String groupIdent)
```
    Check whether a group exists.
    
    Specified by:
    
    groupExists in interface FwkInstructionInterface
    
    Overrides:
    
    groupExists in class FwkPersistence
    
    Returns:
    true if the group exists.
  - main
```
public static void main(java.lang.String[] args)
```
    The Main body to test the class.

Class OdsxFilteredTreeNode

Field Summary

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

Fields inherited from class com.highqsoft.fwk.FwkDescription

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

Constructor Summary

Method Summary

Methods inherited from class com.highqsoft.fwk.FwkPersistence

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

Methods inherited from class com.highqsoft.fwk.FwkDescription

Methods inherited from class com.highqsoft.fwk.Fwk

Methods inherited from class java.lang.Object

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

Methods inherited from interface java.awt.datatransfer.Transferable

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

Field Detail

version

EMPTY_ENUMERATION

parent

children

visibleChildren

presentable

odsSelector

userObject

odsFilter

allowsChildren

isLeaf

isLoaded

Constructor Detail

OdsxFilteredTreeNode

OdsxFilteredTreeNode

OdsxFilteredTreeNode

OdsxFilteredTreeNode

OdsxFilteredTreeNode

Method Detail

getVersion

firePropertyChange

setColor

getColor

isEnabled

isVisible

setVisible

getTranslatedName

setTranslatedName

isInstanceElement

isColumn

isApplicationElement

isSessionElement

delete

isLeaf

isLoaded

loadChildren

insert

remove

setParent

getParent

loadVisibleChildren

updateNode

reloadChildren

reloadChildren

getChildAt

getChildCount

getIndex

children

setAllowsChildren

getAllowsChildren

setPresentableElement

getPresentableElement

setFilter

setFilter

getFilter

setUserObject

getUserObject

removeFromParent

remove

removeAllChildren

add