Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui
Class QSYSEditorProfile

java.lang.Object
  extended by com.ibm.etools.systems.editor.SystemTextEditorProfileDefault
      extended by com.ibm.etools.iseries.rse.ui.QSYSEditorProfile
All Implemented Interfaces:
IQSYSRemoteEditConstants, com.ibm.etools.systems.editor.internal.ISystemTextEditorConstants, ISystemTextEditorProfile

public class QSYSEditorProfile
extends SystemTextEditorProfileDefault
implements IQSYSRemoteEditConstants


Field Summary
protected  DebugEditorActionContributor _dbgEdContributor
           
protected  AS400 _iseries
           
static String Copyright
           
 
Fields inherited from class com.ibm.etools.systems.editor.SystemTextEditorProfileDefault
DEFAULT_COMPILE_MESSAGE_CLASS_NAME, SEQUENCE_FALSE, SEQUENCE_TRUE, SEQUENCE_UNKNOWN
 
Fields inherited from interface com.ibm.etools.iseries.subsystems.qsys.resources.IQSYSRemoteEditConstants
AS400_OBJECT_KEY, BUFFER_SIZE, copyright, IFS_EDITOR_PROFILE, KB_IN_BYTES, NUM_OF_KB, QSYS_EDITOR_PROFILE
 
Fields inherited from interface com.ibm.etools.systems.editor.internal.ISystemTextEditorConstants
AUTOSAVE_FREQ_ERROR, AUTOSAVE_FREQ_LABEL, AUTOSAVE_FREQ_TOOLTIP, AUTOSAVE_LABEL, AUTOSAVE_PROGRESS, AUTOSAVE_PROGRESS_JOBNAME, AUTOSAVE_TOOLTIP, copyright, PLUGIN_ID, PREFIX, RESID_PREFIX, RESID_PREFIX_PREFERENCES, RESID_PREFIX_PROGRESS, SYSTEM_TEXT_BROWSER_ID, SYSTEM_TEXT_EDITOR_ID
 
Constructor Summary
QSYSEditorProfile()
           
 
Method Summary
 void addDebugEditorMenuActions(IMenuManager menu, boolean isDebuggable, int currentElement)
          Add debug editor menu actions associated with this profile.
 void addDebugEditorRulerActions(IMenuManager menu, boolean isDebuggable, int currentElement)
          Add debug editor ruler actions associated with this profile.
 void createDebugMenuActions(LpexTextEditor editor)
          Create debug menu actions associated with this profile
 void createDebugRulerActions(LpexTextEditor editor, IVerticalRuler ruler)
          Create debug ruler actions associated with this profile.
 void doSave(LpexTextEditor editor, IProgressMonitor progressMonitor)
          Refreshes the Lpex text area before saving.
 void editorContextMenuAboutToShow(LpexTextEditor editor, IMenuManager menu)
          Called when JLpex's editorContextMenuAboutToShow is called
 IAction getBreakpointRulerAction(LpexTextEditor editor)
          Returns the appropriate breakpoint ruler action associated with this profile.
 IAnnotationModel getDebuggerMarkerAnnotationModel(IResource resource, IEditorInput input)
          Get the debugger marker annotation model for this resource in this profile.
 String getTitle(LpexTextEditor editor)
          Get the editor title.
 void initializeLpexView(LpexTextEditor editor, LpexView lpexView)
          This is the profile for the "QSYS" type
 boolean isLocal()
          Queries if the profile is for local resources or remote resources.
 boolean isTargetDebuggable(IDebugTarget dbgtarget)
          Determine if the specified target is debuggable.
 boolean performSaveAs(LpexTextEditor editor, IProgressMonitor progressMonitor)
          The editor's default save as is done by returning true.
 boolean performSaveAs(LpexTextEditor editor, IProgressMonitor progressMonitor, String strFileName)
          The editor's default save as is done by returning true.
 void resetMarkers(LpexTextEditor editor)
          Reset markers associated with the resource being edited.
 void systemRemoteResourceChanged(ISystemRemoteChangeEvent event)
          This is the method in your class that will be called when a remote resource changes.
 void updateProfile(LpexTextEditor editor, LpexView lpexView)
          Give the AS400 object to any parsers that require it.
 
Methods inherited from class com.ibm.etools.systems.editor.SystemTextEditorProfileDefault
createContextMenuManager, fileHasSequenceNumbers, getCompileMessageClassBitMask, getCompileMessageClassName, hasSequenceNumbers, hasSequenceNumbers, initializeAsSEU, isEditorInputIncludedInContextMenu, isUniqueContextMenuManagerRequired, setCompileMessageClassBitMask, setCompileMessageClassName, updateProfile
 
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

_iseries

protected AS400 _iseries

_dbgEdContributor

protected DebugEditorActionContributor _dbgEdContributor
Constructor Detail

QSYSEditorProfile

public QSYSEditorProfile()
Method Detail

doSave

public void doSave(LpexTextEditor editor,
                   IProgressMonitor progressMonitor)
Description copied from class: SystemTextEditorProfileDefault
Refreshes the Lpex text area before saving.

Specified by:
doSave in interface ISystemTextEditorProfile
Overrides:
doSave in class SystemTextEditorProfileDefault

performSaveAs

public boolean performSaveAs(LpexTextEditor editor,
                             IProgressMonitor progressMonitor,
                             String strFileName)
Description copied from class: SystemTextEditorProfileDefault
The editor's default save as is done by returning true.

Specified by:
performSaveAs in interface ISystemTextEditorProfile
Overrides:
performSaveAs in class SystemTextEditorProfileDefault

performSaveAs

public boolean performSaveAs(LpexTextEditor editor,
                             IProgressMonitor progressMonitor)
Description copied from class: SystemTextEditorProfileDefault
The editor's default save as is done by returning true.

Specified by:
performSaveAs in interface ISystemTextEditorProfile
Overrides:
performSaveAs in class SystemTextEditorProfileDefault

initializeLpexView

public void initializeLpexView(LpexTextEditor editor,
                               LpexView lpexView)
This is the profile for the "QSYS" type

Specified by:
initializeLpexView in interface ISystemTextEditorProfile
Overrides:
initializeLpexView in class SystemTextEditorProfileDefault

updateProfile

public void updateProfile(LpexTextEditor editor,
                          LpexView lpexView)
Give the AS400 object to any parsers that require it.

Specified by:
updateProfile in interface ISystemTextEditorProfile
Overrides:
updateProfile in class SystemTextEditorProfileDefault

editorContextMenuAboutToShow

public void editorContextMenuAboutToShow(LpexTextEditor editor,
                                         IMenuManager menu)
Description copied from interface: ISystemTextEditorProfile
Called when JLpex's editorContextMenuAboutToShow is called

Specified by:
editorContextMenuAboutToShow in interface ISystemTextEditorProfile
Overrides:
editorContextMenuAboutToShow in class SystemTextEditorProfileDefault
See Also:
The default implementation of this method does nothing.

getTitle

public String getTitle(LpexTextEditor editor)
Get the editor title.

Specified by:
getTitle in interface ISystemTextEditorProfile
Overrides:
getTitle in class SystemTextEditorProfileDefault
Returns:
the title to display, or null if title can not be determined

isLocal

public boolean isLocal()
Description copied from interface: ISystemTextEditorProfile
Queries if the profile is for local resources or remote resources.

Specified by:
isLocal in interface ISystemTextEditorProfile
Overrides:
isLocal in class SystemTextEditorProfileDefault
Returns:
true if resource is local, false if resource is remote
See Also:
ISystemTextEditorProfile.isLocal()

resetMarkers

public void resetMarkers(LpexTextEditor editor)
Reset markers associated with the resource being edited.

Specified by:
resetMarkers in interface ISystemTextEditorProfile
Overrides:
resetMarkers in class SystemTextEditorProfileDefault

getBreakpointRulerAction

public IAction getBreakpointRulerAction(LpexTextEditor editor)
Returns the appropriate breakpoint ruler action associated with this profile.

Specified by:
getBreakpointRulerAction in interface ISystemTextEditorProfile
Overrides:
getBreakpointRulerAction in class SystemTextEditorProfileDefault
Returns:
the breakpoint ruler action, null if there is no such action

createDebugRulerActions

public void createDebugRulerActions(LpexTextEditor editor,
                                    IVerticalRuler ruler)
Create debug ruler actions associated with this profile.

Specified by:
createDebugRulerActions in interface ISystemTextEditorProfile
Overrides:
createDebugRulerActions in class SystemTextEditorProfileDefault

createDebugMenuActions

public void createDebugMenuActions(LpexTextEditor editor)
Create debug menu actions associated with this profile

Specified by:
createDebugMenuActions in interface ISystemTextEditorProfile
Overrides:
createDebugMenuActions in class SystemTextEditorProfileDefault

addDebugEditorMenuActions

public void addDebugEditorMenuActions(IMenuManager menu,
                                      boolean isDebuggable,
                                      int currentElement)
Add debug editor menu actions associated with this profile. If the source is not debuggable, leave out the debug actions

Specified by:
addDebugEditorMenuActions in interface ISystemTextEditorProfile
Overrides:
addDebugEditorMenuActions in class SystemTextEditorProfileDefault

addDebugEditorRulerActions

public void addDebugEditorRulerActions(IMenuManager menu,
                                       boolean isDebuggable,
                                       int currentElement)
Add debug editor ruler actions associated with this profile. If the source is not debuggable, leave out the debug actions

Specified by:
addDebugEditorRulerActions in interface ISystemTextEditorProfile
Overrides:
addDebugEditorRulerActions in class SystemTextEditorProfileDefault

isTargetDebuggable

public boolean isTargetDebuggable(IDebugTarget dbgtarget)
Determine if the specified target is debuggable. Returns true if the target is debuggable.

Specified by:
isTargetDebuggable in interface ISystemTextEditorProfile
Overrides:
isTargetDebuggable in class SystemTextEditorProfileDefault

getDebuggerMarkerAnnotationModel

public IAnnotationModel getDebuggerMarkerAnnotationModel(IResource resource,
                                                         IEditorInput input)
Get the debugger marker annotation model for this resource in this profile. Returns an annotation model

Specified by:
getDebuggerMarkerAnnotationModel in interface ISystemTextEditorProfile
Overrides:
getDebuggerMarkerAnnotationModel in class SystemTextEditorProfileDefault

systemRemoteResourceChanged

public void systemRemoteResourceChanged(ISystemRemoteChangeEvent event)
This is the method in your class that will be called when a remote resource changes. You will be called after the resource is changed.

See Also:
org.eclipse.rse.core.events.ISystemRemoteChangeListener#systemRemoteResourceChanged(org.eclipse.rse.core.events.ISystemRemoteChangeEvent)

Rational Developer for Power Systems Software
V7.6

Copyright © 2011 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.