com.sl.gmsjrtview
Class GmsRtViewCustomCommandHandler

java.lang.Object
  com.sl.gmsjrtview.GmsRtViewCustomCommandHandler

public abstract class GmsRtViewCustomCommandHandler
extends java.lang.Object

The GmsRtViewCustomCommandHandler provides a way to implement custom commands.

Subclasses should override the initialize() and invokeCommand() methods.

Constructor Summary

GmsRtViewCustomCommandHandler()
Create a new GmsRtViewCustomCommandHandler.

Method Summary

com.sl.gmsjrtview.GmsRtViewAppManager	getAppManager() Returns the application's RTView Application Manager.
com.sl.gmsjnet.GmsNetObject	getCurrentNetObject() Returns the currently selected object.
com.sl.gmsjrtview.GmsRtViewDsManager	getDsManager() Returns the application's Datasource Manager.
java.lang.String	getRtViewName(com.sl.gmsjrtview.GmsRtViewPanel rtvPanel) Returns the name of the display in the specified GmsRtViewPanel.
com.sl.gmsjnetrun.GmsNetRunPanel	getRunPanelByName(java.lang.String name) Returns the GmsNetRunPanel with the specified name.
void	initialize() Initialize this GmsRtViewCustomCommandHandler.
com.sl.gmsjrtview.GmsRtViewCommandStatus	invokeCommand(com.sl.gmsjrtview.GmsRtViewCommand cmd) Invoke a command.
boolean	invokeCommand(java.lang.String commandString, java.lang.Object value) Invoke a command.
boolean	isEditMode() Returns true if the application is running in edit mode.
void	setCurrentNetObject(com.sl.gmsjnet.GmsNetObject object) Sets the currently selected object.

Methods inherited from class java.lang.Object

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

Constructor Detail

GmsRtViewCustomCommandHandler

public GmsRtViewCustomCommandHandler()

Create a new GmsRtViewCustomCommandHandler.

Method Detail

getAppManager

public com.sl.gmsjrtview.GmsRtViewAppManager getAppManager()

Returns the application's RTView Application Manager.

getCurrentNetObject

public com.sl.gmsjnet.GmsNetObject getCurrentNetObject()

Returns the currently selected object.

getDsManager

public com.sl.gmsjrtview.GmsRtViewDsManager getDsManager()

Returns the application's Datasource Manager.

getRtViewName

public java.lang.String getRtViewName(com.sl.gmsjrtview.GmsRtViewPanel rtvPanel)

Returns the name of the display in the specified GmsRtViewPanel.

getRunPanelByName

public com.sl.gmsjnetrun.GmsNetRunPanel getRunPanelByName(java.lang.String name)

Returns the GmsNetRunPanel with the specified name.

Parameters:

name - the name of the GmsRtViewPanel

initialize

public void initialize()

Initialize this GmsRtViewCustomCommandHandler. Users should override this method to perform custom initialization.

invokeCommand

public com.sl.gmsjrtview.GmsRtViewCommandStatus invokeCommand(com.sl.gmsjrtview.GmsRtViewCommand cmd)

Invoke a command. This method is called from a GmsRtObject when a command is activated. Users should override this method to implement custom commands.

The default implementation simply calls invokeCommand(cmd.commandString, cmd.commandArg) and returns a status object with a value of OK and a null message.

Parameters:

cmd - the command to be executed.

Returns:

a status object

invokeCommand

public boolean invokeCommand(java.lang.String commandString,
                             java.lang.Object value)

Invoke a command. For backward compatibility only. Use GmsRtViewCustomCommandHandler.invokeCommand(GmsRtViewCommand) instead. The default implementation does nothing and returns false.

Parameters:

commandString - the command to execute

value - the argument string for the command

isEditMode

public boolean isEditMode()

Returns true if the application is running in edit mode.

setCurrentNetObject

public void setCurrentNetObject(com.sl.gmsjnet.GmsNetObject object)

Sets the currently selected object.

Parameters:

object - the object to select