com.ibm.as400.opnav
Class OpNavItem

java.lang.Object
  |
  +--javax.swing.tree.DefaultMutableTreeNode
        |
        +--com.ibm.as400.opnav.OpNavItem

public class OpNavItem
extends javax.swing.tree.DefaultMutableTreeNode
implements java.lang.Cloneable

See Also:
Serialized Form

Inner Class Summary
 class OpNavItem.ActionItem
           
 class OpNavItem.ManagerElement
           
 
Fields inherited from class javax.swing.tree.DefaultMutableTreeNode
allowsChildren, children, EMPTY_ENUMERATION, parent, userObject
 
Constructor Summary
OpNavItem(java.lang.String title, int index, OpNavFrame frame)
           
 
Method Summary
 void add(javax.swing.tree.MutableTreeNode newChild)
           
 void addEmptyChild()
           
 void addHelpSet(java.lang.String helpSet, java.lang.String helpID)
           
 void cancelOpenThread()
           
 void clearThread()
           
 java.lang.Object clone()
           
 void copy(OpNavItem source)
           
 void displayErrorMessage(java.lang.String name, int type)
           
 OpNavItem findChild(OpNavItem item)
           
 java.util.Vector getActions(int actionType)
           
 java.util.Vector getActiveVerbs()
           
 int getAttributes()
           
 javax.swing.Icon getCollapsedIcon()
           
 java.lang.Object getContextInfo()
          Retrieve an object that was stored into the context of this item.
 java.lang.Object getContextInfo(java.lang.String key)
           
 int getContextMenuHandlerCount()
           
 java.util.Vector getContextMenuHandlerNames()
           
 java.util.Vector getContextMenuHandlers()
           
 java.lang.String getDescription()
           
 java.lang.String getElement()
           
 javax.swing.Icon getExpandedIcon()
           
 java.util.Vector getHelpSets()
           
 java.lang.String getIconFileName()
           
 int getIndex()
           
 ItemIdentifier getItemIdentifier()
           
 java.lang.Object getListManager()
           
 java.lang.String getListManagerName()
           
 java.lang.String[] getManagerCascadeTasks(java.lang.String manager, int type)
           
 int getManagerCount(int type)
           
 java.util.Vector getManagerNames(int type)
           
 java.util.Vector getManagers(int type)
           
 int getManagerWhen(java.lang.String manager, int type)
           
 int getMenubarActionHandlerCount()
           
 java.util.Vector getMenubarActionHandlerNames()
           
 java.util.Vector getMenubarActionHandlers()
           
 java.lang.String getName()
           
 javax.swing.tree.TreeNode getNonFolderChildAt(int index)
           
 int getNonFolderChildCount()
           
 com.ibm.as400.opnav.OpNavThread getOpenThread()
           
 OpNavItem getParentTreeNode()
           
 int getPropertySheetHandlerCount()
           
 java.util.Vector getPropertySheetHandlerNames()
           
 java.util.Vector getPropertySheetHandlers()
           
 int getSelectionMode()
           
 java.lang.String getSystemName()
           
 javax.swing.JLabel getTableItem()
           
 java.lang.String getTitle()
           
 int getToolbarButtonHandlerCount()
           
 java.util.Vector getToolbarButtonHandlerNames()
           
 java.util.Vector getToolbarButtonHandlers()
           
 java.lang.String getType()
           
 java.lang.String getXMLFileName()
           
 boolean hasEmptyChild()
           
 boolean isContainer()
           
 boolean isDynamicFolder()
           
 boolean isGUIContainer()
           
 boolean isThreadCanceled()
           
 boolean isTreeList()
           
 boolean performAction(java.lang.String verb, OpNavFrame frame)
           
 OpNavItem recursiveFind(OpNavItem item)
           
 void recursiveRemoveAllListPanes(OpNavItem item)
           
 void recursiveSetListPanesToRefresh(OpNavItem item)
           
 void setCollapsedIcon(javax.swing.Icon icon)
           
 void setContextInfo(java.lang.Object info)
          Save a user defined object into the context of this item.
 void setContextInfo(java.lang.String key, java.lang.Object info)
           
 void setContextMenuHandler(java.lang.String contextMenuHandler)
           
 void setContextMenuHandlerNames(java.util.Vector handlers)
           
 void setDescription(java.lang.String description)
           
 void setElement(java.lang.String element)
           
 void setExpandedIcon(javax.swing.Icon icon)
           
 void setIconFileName(java.lang.String file)
           
 void setIsContainer(boolean type)
           
 void setIsDynamicFolder(boolean type)
           
 void setItemIdentifier(ItemIdentifier item)
           
 void setListManager(java.lang.String listManager)
           
 void setListManagerObject(ListManager listManager)
           
 void setManager(int type, java.lang.String infoManager)
           
 void setManager(int type, java.lang.String infoManager, int when)
           
 void setManager(int type, java.lang.String infoManager, int when, java.lang.String[] cascadeTasks)
           
 void setMenubarActionHandler(java.lang.String menubarActionHandler)
           
 void setMenubarActionHandlerNames(java.util.Vector handlers)
           
 void setName(java.lang.String name)
           
 void setParentTreeNode(OpNavItem parent)
           
 void setPropertySheetHandler(java.lang.String propertySheetHandler)
           
 void setPropertySheetHandlerNames(java.util.Vector handlers)
           
 void setSystemName(java.lang.String system)
           
 void setTitle(java.lang.String title)
           
 void setToolbarButtonHandler(java.lang.String toolbarButtonHandler)
           
 void setToolbarButtonHandlerNames(java.util.Vector handlers)
           
 void setType(java.lang.String type)
           
 void setXMLFileName(java.lang.String name)
           
 void startOpenThread(int action)
           
 
Methods inherited from class javax.swing.tree.DefaultMutableTreeNode
breadthFirstEnumeration, children, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OpNavItem

public OpNavItem(java.lang.String title,
                 int index,
                 OpNavFrame frame)
Method Detail

setSystemName

public void setSystemName(java.lang.String system)

getSystemName

public java.lang.String getSystemName()

getTableItem

public javax.swing.JLabel getTableItem()

setType

public void setType(java.lang.String type)

getType

public java.lang.String getType()

setIsDynamicFolder

public void setIsDynamicFolder(boolean type)

isDynamicFolder

public boolean isDynamicFolder()

setIsContainer

public void setIsContainer(boolean type)

isContainer

public boolean isContainer()

getXMLFileName

public java.lang.String getXMLFileName()

setXMLFileName

public void setXMLFileName(java.lang.String name)

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setIconFileName

public void setIconFileName(java.lang.String file)

getIconFileName

public java.lang.String getIconFileName()

setExpandedIcon

public void setExpandedIcon(javax.swing.Icon icon)

getExpandedIcon

public javax.swing.Icon getExpandedIcon()

setCollapsedIcon

public void setCollapsedIcon(javax.swing.Icon icon)

getCollapsedIcon

public javax.swing.Icon getCollapsedIcon()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

setElement

public void setElement(java.lang.String element)

getElement

public java.lang.String getElement()

setListManagerObject

public void setListManagerObject(ListManager listManager)

setListManager

public void setListManager(java.lang.String listManager)

getListManagerName

public java.lang.String getListManagerName()

getListManager

public java.lang.Object getListManager()

setContextMenuHandler

public void setContextMenuHandler(java.lang.String contextMenuHandler)

setContextMenuHandlerNames

public void setContextMenuHandlerNames(java.util.Vector handlers)

getContextMenuHandlerNames

public java.util.Vector getContextMenuHandlerNames()

getContextMenuHandlerCount

public int getContextMenuHandlerCount()

getContextMenuHandlers

public java.util.Vector getContextMenuHandlers()

displayErrorMessage

public void displayErrorMessage(java.lang.String name,
                                int type)

setPropertySheetHandler

public void setPropertySheetHandler(java.lang.String propertySheetHandler)

setPropertySheetHandlerNames

public void setPropertySheetHandlerNames(java.util.Vector handlers)

getPropertySheetHandlerNames

public java.util.Vector getPropertySheetHandlerNames()

getPropertySheetHandlerCount

public int getPropertySheetHandlerCount()

getPropertySheetHandlers

public java.util.Vector getPropertySheetHandlers()

setToolbarButtonHandler

public void setToolbarButtonHandler(java.lang.String toolbarButtonHandler)

setToolbarButtonHandlerNames

public void setToolbarButtonHandlerNames(java.util.Vector handlers)

getToolbarButtonHandlerNames

public java.util.Vector getToolbarButtonHandlerNames()

getToolbarButtonHandlerCount

public int getToolbarButtonHandlerCount()

getToolbarButtonHandlers

public java.util.Vector getToolbarButtonHandlers()

setMenubarActionHandler

public void setMenubarActionHandler(java.lang.String menubarActionHandler)

setMenubarActionHandlerNames

public void setMenubarActionHandlerNames(java.util.Vector handlers)

getMenubarActionHandlerNames

public java.util.Vector getMenubarActionHandlerNames()

getMenubarActionHandlerCount

public int getMenubarActionHandlerCount()

getMenubarActionHandlers

public java.util.Vector getMenubarActionHandlers()

setManager

public void setManager(int type,
                       java.lang.String infoManager)

setManager

public void setManager(int type,
                       java.lang.String infoManager,
                       int when)

setManager

public void setManager(int type,
                       java.lang.String infoManager,
                       int when,
                       java.lang.String[] cascadeTasks)

getManagerWhen

public int getManagerWhen(java.lang.String manager,
                          int type)

getManagerCascadeTasks

public java.lang.String[] getManagerCascadeTasks(java.lang.String manager,
                                                 int type)

getManagerNames

public java.util.Vector getManagerNames(int type)

getManagerCount

public int getManagerCount(int type)

getManagers

public java.util.Vector getManagers(int type)

performAction

public boolean performAction(java.lang.String verb,
                             OpNavFrame frame)

getActiveVerbs

public java.util.Vector getActiveVerbs()

getActions

public java.util.Vector getActions(int actionType)

setItemIdentifier

public void setItemIdentifier(ItemIdentifier item)

getItemIdentifier

public ItemIdentifier getItemIdentifier()

getIndex

public int getIndex()

hasEmptyChild

public boolean hasEmptyChild()

addEmptyChild

public void addEmptyChild()

copy

public void copy(OpNavItem source)

clone

public java.lang.Object clone()
Overrides:
clone in class javax.swing.tree.DefaultMutableTreeNode

setContextInfo

public void setContextInfo(java.lang.Object info)
Save a user defined object into the context of this item. This method allows you to save and later retrieve any object.
Parameters:
info - A user defined object that will be saved into the context of this ObjectName
See Also:
getContextInfo

setContextInfo

public void setContextInfo(java.lang.String key,
                           java.lang.Object info)

getContextInfo

public java.lang.Object getContextInfo()
Retrieve an object that was stored into the context of this item. by the setContextInfo method If this item represents an item in a tree hierarchy this method will return the last object set in an item in the path from this item upto the root node of the tree For example, if a user set an Object into the root node of the tree, all lower level nodes will return the Object set in the root node.
Returns:
Object A user defined object that was be saved using the setContextInfo If no Object was ever set into this item then the Object set in a parent item will be returned. If no Object was ever set into any parent ObjectName, this method will return null
See Also:
setContextInfo

getContextInfo

public java.lang.Object getContextInfo(java.lang.String key)

isTreeList

public boolean isTreeList()

isGUIContainer

public boolean isGUIContainer()

recursiveFind

public OpNavItem recursiveFind(OpNavItem item)

recursiveSetListPanesToRefresh

public void recursiveSetListPanesToRefresh(OpNavItem item)

recursiveRemoveAllListPanes

public void recursiveRemoveAllListPanes(OpNavItem item)

setParentTreeNode

public void setParentTreeNode(OpNavItem parent)

getParentTreeNode

public OpNavItem getParentTreeNode()

findChild

public OpNavItem findChild(OpNavItem item)

getSelectionMode

public int getSelectionMode()

getAttributes

public int getAttributes()

add

public void add(javax.swing.tree.MutableTreeNode newChild)
Overrides:
add in class javax.swing.tree.DefaultMutableTreeNode

getNonFolderChildCount

public int getNonFolderChildCount()

getNonFolderChildAt

public javax.swing.tree.TreeNode getNonFolderChildAt(int index)

getOpenThread

public com.ibm.as400.opnav.OpNavThread getOpenThread()

startOpenThread

public void startOpenThread(int action)

isThreadCanceled

public boolean isThreadCanceled()

cancelOpenThread

public void cancelOpenThread()

clearThread

public void clearThread()

addHelpSet

public void addHelpSet(java.lang.String helpSet,
                       java.lang.String helpID)

getHelpSets

public java.util.Vector getHelpSets()