org.ceryle.ui.help
Class DialogAction

java.lang.Object
  org.ceryle.ui.help.HelpAction
      org.ceryle.ui.help.DialogAction

public class DialogAction
extends HelpAction

Extends HelpAction to display a dialog and request some user entry in the Help dialog. This also triggers any embedded HelpActions.

Since:

JDK1.4

Version:

$Id: DialogAction.java,v 3.8 2007-06-15 12:09:45 altheim Exp $

Author:

Murray Altheim

Field Summary

protected static String	key The keyword associated with this HelpAction.
protected String	params
protected String	result
protected String	title

Fields inherited from class org.ceryle.ui.help.HelpAction

id, keyword, literal, m_desktop, m_dlog, m_list, mh, srvs, vmgr

Constructor Summary

DialogAction(HelpDialog dialog, String id, String parameter)
Constructor for a help directive with a required id and parameters (as a single string).

DialogAction(HelpDialog dialog, String id, String title, String parameter)
Constructor for a help directive with a required id, title and parameters (that must be parsed for dialog type and contents).

Method Summary

String	getResult() Returns the result of this dialog, as a String ("true" or "false" on booleans).
void	start() The method called to initiate the action.
String	toString() Return a String representation of this DialogAction.

Methods inherited from class org.ceryle.ui.help.HelpAction

addAction, getActions, getID, parseToAction

Methods inherited from class java.lang.Object

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

Field Detail

key

protected static final String key

The keyword associated with this HelpAction.

See Also:

Constant Field Values

title

protected String title

params

protected String params

result

protected String result

Constructor Detail

DialogAction

public DialogAction(HelpDialog dialog,
                    String id,
                    String parameter)

Constructor for a help directive with a required id and parameters (as a single string). No title is provided.

DialogAction

public DialogAction(HelpDialog dialog,
                    String id,
                    String title,
                    String parameter)

Constructor for a help directive with a required id, title and parameters (that must be parsed for dialog type and contents).

Method Detail

getResult

public String getResult()

Returns the result of this dialog, as a String ("true" or "false" on booleans). This returns null if the dialog did not provide a result.

start

public void start()

The method called to initiate the action.

Overrides:

start in class HelpAction

toString

public String toString()

Return a String representation of this DialogAction.

Overrides:

toString in class HelpAction