ilog.views.util.servlet

Class IlvDefaultPopupMenuEncoder

java.lang.Object

ilog.views.util.servlet.IlvPopupMenuEncoder

ilog.views.util.servlet.IlvDefaultPopupMenuEncoder

public class IlvDefaultPopupMenuEncoder
extends IlvPopupMenuEncoder

This class is responsible for encoding an IlvMenu into a code comprehensible to the client and to write it into the selected writer.

Note that this encoder only supports the following ActionListener subclasses:

• JavaScriptActionListener
• ServletActionListener

Since:

JViews 7.5

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected String	encodeImage(String imageURL) Encodes the menu or menu item image URL.
protected void	writeAction(IlvMenuItem menuItem, Writer out) Encodes the action of the current menu item.
protected void	writeJavaScriptAction(JavaScriptActionListener listener, Writer out) Encodes the JavaScript action listener and writes it in the specified writer.
protected void	writeJavaScriptString(String s, Writer out) Writes a JavaScript string literal that evaluates to the same string as the given Java string passed as parameter.
void	writeMenu(IlvMenu menu, Writer out) Writes the menu passed as parameter using the specified writer.
protected void	writeServerAction(ServletActionListener listener, Writer out) Encodes the server side action listener and writes it in the specified writer.

Methods inherited from class ilog.views.util.servlet.IlvPopupMenuEncoder

getEncodedPath, getMenuItemAt

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultPopupMenuEncoder

public IlvDefaultPopupMenuEncoder()

Creates a new IlvDefaultPopupMenuEncoder instance.

Method Detail

writeMenu

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

Writes the menu passed as parameter using the specified writer. The menu is encoded into a JavaScript array that will be processed by the client side pop-up menu factory.

Specified by:

writeMenu in class IlvPopupMenuEncoder

Parameters:

menu - The IlvMenu that will be encoded in a JavaScript array.

out - The writer used to write the result into.

Throws:

IOException

writeAction

protected void writeAction(IlvMenuItem menuItem,
                           Writer out)
                    throws IOException

Encodes the action of the current menu item.

Parameters:

menuItem - The menu item to encode

out - The writer.

Throws:

IOException

writeJavaScriptAction

protected void writeJavaScriptAction(JavaScriptActionListener listener,
                                     Writer out)
                              throws IOException

Encodes the JavaScript action listener and writes it in the specified writer.

Parameters:

listener - The JavaScript action listener.

out - The current writer.

Throws:

IOException

writeServerAction

protected void writeServerAction(ServletActionListener listener,
                                 Writer out)
                          throws IOException

Encodes the server side action listener and writes it in the specified writer.

Parameters:

listener - The server side action listener.

out - The current writer.

Throws:

IOException

encodeImage

protected String encodeImage(String imageURL)

Encodes the menu or menu item image URL.
This method does nothing, subclasses can override this method to render an encoded URL.

Parameters:

imageURL - The menu or menu item image URL.

Returns:

The encoded URL.

Since:

JViews 8.0

writeJavaScriptString

protected void writeJavaScriptString(String s,
                                     Writer out)
                              throws IOException

Writes a JavaScript string literal that evaluates to the same string as the given Java string passed as parameter.

Parameters:

s - The string to write.

out - The writer to write to.

Throws:

IOException