com.bea.console.utils
Class NavTreeExtensionEvent

java.lang.Object
  PortletEvent
      com.bea.console.utils.NavTreeExtensionEvent

public class NavTreeExtensionEvent
extends PortletEvent

This class represents an event that is sent to a listener in the navigation tree portlet. The listener adds or replaces nodes in the navigation tree based on information in this event.

Invoke the constructors for this class from an implementation of NavTreeExtensionBacking.getTreeExtension(PageBackingContext, String). A portal control invokes this method to add itself to the navigation tree. The PageBackingContext and String values that it passes can be used in the constructors for this class.

See Also:

com.bea.netuix.servlets.controls.page.PageBackingContext

APPEND_ACTION

public static int APPEND_ACTION

Adds a node to the navigation tree.

REPLACE_ACTION

public static int REPLACE_ACTION

Replaces a node in the navigation tree.

NavTreeExtensionEvent

public NavTreeExtensionEvent(String parentPath,
                             TreeNode parent,
                             int action)

Constructs a new NavTreeExtensionEvent that can append or replace a node or node tree in a specified location.

The parentPath parameter specifies the name of the node to which you want to append or that you want to replace. Use / (slash) to represent the root of the navigation tree and / to separate levels of the tree hierarchy. For example, if you want your node or node tree to display at the top level, specify /. If you want your node to display as a child of Environments, or to replace Environments, specify /Environments.

The parent parameter specifies the extension node to add to the navigation tree. It may contain child nodes.

The action parameter indicates whether you append to or replace the nodes that you named in the parentPath parameter. This class provides fields that you can use as the value of this parameter.

Parameters:

parentPath - The location in which to add or replace the TreeNode

parent - The TreeNode object to add to the navigation tree

action - NavTreeExtensionEvent.APPEND_ACTION or NavTreeExtensionEvent.REPLACE_ACTION

See Also:

com.bea.netuix.servlets.controls.page.PageBackingContext

public NavTreeExtensionEvent(String pageLabel,
                             String url,
                             String parentPath,
                             TreeNode parent,
                             int action)

public NavTreeExtensionEvent(String pageLabel,
                             String url,
                             String parentPath,
                             TreeNode childNodes)

public NavTreeExtensionEvent(String pageLabel,
                             String url)

public String getParentPath()

public void setParentPath(String parentPath)

public TreeNode getParent()

public void setParent(TreeNode parent)

public String getPageLabel()

public void setPageLabel(String pageLabel)

public String getExtensionUrl()

public void setExtensionUrl(String extensionUrl)

public int getAction()

public void setAction(int action)