Skip navigation links

ilog.rules.webui
Class IlrWDefaultTokenActionManager

java.lang.Object
  ilog.webui.dhtml.IlxWContainer
      ilog.webui.dhtml.IlxWComponent
          ilog.rules.webui.IlrWTokenActionManager
              ilog.rules.webui.IlrWDefaultTokenActionManager

All Implemented Interfaces:

ilog.webui.dhtml.IlxWConstants, ilog.webui.dhtml.IlxWCSSModelProvider, ilog.webui.dhtml.IlxWDependencyProvider, ilog.webui.dhtml.IlxWJSObject, Serializable

Deprecated. Use IlrWDefaultValueEditorActionManager instead.

public class IlrWDefaultTokenActionManager
extends IlrWTokenActionManager

Default web token action manager.

This token manager is displayed in the Web Rule Editor as a link displaying the text of the corresponding token. When this link is clicked, it pops an "OK/Cancel" dialog window.

The dialog window must be enriched by your components, through getDialogPane(). Just after the dialog window is closed, an action event is fired and dispatched to the registered action listeners. The actioncommand string associated with the event is defined as follows:

• OK_COMMAND: if the window closing results from pressing the OK button.
• CANCEL_COMMAND: if the window has been closed another way.

You will typically add your own action listener in order to update the token according to the current state of the dialog window (for example, the dialog pane contains a color chooser, and the selected color has changed).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ilog.webui.dhtml.IlxWComponent

IlxWComponent.DynamicStyleMap

Field Summary

static String	CANCEL_COMMAND Deprecated. Name of the 'cancel' action command.
static String	OK_COMMAND Deprecated. Name of the 'OK' action command.
protected ilog.rules.brl.tokenmodel.IlrToken.TextToken	token Deprecated. The token currently edited by the token action manager.

Fields inherited from class ilog.rules.webui.IlrWTokenActionManager

renderer

Fields inherited from class ilog.webui.dhtml.IlxWContainer

listenerList

Constructor Summary

IlrWDefaultTokenActionManager()
Deprecated. Constructs a default token action manager.

Method Summary

void	addActionListener(ActionListener l) Deprecated. Adds the specified action listener to receive action events when the dialog window is closed.
void	addToDialogPane(IlxWComponent component) Deprecated. Adds a component to the main panel of the dialog box.
void	closeDialog(String command) Deprecated. Closes the token action manager dialog.
ilog.webui.dhtml.components.IlxWPanel	getDialogPane() Deprecated. Use addToDialogPane instead.
ilog.rules.brl.tokenmodel.IlrToken.TextToken	getToken() Deprecated. Gets the token previously set through setToken(ilog.rules.brl.tokenmodel.IlrToken.TextToken).
protected void	printComponent(IlxWPort port) Deprecated. Prints the HTML code that will display the graphical representation of this component.
void	removeActionListener(ActionListener l) Deprecated. Removes the specified action listener so that it no longer receives action events from this component.
void	setDialogWindowClass(String windowClass) Deprecated. Sets the CSS classes for the dialog window.
void	setToken(ilog.rules.brl.tokenmodel.IlrToken.TextToken token) Deprecated. Sets the current token on this action manager and updates the corresponding link component accordingly.
void	setValue(Object value) Deprecated. Sets the value of the token associated with this token action manager.

Methods inherited from class ilog.rules.webui.IlrWTokenActionManager

fireTokenChange

Methods inherited from class ilog.webui.dhtml.IlxWComponent

addPropertyChangeListener, addPropertyChangeListener, detach, doPrint, firePropertyChange, firePropertyChange, getName, getRealHtmlTagName, getStyle, invalidate, isInvalidated, notifyDependencies, print, removePropertyChangeListener, removePropertyChangeListener, setName, validate

Methods inherited from class ilog.webui.dhtml.IlxWContainer

add, add, getAttribute, getAttributeNames, getComponent, getComponentCount, getComponentNamed, getComponents, getManager, getParent, getUserAgentRules, indexOf, isAncestorOf, remove, remove, removeAll, removeAttribute, setAttribute, setAuthorRules, setFinalizer

Methods inherited from class java.lang.Object

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

Field Detail

token

protected ilog.rules.brl.tokenmodel.IlrToken.TextToken token

Deprecated.

The token currently edited by the token action manager.

OK_COMMAND

public static String OK_COMMAND

Deprecated.

Name of the 'OK' action command.

CANCEL_COMMAND

public static String CANCEL_COMMAND

Deprecated.

Name of the 'cancel' action command.

Constructor Detail

IlrWDefaultTokenActionManager

public IlrWDefaultTokenActionManager()

Deprecated.

Constructs a default token action manager.

Method Detail

getDialogPane

public ilog.webui.dhtml.components.IlxWPanel getDialogPane()

Deprecated. Use addToDialogPane instead.

Gets the main panel of the dialog box.

Use this panel to add your component(s) to the dialog.

addToDialogPane

public void addToDialogPane(IlxWComponent component)

Deprecated.

Adds a component to the main panel of the dialog box.

Parameters:

component - The component to add.

addActionListener

public void addActionListener(ActionListener l)

Deprecated.

Adds the specified action listener to receive action events when the dialog window is closed.

Parameters:

l - The action listener.

removeActionListener

public void removeActionListener(ActionListener l)

Deprecated.

Removes the specified action listener so that it no longer receives action events from this component.

Parameters:

l - The action listener.

printComponent

protected void printComponent(IlxWPort port)
                       throws IOException

Deprecated.

Description copied from class: IlxWComponent

Prints the HTML code that will display the graphical representation of this component. This method is called by the IlxWComponent.print(ilog.webui.dhtml.IlxWPort) method.

Specified by:

printComponent in class IlxWComponent

Throws:

IOException

Parameters:

port - The port on which the component will be printed.

See Also:

IlxWComponent.print(ilog.webui.dhtml.IlxWPort)

getToken

public ilog.rules.brl.tokenmodel.IlrToken.TextToken getToken()

Deprecated.

Gets the token previously set through setToken(ilog.rules.brl.tokenmodel.IlrToken.TextToken).

Returns:

A text token, or null if setToken has not been called yet.

setToken

public void setToken(ilog.rules.brl.tokenmodel.IlrToken.TextToken token)

Deprecated.

Sets the current token on this action manager and updates the corresponding link component accordingly.

Specified by:

setToken in class IlrWTokenActionManager

closeDialog

public void closeDialog(String command)

Deprecated.

Closes the token action manager dialog.

Parameters:

command - One of OK_COMMAND or CANCEL_COMMAND.

setDialogWindowClass

public void setDialogWindowClass(String windowClass)

Deprecated.

Sets the CSS classes for the dialog window.

Parameters:

windowClass - A string containing one or several CSS classes separated by a space.

setValue

public void setValue(Object value)

Deprecated.

Sets the value of the token associated with this token action manager.

Parameters:

value - The value to set.