Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.commands
Class SystemCommandEditor

java.lang.Object
  extended bySourceViewer
      extended bycom.ibm.etools.systems.core.ui.commands.SystemCommandEditor

public class SystemCommandEditor
extends SourceViewer

Class used for constructing a command editor widget with * UDA substitution variable completion

See Also:
Serialized Form

Field Summary
protected  ISystemValidator cmdValidator
           
static String copyright
           
protected  boolean ignoreChanges
           
protected  boolean menuListenerAdded
           
 
Constructor Summary
SystemCommandEditor(IViewSite site, Composite parent, int attributes, int columnSpan, SourceViewerConfiguration sourceViewerConfiguration, String cmd, String contentAssistText)
          Constructor for the editor * Create the editor widget
 
Method Summary
 void addModifyListener(ISystemCommandTextModifyListener listener)
          Add a modify listener
 void doOperation(int operation)
           
 String getCommandText()
           
 String getSelectedText()
           
 boolean isInCodeAssist()
           
 void releaseWidgetToken(IWidgetTokenKeeper tokenKeeper)
           
 void removeModifyListener(ISystemCommandTextModifyListener listener)
          Remove a modify listener
 boolean requestWidgetToken(IWidgetTokenKeeper requester)
           
 void setActionHandlers()
           
 void setCommandValidator(ISystemValidator cmdValidator)
          Set the command validator to validate contents per keystroke
 void setIgnoreChanges(boolean ignore)
          Turn on or off event ignoring flag
 void setInCodeAssist(boolean flag)
           
 void setViewSite(IViewSite site)
           
protected  void updateAction(String actionId)
           
protected  void updateSelectionDependentActions()
           
protected  void updateUndoAction()
           
 SystemMessage validateCommand()
          Validate command input
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values

menuListenerAdded

protected boolean menuListenerAdded

cmdValidator

protected ISystemValidator cmdValidator

ignoreChanges

protected boolean ignoreChanges
Constructor Detail

SystemCommandEditor

public SystemCommandEditor(IViewSite site,
                           Composite parent,
                           int attributes,
                           int columnSpan,
                           SourceViewerConfiguration sourceViewerConfiguration,
                           String cmd,
                           String contentAssistText)
Constructor for the editor * Create the editor widget

Method Detail

getCommandText

public String getCommandText()

getSelectedText

public String getSelectedText()

addModifyListener

public void addModifyListener(ISystemCommandTextModifyListener listener)
Add a modify listener


removeModifyListener

public void removeModifyListener(ISystemCommandTextModifyListener listener)
Remove a modify listener


setIgnoreChanges

public void setIgnoreChanges(boolean ignore)
Turn on or off event ignoring flag


validateCommand

public SystemMessage validateCommand()
Validate command input


setCommandValidator

public void setCommandValidator(ISystemValidator cmdValidator)
Set the command validator to validate contents per keystroke


setViewSite

public void setViewSite(IViewSite site)

setActionHandlers

public void setActionHandlers()

updateSelectionDependentActions

protected void updateSelectionDependentActions()

updateUndoAction

protected void updateUndoAction()

updateAction

protected void updateAction(String actionId)

setInCodeAssist

public void setInCodeAssist(boolean flag)

requestWidgetToken

public boolean requestWidgetToken(IWidgetTokenKeeper requester)

releaseWidgetToken

public void releaseWidgetToken(IWidgetTokenKeeper tokenKeeper)

isInCodeAssist

public boolean isInCodeAssist()

doOperation

public void doOperation(int operation)

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.