ilog.views.util.servlet

Class IlvPopupMenuEncoder

java.lang.Object

ilog.views.util.servlet.IlvPopupMenuEncoder

Direct Known Subclasses:

IlvDefaultPopupMenuEncoder

public abstract class IlvPopupMenuEncoder
extends Object

This class defines an encoder of an IlvMenu.

Since:

JViews 7.5

Constructor Summary

Constructors

Constructor and Description
IlvPopupMenuEncoder() Creates a new IlvPopupMenuEncoder instance.

Method Summary

Modifier and Type	Method and Description
protected String	getEncodedPath(List<String> pathList) Returns the encoded path of a menu item.
static IlvMenuItem	getMenuItemAt(IlvMenu root, String encodedPath) Returns the menu item specified by the path encoded by this encoder.
abstract void	writeMenu(IlvMenu menu, Writer out) Write the menu passed as parameter using the specified writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvPopupMenuEncoder

public IlvPopupMenuEncoder()

Creates a new IlvPopupMenuEncoder instance.

Method Detail

writeMenu

public abstract void writeMenu(IlvMenu menu,
                               Writer out)
                        throws IOException

Write the menu passed as parameter using the specified writer.

Parameters:

menu - The IlvMenu that will be encoded.

out - The writer used to write the result into.

Throws:

IOException

getMenuItemAt

public static IlvMenuItem getMenuItemAt(IlvMenu root,
                                        String encodedPath)

Returns the menu item specified by the path encoded by this encoder.

Parameters:

root - The root menu.

encodedPath - The encoded path string.

Returns:

The menu item specified by this path.

getEncodedPath

protected String getEncodedPath(List<String> pathList)

Returns the encoded path of a menu item.

Parameters:

pathList - The path of the element representation by a list of indexes.

Returns:

The encoded path.