org.ceryle.ui.help
Class DisplayAction

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

public class DisplayAction
extends HelpAction

Extends HelpAction to display a title and some HTML text in the Help dialog. This also triggers any embedded HelpActions.

Since:

JDK1.4

Version:

$Id: DisplayAction.java,v 3.11 2007-06-20 01:28:22 altheim Exp $

Author:

Murray Altheim

Field Summary

protected String	body
protected boolean	isWelcome
protected static String	key The keyword associated with this HelpAction.
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

DisplayAction(HelpDialog dialog, String id, String body)
Constructor for a help directive with a required id and text body.

DisplayAction(HelpDialog dialog, String id, String title, String body)
Constructor for a help directive with a required id, title and text body.

Method Summary

String	filterXML(String s) Strips the XML declaration from the String.
void	start() The method called to initiate the action.
String	toString() Return a String representation of this DisplayAction.

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

isWelcome

protected boolean isWelcome

title

protected String title

body

protected String body

Constructor Detail

DisplayAction

public DisplayAction(HelpDialog dialog,
                     String id,
                     String body)

Constructor for a help directive with a required id and text body. No title is provided.

DisplayAction

public DisplayAction(HelpDialog dialog,
                     String id,
                     String title,
                     String body)

Constructor for a help directive with a required id, title and text body.

Method Detail

start

public void start()

The method called to initiate the action.

Overrides:

start in class HelpAction

filterXML

public String filterXML(String s)

Strips the XML declaration from the String.

toString

public String toString()

Return a String representation of this DisplayAction.

Overrides:

toString in class HelpAction