com.ibm.etools.iseries.parsers
Class ISeriesEditorCobolILESqlCicsParser

java.lang.Object
  ILECobolSqlCicsParser
      com.ibm.etools.iseries.parsers.ISeriesEditorCobolILESqlCicsParser

All Implemented Interfaces:

IISeriesEditorConstantsCobolILE, IISeriesCompileErrorInfoViewHandler, IISeriesEditorConstants, IISeriesEditorParser, ISystemEditorConstants, ISystemTextEditorAdapterContributor, ISystemTextEditorContextContributor, ISystemTextEditorDebugContributor, ISystemTextEditorHelpContributor, ISystemTextEditorParser, ISystemTextEditorSourceViewerConfigurationContributor

public class ISeriesEditorCobolILESqlCicsParser
extends ILECobolSqlCicsParser
implements IISeriesEditorParser, IISeriesEditorConstantsCobolILE, IISeriesEditorConstants, ISystemTextEditorHelpContributor, ISystemTextEditorContextContributor, ISystemTextEditorDebugContributor, ISystemTextEditorAdapterContributor, ISystemTextEditorSourceViewerConfigurationContributor, IISeriesCompileErrorInfoViewHandler

Parser for Cobol Sql Cics.

Field Summary

protected boolean	_bDebugMode
protected boolean	_bIgnoreDatePreference
protected boolean	_bIgnoreParseExtras whether or not the parser extras are being ignored
protected boolean	_bIsPrimaryLpexView
protected boolean	_bLocal
protected boolean	_bOutlineViewNeedsResetting
protected ISeriesCompileEditManager	_compileEditManager
protected QSYSErrorMarkerListener	_compileErrorMarkerListener
protected String	_compileMarkNames
protected ISeriesEditorCOBOLSourceViewerConfiguration	_configuration code assist
protected LpexTextEditor	_editor
protected SystemTextEditorHelpHandler	_helpHandler
protected SystemTextEditorHelpHandler	_helpMessageHandler
protected PropertyResourceBundle	_helpResourceBundle
protected int	_iCCSID the CCSID for the source
protected IFile	_iFile
protected IQSYSMember	_member
protected IMenuManager	_menuCompile the compile menu
protected IMenuManager	_menuLanguageHelp
protected IMenuManager	_menuSource the Source menu
protected ISeriesEditorCobolILEContentOutlinePage	_page The outline page.
protected IBMiEditorCobolProgramVerifier	_programVerifier
protected ISeriesEditorCOBOLPrompter	_prompter
protected String	_strLocalFileName
protected ISeriesEditorCobolSyntaxChecker	_syntaxChecker
protected LpexView	_view
protected boolean	bIgnoreParseExtras whether or not the parser extras are being ignored
static String	copyright

Fields inherited from interface com.ibm.etools.iseries.parsers.IISeriesEditorParser

Copyright

Fields inherited from interface com.ibm.etools.iseries.edit.cobol.IISeriesEditorConstantsCobolILE

Copyright, PREF_COBOL_PREFIX, STRING_HELP_DOC_PLUGIN_ID, STRING_HELP_TABLE_FILENAME, STRING_HELP_TABLE_PLUGIN_ID, STRING_MESSAGE_HELP_DOC_PLUGIN_ID, STRING_MESSAGE_HELP_TABLE_FILENAME, STRING_MESSAGE_HELP_TABLE_PLUGIN_ID, STYLENAME_COMMENT, STYLENAME_COMPILER_DIRECTIVE, STYLENAME_DATE_FORMAT, STYLENAME_ERROR, STYLENAME_FUNCTION, STYLENAME_INDICATOR_AREA, STYLENAME_LAYOUT_BLANKS, STYLENAME_NONNUMERIC_LITERAL, STYLENAME_NUMERIC_LITERAL, STYLENAME_PICTURE_STRING, STYLENAME_PREPROCESSOR_STRING, STYLENAME_PSEUDO_TEXT, STYLENAME_RESERVED_WORD, STYLENAME_SEPERATOR, STYLENAME_SEQUENCE_NUMBER, STYLENAME_USER_DEFINED_WORD

Fields inherited from interface com.ibm.etools.iseries.edit.IISeriesEditorConstants

ACTION_VERIFYPROGRAM_ID, APPLICATION_DIAGRAM, COMPILE_ERROR_MESSAGE_STYLE, FILE_TYPE_CL, FILE_TYPE_DDS, FILE_TYPE_OTHER, FILE_TYPE_RPGILE, FILE_TYPE_RPGOPM, MAX_DS_NESTING, OUTLINE_VIEW, PREF_AUTO_FORMAT, PREF_AUTO_FORMAT_T, PREF_AUTO_UPPER, PREF_AUTO_UPPER_T, PREF_BASE_PREFIX, PREF_BLANK, PREF_BLANK_SUFFIX, PREF_BLANK_T, PREF_COMMAND_POS, PREF_COMMAND_POS_T, PREF_HIGHLIGHT, PREF_HIGHLIGHT_BACKGROUND, PREF_HIGHLIGHT_BACKGROUND_T, PREF_HIGHLIGHT_T, PREF_INDENT, PREF_INDENT_T, PREF_INDENTATION, PREF_INDENTATION_T, PREF_LABEL_ABOVE_CMD, PREF_LABEL_ABOVE_CMD_T, PREF_LABEL_POS, PREF_LABEL_POS_T, PREF_LINE_LENGTH, PREF_LINE_LENGTH_T, PREF_ONE_PARM_PER_LINE, PREF_ONE_PARM_PER_LINE_T, PREF_PARSER_ASSOC, PREF_PARSER_STYLES, PREF_SIGNATURE_T, PREF_SQL_SYNTAX_CHECK, PREF_SQL_SYNTAX_CHECK_T, PREF_SYNTAX_CHECK, PREF_SYNTAX_CHECK_T, PREF_TAB, PREF_TAB_GENERAL, PREF_TAB_GENERAL_T, PREF_TAB_T, PREF_TOOLTIP_SUFFIX, PROGRAM_VERIFICATION

Fields inherited from interface com.ibm.etools.systems.editor.ISystemEditorConstants

COMPILE_ERROR_CLASS_NAME, ICON_EDITOR_COMPILE, ICON_EDITOR_COMPILE_D, ICON_EDITOR_COMPILE_D_ID, ICON_EDITOR_COMPILE_D_ROOT, ICON_EDITOR_COMPILE_ID, ICON_EDITOR_COMPILE_ROOT, ICON_EDITOR_NEXT_ERROR, ICON_EDITOR_NEXT_ERROR_D, ICON_EDITOR_NEXT_ERROR_D_ID, ICON_EDITOR_NEXT_ERROR_D_ROOT, ICON_EDITOR_NEXT_ERROR_ID, ICON_EDITOR_NEXT_ERROR_ROOT, ICON_EDITOR_PREVIOUS_ERROR, ICON_EDITOR_PREVIOUS_ERROR_D, ICON_EDITOR_PREVIOUS_ERROR_D_ID, ICON_EDITOR_PREVIOUS_ERROR_D_ROOT, ICON_EDITOR_PREVIOUS_ERROR_ID, ICON_EDITOR_PREVIOUS_ERROR_ROOT, ICON_EXT, ICON_RELATIVE_PATH_DLCL16, ICON_RELATIVE_PATH_ELCL16, ICON_RELATIVE_PATH_FULL, ICON_SUFFIX, PREFIX, SYNTAX_ERROR_CLASS_NAME

Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorHelpContributor

Copyright

Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorContextContributor

Copyright

Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorDebugContributor

Copyright

Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorAdapterContributor

Copyright

Fields inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorSourceViewerConfigurationContributor

Copyright

Constructor Summary

ISeriesEditorCobolILESqlCicsParser(LpexView lpexView)
Constructor

Method Summary

void	addCompileError(int iElement, String strError) adds specified verify/compile error after the last error for iElement
void	addError(int iElement, String strError, char cMessageStyle) adds specified error after the last error for iElement
void	cleanupMenu(ITextEditor editor, IMenuManager menuManager) Removes the Source and Compile menu items
void	cleanupPopupMenu(ITextEditor editor, IMenuManager menuManager) Cleanup the popup menu.
void	cleanupToolBar(ITextEditor editor, IToolBarManager toolBarManager) removes the next and previous error toolbar buttons
protected void	contributeMenuItems(IMenuManager menuRoot, boolean bPopupMenu) Adds common menu items to the top of the root menu.
void	contributeToMenu(ITextEditor editor, IMenuManager menuManager) Contributes menu bar items.
void	contributeToPopupMenu(ITextEditor editor, IMenuManager menuRoot) Contributes popup menu bar items.
void	contributeToToolBar(ITextEditor editor, IToolBarManager toolBarManager) Contributes tool bar items.
void	copyCompileErrorInfo(LpexView secondaryView) Used to copy the compile message markers from the primary view to the newly opened secondary view.
protected void	createActions(ITextEditor editor) Creates menubar and toolbar actions.
protected void	doLpexAction(LpexView view, String action)
void	doPromptAction() Now supported.
void	doRefresh() The implementation does nothing.
void	doRefreshAction() Refreshes the display.
protected void	doShowErrorsAction(LpexView view) Filter view>Errors action
void	elementChanged(LpexView lpexView) v6.0.0 - ES - removed highlight line, use LPEX's version instead
void	finishedSaving(ITextEditor editor) Method finishedSaving Does nothing for this Parser
void	focusGained(FocusEvent event) when focus is gained, refresh and settings which may have been set in the preferences v6.0.0 - ES - removed highlight line, use LPEX's version instead NOTE: any changes in the following block must be propagated to all other COBOL parsers and ISeriesEditorParser
void	focusLost(FocusEvent event) v6.0.0 - ES - removed highlight line, use LPEX's version instead NOTE: any changes in the following block must be propagated to all other COBOL parsers and ISeriesEditorParser
Object	getAdapter(LpexTextEditor editor, Class classRequired) Called by the editor to return an adapter.
long	getCommentClass()
LpexTextEditor	getEditor() The parser returns the editor (if known)
IQSYSFile	getFieldFile() Method getFieldFile.
LpexFieldsProvider	getFieldsProvider() Retrieves the fields provider for the parser.
IISeriesEditorFormatLine	getFormatLine() Returns the format line ruler.
SystemTextEditorHelpHandler	getHelpHandler() Returns the help handler for this parser.
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 bPromptAllowed) This method returns an ISeries connection object.
IQSYSMember	getISeriesMember() Method getISeriesMember.
String	getLocalFileName() Get the local file name.
LpexLanguageHelp	getLpexLanguageHelpHandler() Declared in ISystemTextEditorHelpContributor
LpexView	getLpexView() Get the lpexView associated with the parser
String	getLshToken() Declared in LpexLanguageHelp.
LanguageModel	getModel(boolean bUpdate) Called by the editor to return an adapter.
protected String	getPopupItems(int popupLocation)
IISeriesEditorProgramVerifier	getProgramVerifier() Returns the program verifier.
IISeriesEditorPromptAdapter	getPromptAdapter() Returns the prompt adapter.
IPropertySheetPage	getPropertySheet() Get property sheet
LpexSourceViewerConfiguration	getSourceViewerConfiguration() Returns the source viewer configuration.
IISeriesEditorSyntaxChecker	getSyntaxChecker() Returns the syntax checker.
void	initializeLpexView(LpexView lpexView) Same as for iSeriesEditorParser, must always be in sync.
protected void	initializeTabs() Initializes tab stops.
protected void	initParser() initialize parser
boolean	isLineDebuggable(int iLine) Returns true to let the super class know that this parser supports debugging.
boolean	isLocal() Returns whether the input resource is local.
boolean	isOverrideDatePreference()
boolean	isReadOnly() Returns whether the editor is in read only state.
boolean	isValidFieldAction() Method isValidFieldAction.
boolean	isValidIncludeAction() Method isValidIncludeAction.
void	parseElement(int iElement) Performs automatic syntax checking after parsing.
void	parseElementForCodeAssist(int iElement)
void	prompt() Called by the editor whenever F4 is pressed.
void	promptRequest() Called when the shift-F4 key was just pressed, before the focus is given to the prompter.
void	removeErrors(int iElement) Removes all the error messages from the specifed line number.
void	removeErrors(int iStartElement, int iEndElement) Removes the errors from the specified range of elements
protected void	resetOutlineView() Resets the outline view
void	saving(ITextEditor editor) Method saving.
void	selectionLinesChanged(int iOrigin, int iExtent) Called when user clicks on an entry in the outline view.
void	setCompileErrorInfo(ISeriesCompileEditManager compileEditManager, String markNames, QSYSErrorMarkerListener errorMarkerListener) Used to set the compile information to be used when splitting a view so that errors appear in the splits.
void	setDebugMode(boolean bDebugMode) Sets the debug state.
void	setEditor(LpexTextEditor editor) Method setEditor.
void	setEnableParseExtras(boolean bEnable) Method setEnableParseExtras.
void	setLocal(boolean bLocal) Sets whether the input resource is local.
void	setOverrideDatePreference()
void	terminateParser() When parsing is disabled, turn on autoCheck
protected void	updateProfileForActions(LpexView lpexView) Same as for iSeriesEditorParser, must always be in sync.
protected void	upperCaseElement(int _startElement, int _endElement) Performs uppercasing of Elements if requested

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.etools.systems.editor.ISystemTextEditorParser

getLanguage

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

_syntaxChecker

protected ISeriesEditorCobolSyntaxChecker _syntaxChecker

_programVerifier

protected IBMiEditorCobolProgramVerifier _programVerifier

_view

protected LpexView _view

_helpResourceBundle

protected PropertyResourceBundle _helpResourceBundle

_helpHandler

protected SystemTextEditorHelpHandler _helpHandler

_helpMessageHandler

protected SystemTextEditorHelpHandler _helpMessageHandler

_menuLanguageHelp

protected IMenuManager _menuLanguageHelp

_bIgnoreDatePreference

protected boolean _bIgnoreDatePreference

_bIsPrimaryLpexView

protected boolean _bIsPrimaryLpexView

_bOutlineViewNeedsResetting

protected boolean _bOutlineViewNeedsResetting

_page

protected ISeriesEditorCobolILEContentOutlinePage _page

The outline page.

_configuration

protected ISeriesEditorCOBOLSourceViewerConfiguration _configuration

code assist

_bDebugMode

protected boolean _bDebugMode

_bLocal

protected boolean _bLocal

_strLocalFileName

protected String _strLocalFileName

_member

protected IQSYSMember _member

_editor

protected LpexTextEditor _editor

_iFile

protected IFile _iFile

_iCCSID

protected int _iCCSID

the CCSID for the source

_menuSource

protected IMenuManager _menuSource

the Source menu

_menuCompile

protected IMenuManager _menuCompile

the compile menu

bIgnoreParseExtras

protected boolean bIgnoreParseExtras

whether or not the parser extras are being ignored

_bIgnoreParseExtras

protected boolean _bIgnoreParseExtras

whether or not the parser extras are being ignored

_prompter

protected ISeriesEditorCOBOLPrompter _prompter

_compileMarkNames

protected String _compileMarkNames

_compileErrorMarkerListener

protected QSYSErrorMarkerListener _compileErrorMarkerListener

_compileEditManager

protected ISeriesCompileEditManager _compileEditManager

Constructor Detail

ISeriesEditorCobolILESqlCicsParser

public ISeriesEditorCobolILESqlCicsParser(LpexView lpexView)

Constructor

Method Detail

initParser

protected void initParser()

initialize parser

doShowErrorsAction

protected void doShowErrorsAction(LpexView view)

Filter view>Errors action

Parameters:

view -

Since:

601 59769

addError

public void addError(int iElement,
                     String strError,
                     char cMessageStyle)

adds specified error after the last error for iElement

Specified by:

addError in interface IISeriesEditorParser

Parameters:

iElement - the element number where the error is to be inserted

error - the error text

the - character which represents the message style

addCompileError

public void addCompileError(int iElement,
                            String strError)

adds specified verify/compile error after the last error for iElement

Specified by:

addCompileError in interface IISeriesEditorParser

Parameters:

iElement - the element number where the error is to be inserted

error - the error text

the - character which represents the message style *** NOTE if you modify this method, you should also modify the ISeriesEditorParser and the other COBOL parsers!

cleanupMenu

public void cleanupMenu(ITextEditor editor,
                        IMenuManager menuManager)

Removes the Source and Compile menu items

Specified by:

cleanupMenu in interface ISystemTextEditorContextContributor

See Also:

ISystemTextEditorContextContributor.cleanupMenu(ITextEditor, IMenuManager)

cleanupPopupMenu

public void cleanupPopupMenu(ITextEditor editor,
                             IMenuManager menuManager)

Description copied from interface: ISystemTextEditorContextContributor

Cleanup the popup menu.

Specified by:

cleanupPopupMenu in interface ISystemTextEditorContextContributor

See Also:

ISystemTextEditorContextContributor.cleanupPopupMenu(ITextEditor, IMenuManager)

cleanupToolBar

public void cleanupToolBar(ITextEditor editor,
                           IToolBarManager toolBarManager)

removes the next and previous error toolbar buttons

Specified by:

cleanupToolBar in interface ISystemTextEditorContextContributor

See Also:

ISystemTextEditorContextContributor.cleanupToolBar(ITextEditor, IToolBarManager)

contributeMenuItems

protected void contributeMenuItems(IMenuManager menuRoot,
                                   boolean bPopupMenu)

Adds common menu items to the top of the root menu.

contributeToMenu

public void contributeToMenu(ITextEditor editor,
                             IMenuManager menuManager)

Contributes menu bar items.

Specified by:

contributeToMenu in interface ISystemTextEditorContextContributor

contributeToPopupMenu

public void contributeToPopupMenu(ITextEditor editor,
                                  IMenuManager menuRoot)

Contributes popup menu bar items.

Specified by:

contributeToPopupMenu in interface ISystemTextEditorContextContributor

contributeToToolBar

public void contributeToToolBar(ITextEditor editor,
                                IToolBarManager toolBarManager)

Contributes tool bar items.

Specified by:

contributeToToolBar in interface ISystemTextEditorContextContributor

createActions

protected void createActions(ITextEditor editor)

Creates menubar and toolbar actions.

doPromptAction

public void doPromptAction()

Now supported. @03C

Specified by:

doPromptAction in interface IISeriesEditorParser

prompt

public void prompt()

Called by the editor whenever F4 is pressed. promptRequest is called first. Default implementation gives focus to the source prompt view. CL parser asks the AS400 to display a prompt dialog.

promptRequest

public void promptRequest()

Called when the shift-F4 key was just pressed, before the focus is given to the prompter. Parse and tokenize the line and notify the prompter. This is done in case the user has changed the line.

doLpexAction

protected void doLpexAction(LpexView view,
                            String action)

doRefreshAction

public void doRefreshAction()

Refreshes the display.

finishedSaving

public void finishedSaving(ITextEditor editor)

Method finishedSaving Does nothing for this Parser

Specified by:

finishedSaving in interface ISystemTextEditorContextContributor

See Also:

ISystemTextEditorContextContributor.finishedSaving(ITextEditor)

elementChanged

public void elementChanged(LpexView lpexView)

v6.0.0 - ES - removed highlight line, use LPEX's version instead

See Also:

com.ibm.lpex.core.LpexCursorListener#elementChanged(LpexView)

focusGained

public void focusGained(FocusEvent event)

when focus is gained, refresh and settings which may have been set in the preferences v6.0.0 - ES - removed highlight line, use LPEX's version instead NOTE: any changes in the following block must be propagated to all other COBOL parsers and ISeriesEditorParser

See Also:

FocusListener

focusLost

public void focusLost(FocusEvent event)

v6.0.0 - ES - removed highlight line, use LPEX's version instead NOTE: any changes in the following block must be propagated to all other COBOL parsers and ISeriesEditorParser

See Also:

FocusListener

getAdapter

public Object getAdapter(LpexTextEditor editor,
                         Class classRequired)

Called by the editor to return an adapter.

Specified by:

getAdapter in interface ISystemTextEditorAdapterContributor

getEditor

public LpexTextEditor getEditor()

Description copied from interface: IISeriesEditorParser

The parser returns the editor (if known)

Specified by:

getEditor in interface IISeriesEditorParser

getHelpHandler

public SystemTextEditorHelpHandler getHelpHandler()

Returns the help handler for this parser.

Specified by:

getHelpHandler in interface IISeriesEditorParser

getIFile

public IFile getIFile()

Description copied from interface: IISeriesEditorParser

gets the IFile for the source in the editor

Specified by:

getIFile in interface IISeriesEditorParser

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#getIFile()

getImage

public Image getImage(String strImageName)

Description copied from interface: IISeriesEditorParser

The parser returns an image given the image name, or null if there is no image.

Specified by:

getImage in interface IISeriesEditorParser

getISeriesConnection

public IBMiConnection getISeriesConnection(boolean bPromptAllowed)

This method returns an ISeries connection object. It first looks at the IFile for a connection. If there isn't one, then the file is probably a local file. The connection is then obtained from the user preferences. If a default connection has been specified, then it is used. If the user has asked to prompt for a connection, a prompt dialog is displayed that allows the user to select a connection.

Specified by:

getISeriesConnection in interface IISeriesEditorParser

Parameters:

bPromptAllowed - true if the user is allowed to be prompted, false otherwise

Returns:

ISeriesConnection the connection

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#getISeriesConnection(boolean)

getISeriesMember

public IQSYSMember getISeriesMember()

Description copied from interface: IISeriesEditorParser

Method getISeriesMember. returns the iSeries member associated with the parser

Specified by:

getISeriesMember in interface IISeriesEditorParser

Returns:

ISeriesMember the member that this parser is parsing

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#getISeriesMember()

getLocalFileName

public String getLocalFileName()

Description copied from interface: ISystemTextEditorParser

Get the local file name.

Specified by:

getLocalFileName in interface ISystemTextEditorParser

Returns:

the local file name

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#getFileName()

getLpexLanguageHelpHandler

public LpexLanguageHelp getLpexLanguageHelpHandler()

Declared in ISystemTextEditorHelpContributor

Specified by:

getLpexLanguageHelpHandler in interface ISystemTextEditorHelpContributor

getFieldFile

public IQSYSFile getFieldFile()

Method getFieldFile. Returns the file object to show fields for.

Specified by:

getFieldFile in interface IISeriesEditorParser

Returns:

ISeriesFile the file to open a table view of fields for

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#getFieldFile()

getIncludeMember

public IQSYSMember getIncludeMember()

Description copied from interface: IISeriesEditorParser

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

Specified by:

getIncludeMember in interface IISeriesEditorParser

Returns:

the ISeriesMember to edit/browse

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#getIncludeMember()

isLocal

public boolean isLocal()

Description copied from interface: ISystemTextEditorParser

Returns whether the input resource is local.

Specified by:

isLocal in interface ISystemTextEditorParser

Returns:

true if the input resource is local, or false if input resource is of remote origin.

See Also:

ISystemTextEditorParser.isLocal()

isReadOnly

public boolean isReadOnly()

Returns whether the editor is in read only state.

Specified by:

isReadOnly in interface IISeriesEditorParser

isValidFieldAction

public boolean isValidFieldAction()

Method isValidFieldAction. returns whether or now the show fields action can be run on the line

Specified by:

isValidFieldAction in interface IISeriesEditorParser

Returns:

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

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#isValidFieldAction()

isValidIncludeAction

public boolean isValidIncludeAction()

Description copied from interface: IISeriesEditorParser

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

Specified by:

isValidIncludeAction in interface IISeriesEditorParser

Returns:

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

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#isValidIncludeAction()

getLshToken

public String getLshToken()

Declared in LpexLanguageHelp. Return the token (in this case the Help resource ID) for Language Sensitive Help.

getModel

public LanguageModel getModel(boolean bUpdate)

Called by the editor to return an adapter.

Specified by:

getModel in interface IISeriesEditorParser

getPopupItems

protected String getPopupItems(int popupLocation)

See Also:

com.ibm.lpex.core.LpexCommonParser#getPopupItems(int)

getProgramVerifier

public IISeriesEditorProgramVerifier getProgramVerifier()

Returns the program verifier.

Specified by:

getProgramVerifier in interface IISeriesEditorParser

getPromptAdapter

public IISeriesEditorPromptAdapter getPromptAdapter()

Returns the prompt adapter. //@03C

Specified by:

getPromptAdapter in interface IISeriesEditorParser

getPropertySheet

public IPropertySheetPage getPropertySheet()

Get property sheet

Specified by:

getPropertySheet in interface IISeriesEditorParser

getSourceViewerConfiguration

public LpexSourceViewerConfiguration getSourceViewerConfiguration()

Returns the source viewer configuration. Default implementation returns null.

Specified by:

getSourceViewerConfiguration in interface ISystemTextEditorSourceViewerConfigurationContributor

getSyntaxChecker

public IISeriesEditorSyntaxChecker getSyntaxChecker()

Returns the syntax checker.

Specified by:

getSyntaxChecker in interface IISeriesEditorParser

getFormatLine

public IISeriesEditorFormatLine getFormatLine()

Returns the format line ruler. Default implementation returns null.

Specified by:

getFormatLine in interface IISeriesEditorParser

initializeLpexView

public void initializeLpexView(LpexView lpexView)

Same as for iSeriesEditorParser, must always be in sync. IMPORTANT!!!!!!!! NOTE: if you modify this method, you NEED to propate all changes to both COBOL parsers AND ISeriesEditorParser

Specified by:

initializeLpexView in interface IISeriesEditorParser

initializeTabs

protected void initializeTabs()

Initializes tab stops. Any changes to this method should be propagated to both COBOL parsers

isLineDebuggable

public boolean isLineDebuggable(int iLine)

Returns true to let the super class know that this parser supports debugging.

Specified by:

isLineDebuggable in interface ISystemTextEditorDebugContributor

setLocal

public void setLocal(boolean bLocal)

Description copied from interface: ISystemTextEditorParser

Sets whether the input resource is local.

Specified by:

setLocal in interface ISystemTextEditorParser

See Also:

ISystemTextEditorParser.setLocal(boolean)

parseElement

public void parseElement(int iElement)

Performs automatic syntax checking after parsing.

upperCaseElement

protected void upperCaseElement(int _startElement,
                                int _endElement)

Performs uppercasing of Elements if requested

parseElementForCodeAssist

public void parseElementForCodeAssist(int iElement)

removeErrors

public void removeErrors(int iElement)

Removes all the error messages from the specifed line number.

Specified by:

removeErrors in interface ISystemTextEditorParser

Parameters:

iLineNum - the line number where you want to remove all the messages

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#removeError(int)

removeErrors

public void removeErrors(int iStartElement,
                         int iEndElement)

Removes the errors from the specified range of elements

Specified by:

removeErrors in interface ISystemTextEditorParser

See Also:

*** NOTE if you modify this method, you should also modify the other COBOL parsers and ISeriesEditorParser

saving

public void saving(ITextEditor editor)

Method saving. Called before saving. Does the resequence on save

Specified by:

saving in interface ISystemTextEditorContextContributor

selectionLinesChanged

public void selectionLinesChanged(int iOrigin,
                                  int iExtent)

Called when user clicks on an entry in the outline view. This method determiens the location of the statement that was clicked on, then displays the statement in the editor window.

Specified by:

selectionLinesChanged in interface IISeriesEditorParser

Parameters:

iLineOrigin - - begin of higlighted range

iLineExtent - - number of lines in highlighted range

setDebugMode

public void setDebugMode(boolean bDebugMode)

Sets the debug state.

Specified by:

setDebugMode in interface ISystemTextEditorDebugContributor

setEditor

public void setEditor(LpexTextEditor editor)

Description copied from interface: IISeriesEditorParser

Method setEditor. Sets up the editor and related info for the parser

Specified by:

setEditor in interface IISeriesEditorParser

Parameters:

editor - the editor for this parser

See Also:

The CCSID is set here. If the file CCSID is invalid, the job CCSID is used. The CCSID is used later to obtain the special translation characters in getSpecialChars.

IMPORTANT!!!!!!!! NOTE: if you modify this method, you NEED to propate all changes to both COBOL parsers AND ISeriesEditorParser

setEnableParseExtras

public void setEnableParseExtras(boolean bEnable)

Description copied from interface: IISeriesEditorParser

Method setEnableParseExtras. disables/enables the parser from doing extra things like uppercasing and formatting

Specified by:

setEnableParseExtras in interface IISeriesEditorParser

Parameters:

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

See Also:

com.ibm.etools.iseries.editor.IISeriesEditorParser#setEnableParseExtras(boolean)

updateProfileForActions

protected void updateProfileForActions(LpexView lpexView)

Same as for iSeriesEditorParser, must always be in sync. IMPORTANT!!!!!!!! NOTE: if you modify this method, you NEED to propate all changes to both COBOL parsers AND ISeriesEditorParser

Parameters:

lpexView -

terminateParser

public void terminateParser()

When parsing is disabled, turn on autoCheck

See Also:

com.ibm.lpex.core.LpexCommonParser#terminateParser()

setOverrideDatePreference

public void setOverrideDatePreference()

isOverrideDatePreference

public boolean isOverrideDatePreference()

getCommentClass

public long getCommentClass()

getLpexView

public LpexView getLpexView()

Get the lpexView associated with the parser

Specified by:

getLpexView in interface IISeriesEditorParser

setCompileErrorInfo

public void setCompileErrorInfo(ISeriesCompileEditManager compileEditManager,
                                String markNames,
                                QSYSErrorMarkerListener errorMarkerListener)

Description copied from interface: IISeriesCompileErrorInfoViewHandler

Used to set the compile information to be used when splitting a view so that errors appear in the splits.

Specified by:

setCompileErrorInfo in interface IISeriesCompileErrorInfoViewHandler

markNames - the list of names of marks in the primary view

copyCompileErrorInfo

public void copyCompileErrorInfo(LpexView secondaryView)

Description copied from interface: IISeriesCompileErrorInfoViewHandler

Used to copy the compile message markers from the primary view to the newly opened secondary view.

Specified by:

copyCompileErrorInfo in interface IISeriesCompileErrorInfoViewHandler

getFieldsProvider

public LpexFieldsProvider getFieldsProvider()

Retrieves the fields provider for the parser. Returns null if there is no fields provider

Specified by:

getFieldsProvider in interface IISeriesEditorParser

Since:

6.0.1 //SE23218

resetOutlineView

protected void resetOutlineView()

Resets the outline view

Since:

6.0.1.1

doRefresh

public void doRefresh()

The implementation does nothing.

Specified by:

doRefresh in interface ISystemTextEditorParser

See Also:

ISystemTextEditorParser.doRefresh()