org.ceryle.ui.help
Class CloseAction

java.lang.Object
  extended by org.ceryle.ui.help.HelpAction
      extended by org.ceryle.ui.help.CloseAction

public class CloseAction
extends HelpAction

Extends HelpAction to close an open View based on the provided parameters. These uses the same algorithm as OpenAction, and can be a URL, a file path, or a whitespace-separated collection and node ID pair.

Since:
JDK1.4
Version:
$Id: CloseAction.java,v 3.6 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 m_systemId
           
 
Fields inherited from class org.ceryle.ui.help.HelpAction
id, keyword, literal, m_desktop, m_dlog, m_list, mh, srvs, vmgr
 
Constructor Summary
CloseAction(HelpDialog dialog, String id, String systemId)
          Constructor for an open View action with a required id and systemId.
 
Method Summary
 void start()
          The method called to close an open View.
 String toString()
          Return a String representation of this CloseAction.
 
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

m_systemId

protected String m_systemId
Constructor Detail

CloseAction

public CloseAction(HelpDialog dialog,
                   String id,
                   String systemId)
Constructor for an open View action with a required id and systemId.

Method Detail

start

public void start()
The method called to close an open View. This tries various methods to determine the systemId of the intended View.

Overrides:
start in class HelpAction

toString

public String toString()
Return a String representation of this CloseAction.

Overrides:
toString in class HelpAction


The Ceryle Project. Copyright ©2001-2007 Murray Altheim, All Rights Reserved. See LICENSE included with distribution.