com.ibm.wps.portlet.menu
Interface MenuTreeInfoCtrl

Deprecated. since 6.0. Support of the IBM portlet API may be removed in a future release of WebSphere Portal. Use of the Java Portlet API (javax.portlet) is recommended instead.

public interface MenuTreeInfoCtrl

MenuTree providers choose to implement the MenuTreeInfoCtrl interface if they support to receive a copy of individual menu nodes from a different MenuTree implementation (ie if the tree is able to be the destination of a copy operation) and to modify MenuNode information. In order to support a per-node copy operation and modification of MenuNode information, the object returned by MenuProvider.getMenu(com.ibm.wps.portlet.menu.MenuContext) implements the MenuTreeInfoCtrl interface besides the MenuTree interface.

Since:

5.0

See Also:

MenuTreeInfoCopyCtrl, MenuNode

Note:

This interface is designed to be implemented by clients.

Method Summary

void	addActionParameter(java.lang.String name, java.lang.String value, MenuNode node) Deprecated. Defines the action parameter name - value pair associated with the tree node.
void	clearActionParameters(MenuNode node) Deprecated. Deletes all action parameter name - value pairs associated with the tree node.
void	setAction(java.lang.String name, MenuNode node) Deprecated. Defines the action associated with the tree node.
void	setInformation(java.util.Locale locale, java.lang.String title, java.lang.String description, MenuNode node) Deprecated. Sets title and descriptionof a menu tree node in a specific locale.
void	setURL(java.lang.String url, MenuNode node) Deprecated. Defines a custom URL address.

Method Detail

setInformation

void setInformation(java.util.Locale locale,
                    java.lang.String title,
                    java.lang.String description,
                    MenuNode node)

Deprecated.

Sets title and descriptionof a menu tree node in a specific locale.

The locale must comprise the locale of the request which is defined in the environment language settings of the browser. The locale of the request is returned from request.getLocale().

Example: If the locale of the request is en_US, the locale of the node can be en or en_US. If the locale of the request is en_US and the locale of the node is en_GB, the methods getTitle() and getDescription() return null values.

Parameters:

locale - locale of the title and description.

title - node title

description - node description

node - menu tree node

See Also:

MenuNode.getTitle(), MenuNode.getDescription()

setAction

void setAction(java.lang.String name,
               MenuNode node)

Deprecated.

Defines the action associated with the tree node. The action is overwritten with setURL(java.lang.String, com.ibm.wps.portlet.menu.MenuNode). The action name is displayed in the center of the URL address when the cursor moves over the tree node.

Parameters:

name - action name.

node - menu tree node

See Also:

ActionListener, PortletAdapter, MenuNode.getURL()

addActionParameter

void addActionParameter(java.lang.String name,
                        java.lang.String value,
                        MenuNode node)

Deprecated.

Defines the action parameter name - value pair associated with the tree node. Can be applied more than once to a tree node. The parameters are displayed at the end of the URL address when the cursor moves over the tree node.

Parameters:

name - parameter name

value - parameter value

node - menu tree node

See Also:

MenuNode.getURL()

clearActionParameters

void clearActionParameters(MenuNode node)

Deprecated.

Deletes all action parameter name - value pairs associated with the tree node.

Parameters:

node - menu tree node

See Also:

MenuNode.getURL()

setURL

void setURL(java.lang.String url,
            MenuNode node)

Deprecated.

Defines a custom URL address. E.g., http://www.ibm.com/us/. The URL address is overwritten with setAction(java.lang.String, com.ibm.wps.portlet.menu.MenuNode). The URL address is displayed when the cursor moves over the tree node.

Parameters:

url - URL address

node - menu tree node

See Also:

MenuNode.getURL()