Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY:  NESTED |  FIELD |  CONSTR |  METHOD	DETAIL:  FIELD |  CONSTR |  METHOD

---

org.eclipse.rse.shells.ui.view
Class SystemCommandEditor

java.lang.Object
  

org.eclipse.jface.viewers.Viewer
      

org.eclipse.jface.text.TextViewer
          

org.eclipse.jface.text.source.SourceViewer
              
org.eclipse.rse.shells.ui.view.SystemCommandEditor

All Implemented Interfaces:

IEditingSupportRegistry, ITextOperationTarget, ITextOperationTargetExtension, ITextViewer, ITextViewerExtension, ITextViewerExtension2, ITextViewerExtension4, ITextViewerExtension6, ITextViewerExtension7, ITextViewerExtension8, IWidgetTokenOwner, IWidgetTokenOwnerExtension, ISourceViewer, ISourceViewerExtension, ISourceViewerExtension2, ISourceViewerExtension3, ISourceViewerExtension4, IInputProvider, IInputSelectionProvider, IPostSelectionProvider, ISelectionProvider

---

public class SystemCommandEditor
extends 
SourceViewer

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

---

Nested Class Summary

 

Nested classes/interfaces inherited from class org.eclipse.jface.text.source. SourceViewer
SourceViewer.RulerLayout

 

Nested classes/interfaces inherited from class org.eclipse.jface.text. TextViewer
TextViewer.TextHoverKey, TextViewer.WidgetCommand

 

Nested classes/interfaces inherited from interface org.eclipse.jface.text. ITextViewerExtension8
ITextViewerExtension8.EnrichMode

 

Field Summary
protected   ISystemValidator	cmdValidator
protected  boolean	ignoreChanges
protected  boolean	menuListenerAdded

 

Fields inherited from class org.eclipse.jface.text.source. SourceViewer
_SELECTION_POSITION_CATEGORY, fAnnotationHover, fContentAssistant, fContentAssistantInstalled, fContentFormatter, fInformationPresenter, fOverviewRulerAnnotationHover, fPresentationReconciler, fQuickAssistAssistant, fQuickAssistAssistantInstalled, fReconciler, fSelectionCategory, fSelections, fSelectionUpdater, GAP_SIZE, GAP_SIZE_1, MODEL_ANNOTATION_MODEL

 

Fields inherited from class org.eclipse.jface.text. TextViewer

fAutoIndentStrategies, fDefaultPrefixChars, fDoubleClickStrategies, fEventConsumer, fFindReplaceDocumentAdapter, fHoverControlCreator, fHyperlinkDetectors, fHyperlinkManager, fHyperlinkPresenter, fHyperlinkStateMask, fIgnoreAutoIndent, fIndentChars, fInformationMapping, fLastTopPixel, fMarkPosition, fPaintManager, fPartitioning, fReplaceTextPresentation, fTextHovers, fTextInputListeners, fTextListeners, fTextPresentationListeners, fUndoManager, fViewportListeners, INTERNAL, KEY, MOUSE, MOUSE_END, RESIZE, SCROLLER, SHIFTING, TRACE_ERRORS

 

Fields inherited from class org.eclipse.jface.viewers. Viewer
WIDGET_DATA_KEY

 

Fields inherited from interface org.eclipse.jface.text.source. ISourceViewer
CONTENTASSIST_CONTEXT_INFORMATION, CONTENTASSIST_PROPOSALS, FORMAT, INFORMATION, QUICK_ASSIST

 

Fields inherited from interface org.eclipse.jface.text. ITextViewerExtension2
DEFAULT_HOVER_STATE_MASK

 

Fields inherited from interface org.eclipse.jface.text. ITextOperationTarget
COPY, CUT, DELETE, PASTE, PREFIX, PRINT, REDO, SELECT_ALL, SHIFT_LEFT, SHIFT_RIGHT, STRIP_PREFIX, UNDO

 

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)
boolean	requestWidgetToken ( IWidgetTokenKeeper requester, int priority)
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 ()
SystemMessage	validateCommand ()           Validate command input

 

Methods inherited from class org.eclipse.jface.text.source. SourceViewer

activatePlugins, canDoOperation, clearRememberedSelection, configure, createControl, createFormattingContext, createLayout, createVisualAnnotationModel, disposeVisualAnnotationModel, enableOperation, ensureAnnotationHoverManagerInstalled, ensureOverviewHoverManagerInstalled, getAnnotationModel, getContentAssistantFacade, getControl, getCurrentAnnotationHover, getQuickAssistAssistant, getQuickAssistInvocationContext, getRangeIndication, getVerticalRuler, getVisualAnnotationModel, handleDispose, rememberSelection, removeRangeIndication, restoreSelection, setAnnotationHover, setDocument, setDocument, setDocument, setDocument, setHoverEnrichMode, setOverviewRulerAnnotationHover, setRangeIndication, setRangeIndicator, showAnnotations, showAnnotationsOverview, unconfigure, updateSlaveDocuments

 

Methods inherited from class org.eclipse.jface.text. TextViewer

_getVisibleRegionOffset, _internalGetVisibleRegion, addPainter, addPostSelectionChangedListener, addTextInputListener, addTextListener, addTextPresentationListener, addViewportListener, appendVerifyKeyListener, areMultipleLinesSelected, canPerformFind, changeTextPresentation, copyMarkedRegion, createDocumentAdapter, createSlaveDocument, createSlaveDocumentManager, createTextWidget, customizeDocumentCommand, deleteText, disableRedrawing, enabledRedrawing, enabledRedrawing, event2ModelRange, findAndSelect, findAndSelect, findAndSelectInRange, fireInputDocumentAboutToBeChanged, fireInputDocumentChanged, firePostSelectionChanged, fireSelectionChanged, freeSlaveDocument, getAverageCharWidth, getBottomIndex, getBottomIndexEndOffset, getClosestWidgetLineForModelLine, getCurrentTextHover, getDocument, getDocumentPartitioning, getEmptySelectionChangedEventDelay, getExtent, getFindReplaceDocumentAdapter, getFindReplaceTarget, getHoverEventLocation, getInput, getMark, getModelCoverage, getPaintManager, getRegisteredSupports, getRewriteTarget, getSelectedRange, getSelection, getSelectionProvider, getSlaveDocumentManager, getTextHover, getTextHover, getTextHoveringController, getTextOperationTarget, getTextWidget, getTopIndex, getTopIndexStartOffset, getTopInset, getUndoManager, getVisibleDocument, getVisibleLinesInViewport, getVisibleRegion, getWidthInPixels, getWidthInPixels, handleVerifyEvent, handleVisibleDocumentAboutToBeChanged, handleVisibleDocumentChanged, ignoreAutoEditStrategies, initializeDocumentInformationMapping, inputChanged, internalRevealRange, invalidateTextPresentation, invalidateTextPresentation, isBlockSelected, isEditable, isIgnoringAutoEditStrategies, isPrintable, markChanged, modelLine2WidgetLine, modelOffset2WidgetOffset, modelRange2ClosestWidgetRange, modelRange2WidgetRange, modelRange2WidgetRange, modelSelection2WidgetSelection, modelStyleRange2WidgetStyleRange, moveFocusToWidgetToken, overlapsWithVisibleRegion, prependAutoEditStrategy, prependVerifyKeyListener, print, print, redraws, refresh, register, removeAutoEditStrategy, removePainter, removePostSelectionChangedListener, removeTextHovers, removeTextInputListener, removeTextListener, removeTextPresentationListener, removeVerifyKeyListener, removeViewportListener, resetPlugins, resetVisibleRegion, revealRange, selectContentTypePlugin, selectionChanged, setAutoEditStrategies, setAutoIndentStrategy, setDefaultPrefixes, setDocumentPartitioning, setEditable, setEventConsumer, setHoverControlCreator, setHyperlinkDetectors, setHyperlinkPresenter, setIndentPrefixes, setInput, setMark, setRedraw, setRedraw, setSelectedRange, setSelection, setTabsToSpacesConverter, setTextColor, setTextColor, setTextDoubleClickStrategy, setTextHover, setTextHover, setTopIndex, setUndoManager, setVisibleDocument, setVisibleRegion, shift, shift, startSequentialRewriteMode, stopSequentialRewriteMode, unregister, updateSlaveDocument, updateTextListeners, updateViewportListeners, updateVisibleDocument, validateSelectionRange, widgetLine2ModelLine, widgetLineOfWidgetOffset, widgetlLine2ModelLine, widgetOffset2ModelOffset, widgetRange2ModelRange, widgetSelection2ModelSelection

 

Methods inherited from class org.eclipse.jface.viewers. Viewer
addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection

 

Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface org.eclipse.jface.text. ITextViewer

addTextInputListener, addTextListener, addViewportListener, changeTextPresentation, getBottomIndex, getBottomIndexEndOffset, getDocument, getFindReplaceTarget, getSelectedRange, getSelectionProvider, getTextOperationTarget, getTextWidget, getTopIndex, getTopIndexStartOffset, getTopInset, getVisibleRegion, invalidateTextPresentation, isEditable, overlapsWithVisibleRegion, removeTextInputListener, removeTextListener, removeViewportListener, resetPlugins, resetVisibleRegion, revealRange, setAutoIndentStrategy, setDefaultPrefixes, setEditable, setEventConsumer, setIndentPrefixes, setSelectedRange, setTextColor, setTextColor, setTextDoubleClickStrategy, setTextHover, setTopIndex, setUndoManager, setVisibleRegion

 

Methods inherited from interface org.eclipse.jface.viewers. ISelectionProvider
addSelectionChangedListener, removeSelectionChangedListener, setSelection

 

Field Detail

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()

---

updateAction

protected void updateAction(
String actionId)

---

setInCodeAssist

public void setInCodeAssist(boolean flag)

---

requestWidgetToken

public boolean requestWidgetToken(
IWidgetTokenKeeper requester)

Specified by:

requestWidgetToken in interface IWidgetTokenOwner

Overrides:

requestWidgetToken in class TextViewer

---

requestWidgetToken

public boolean requestWidgetToken(
IWidgetTokenKeeper requester,
                                  int priority)

Specified by:

requestWidgetToken in interface IWidgetTokenOwnerExtension

Overrides:

requestWidgetToken in class TextViewer

---

releaseWidgetToken

public void releaseWidgetToken(
IWidgetTokenKeeper tokenKeeper)

Specified by:

releaseWidgetToken in interface IWidgetTokenOwner

Overrides:

releaseWidgetToken in class TextViewer

---

isInCodeAssist

public boolean isInCodeAssist()

---

doOperation

public void doOperation(int operation)

Specified by:

doOperation in interface ITextOperationTarget

Overrides:

doOperation in class SourceViewer

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY:  NESTED |  FIELD |  CONSTR |  METHOD	DETAIL:  FIELD |  CONSTR |  METHOD

---

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.