Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.parsers
Interface IISeriesEditorParser

All Superinterfaces:
ISystemTextEditorParser
All Known Implementing Classes:
ISeriesEditorCLParser, ISeriesEditorCobol400SqlCicsParser, ISeriesEditorCobolILESqlCicsParser, ISeriesEditorDDSParser, ISeriesEditorParser, ISeriesEditorRPGILEParser, ISeriesEditorRPGILESQLParser, ISeriesEditorRPGOPMParser

public interface IISeriesEditorParser
extends ISystemTextEditorParser

Implemented by all iSeries editor parsers.


Field Summary
static String Copyright
           
 
Method Summary
 void addCompileError(int iElement, String strError)
          Method addCompileError.
 void addError(int iElement, String strError, char cMessageStyle)
          Method addError.
 void doPromptAction()
          Called when the prompt menu item is selected.
 LpexTextEditor getEditor()
          The parser returns the editor (if known)
 IQSYSFile getFieldFile()
          Method getFieldFile.
 LpexFieldsProvider getFieldsProvider()
          Used to retrieve the fields provider for column sensitive editing, if available
 IISeriesEditorFormatLine getFormatLine()
          The parser returns the format line ruler if supported.
 SystemTextEditorHelpHandler getHelpHandler()
          The parser returns the class that implements LpexLanguageHelp.
 IFile getIFile()
          gets the IFile for the source in the editor
 Image getImage(String strImageName)
          The parser returns an image given the image name, or null if there is no image.
 IQSYSMember getIncludeMember()
          Method getIncludeMember.
 IBMiConnection getISeriesConnection(boolean bIsPromptAllowed)
          Method getISeriesConnection.
 IQSYSMember getISeriesMember()
          Method getISeriesMember.
 LpexView getLpexView()
          Used to get the view associated with the parser
 LanguageModel getModel(boolean bUpdate)
          Returns the model that is an elements and attributes tree model.
 IISeriesEditorProgramVerifier getProgramVerifier()
          The parser returns the program verifier if supported.
 IISeriesEditorPromptAdapter getPromptAdapter()
          The parser returns an adapter that communicates with the source prompt view.
 IPropertySheetPage getPropertySheet()
          The parser returns a property sheet.
 IISeriesEditorSyntaxChecker getSyntaxChecker()
          The parser returns the syntax checker if supported.
 void initializeLpexView(LpexView lpexView)
          Called by the base class when the parser is constructed.
 boolean isReadOnly()
          Queries the readonly state.
 boolean isValidFieldAction()
          Method isValidFieldAction.
 boolean isValidIncludeAction()
          Method isValidIncludeAction.
 void selectionLinesChanged(int iLineFirst, int iLineLast)
          Notifies the parser that the vertical ruler highlight should be changed to reflect the given lines.
 void setEditor(LpexTextEditor editor)
          Method setEditor.
 void setEnableParseExtras(boolean bEnable)
          Method setEnableParseExtras.
 
Methods inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorParser
doRefresh, getLanguage, getLocalFileName, isLocal, removeErrors, removeErrors, setLocal
 

Field Detail

Copyright

static final String Copyright
See Also:
Constant Field Values
Method Detail

doPromptAction

void doPromptAction()
Called when the prompt menu item is selected. Subclasses may override.


getEditor

LpexTextEditor getEditor()
The parser returns the editor (if known)


getFormatLine

IISeriesEditorFormatLine getFormatLine()
The parser returns the format line ruler if supported.


getHelpHandler

SystemTextEditorHelpHandler getHelpHandler()
The parser returns the class that implements LpexLanguageHelp. The class can also map resource IDs to help page IDs.


getImage

Image getImage(String strImageName)
The parser returns an image given the image name, or null if there is no image.


getModel

LanguageModel getModel(boolean bUpdate)
Returns the model that is an elements and attributes tree model. If the update flag is true, then the model is expected to be refreshed, and the refreshed model content is displayed.


getProgramVerifier

IISeriesEditorProgramVerifier getProgramVerifier()
The parser returns the program verifier if supported.


getPromptAdapter

IISeriesEditorPromptAdapter getPromptAdapter()
The parser returns an adapter that communicates with the source prompt view.


getPropertySheet

IPropertySheetPage getPropertySheet()
The parser returns a property sheet.


getSyntaxChecker

IISeriesEditorSyntaxChecker getSyntaxChecker()
The parser returns the syntax checker if supported.


getIncludeMember

IQSYSMember getIncludeMember()
Method getIncludeMember. called by the include action to get the member to open

Returns:
the ISeriesMember to edit/browse

getISeriesMember

IQSYSMember getISeriesMember()
Method getISeriesMember. returns the iSeries member associated with the parser

Returns:
ISeriesMember the member that this parser is parsing

getISeriesConnection

IBMiConnection getISeriesConnection(boolean bIsPromptAllowed)
Method getISeriesConnection. return the ISeriesConnection for the source, null if it not an ISeries source

Parameters:
bIsPromptAllowed - true if the user is allowed to be prompted, false otherwise
Returns:
ISeriesConnection the connection

getFieldFile

IQSYSFile getFieldFile()
Method getFieldFile. Returns the iSeries file object that the field action can run against. Returns null if the cursor is not on a line where the ISeriesEditorField action is valid.

Returns:
ISeriesFile the file to open a table view of fields for

initializeLpexView

void initializeLpexView(LpexView lpexView)
Called by the base class when the parser is constructed. Subclasses may override.


isReadOnly

boolean isReadOnly()
Queries the readonly state.


isValidFieldAction

boolean isValidFieldAction()
Method isValidFieldAction. Called to determine whether or not the show fields action is valid

Returns:
boolean true if the current line has a file name for show field action, false otherwise.

isValidIncludeAction

boolean isValidIncludeAction()
Method isValidIncludeAction. Called to determine whether or not the include action is valid

Returns:
boolean true id the current line has a valid member for the include action, false otherwise

selectionLinesChanged

void selectionLinesChanged(int iLineFirst,
                           int iLineLast)
Notifies the parser that the vertical ruler highlight should be changed to reflect the given lines. This is used in conjunction with the content outline view.


getIFile

IFile getIFile()
gets the IFile for the source in the editor


addError

void addError(int iElement,
              String strError,
              char cMessageStyle)
Method addError. adds an error to the view

Parameters:
iElement - the element number that the error belongs to
strError - the text of the error
cMessageStyle - the style character for the error

addCompileError

void addCompileError(int iElement,
                     String strError)
Method addCompileError. adds an error to the view

Parameters:
iElement - the element number that the error belongs to
strError - the text of the error

setEnableParseExtras

void setEnableParseExtras(boolean bEnable)
Method setEnableParseExtras. disables/enables the parser from doing extra things like uppercasing and formatting

Parameters:
bEnable - whether or not the parsers should ignore the extra features they may have

setEditor

void setEditor(LpexTextEditor editor)
Method setEditor. Sets up the editor and related info for the parser

Parameters:
editor - the editor for this parser

getLpexView

LpexView getLpexView()
Used to get the view associated with the parser

Since:
6.0.1 59770

getFieldsProvider

LpexFieldsProvider getFieldsProvider()
Used to retrieve the fields provider for column sensitive editing, if available

Since:
6.0.1 //SE23218

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.