iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.editor
Interface IISeriesEditorParser

All Superinterfaces:
com.ibm.etools.systems.editor.ISystemTextEditorParser
All Known Implementing Classes:
ISeriesEditorCobol400SqlCicsParser, ISeriesEditorCobolILESqlCicsParser, ISeriesEditorParser

public interface IISeriesEditorParser
extends com.ibm.etools.systems.editor.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.
 com.ibm.lpex.alef.LpexTextEditor getEditor()
          The parser returns the editor (if known)
 ISeriesFile getFieldFile()
          Method getFieldFile.
 com.ibm.lpex.core.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.
 com.ibm.etools.systems.editor.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.
 ISeriesMember getIncludeMember()
          Method getIncludeMember.
 ISeriesConnection getISeriesConnection(boolean bIsPromptAllowed)
          Method getISeriesConnection.
 ISeriesMember getISeriesMember()
          Method getISeriesMember.
 com.ibm.lpex.core.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(com.ibm.lpex.core.LpexView lpexView)
          Called by the base class when the parser is constructed.
 boolean isOverrideDatePreference()
          Indicates whether or not the date preference has been overriden by the show date popup menu option
 boolean isReadOnly()
          Queries the readonly state.
 boolean isValidFieldAction()
          Method isValidFieldAction.
 boolean isValidIncludeAction()
          Method isValidIncludeAction.
 void removeErrors(int iElement)
          Method removeError.
 void removeErrors(int iStartElement, int iEndElement)
          Method removeErrors.
 void selectionLinesChanged(int iLineFirst, int iLineLast)
          Notifies the parser that the vertical ruler highlight should be changed to reflect the given lines.
 void setConnectionListener(ISeriesEditorConnectListener cl)
          Sets the connection listener for this parser
 void setEditor(com.ibm.lpex.alef.LpexTextEditor editor)
          Method setEditor.
 void setEnableParseExtras(boolean bEnable)
          Method setEnableParseExtras.
 void setOverrideDatePreference()
          Tells the parser that the show date preference has been overridden
 
Methods inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorParser
getLanguage, getLocalFileName, isLocal, setLocal
 

Field Detail

Copyright

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

doPromptAction

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


getEditor

public com.ibm.lpex.alef.LpexTextEditor getEditor()
The parser returns the editor (if known)


getFormatLine

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


getHelpHandler

public com.ibm.etools.systems.editor.SystemTextEditorHelpHandler getHelpHandler()
The parser returns the class that implements LpexLanguageHelp. The class can also map resource IDs to help page IDs.


getImage

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


getModel

public 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

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


getPromptAdapter

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


getPropertySheet

public IPropertySheetPage getPropertySheet()
The parser returns a property sheet.


getSyntaxChecker

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


getIncludeMember

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

Returns:
the ISeriesMember to edit/browse

getISeriesMember

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

Returns:
ISeriesMember the member that this parser is parsing

getISeriesConnection

public ISeriesConnection 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

public ISeriesFile 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

public void initializeLpexView(com.ibm.lpex.core.LpexView lpexView)
Called by the base class when the parser is constructed. Subclasses may override.


isReadOnly

public boolean isReadOnly()
Queries the readonly state.


isValidFieldAction

public 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

public 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

public 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

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


addError

public 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

public 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

removeErrors

public void removeErrors(int iElement)
Method removeError. removes the errors from the specified line

Parameters:
iElement - the element number to remove all the errors for

removeErrors

public void removeErrors(int iStartElement,
                         int iEndElement)
Method removeErrors. removes all the errors for the elements in the specified range

Parameters:
iStartElement -

setEnableParseExtras

public 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

public void setEditor(com.ibm.lpex.alef.LpexTextEditor editor)
Method setEditor. Sets up the editor and related info for the parser

Parameters:
editor - the editor for this parser

setConnectionListener

public void setConnectionListener(ISeriesEditorConnectListener cl)
Sets the connection listener for this parser

Parameters:
cl -
Since:
5.1.2 53278

setOverrideDatePreference

public void setOverrideDatePreference()
Tells the parser that the show date preference has been overridden

Since:
5.1.2 54872

isOverrideDatePreference

public boolean isOverrideDatePreference()
Indicates whether or not the date preference has been overriden by the show date popup menu option

Returns:
Since:
5.1.2 54872

getLpexView

public com.ibm.lpex.core.LpexView getLpexView()
Used to get the view associated with the parser

Since:
6.0.1 59770

getFieldsProvider

public com.ibm.lpex.core.LpexFieldsProvider getFieldsProvider()
Used to retrieve the fields provider for column sensitive editing, if available

Since:
6.0.1 //SE23218

iSeries Remote Systems
v6.0.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.