Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.edit.views
Interface IISeriesEditorPromptAdapter

All Known Implementing Classes:
ISeriesEditorCOBOLPrompter, ISeriesEditorDDSPrompter, ISeriesEditorPrompter, ISeriesEditorRPGILEPrompter, ISeriesEditorRPGOPMPrompter

public interface IISeriesEditorPromptAdapter

This adapter is the interface between a prompt view page and an ISeries editor. The editor implements this interface, as well as the getAdapter method for 'IISeriesEditorPromptAdapter.class'.


Field Summary
static String copyright
           
 
Method Summary
 void addPromptChangeListener(IISeriesEditorPromptChangeListener listener)
          The editor is to add a prompt change listener to its list of listeners.
 void displayHelp(String strHelpResourceID)
          Requests that the help for the given help resource identifier be displayed.
 void displayMessageHelp(String strMessageID)
          Requests that the help for the given message identifier be displayed.
 IISeriesEditorPromptChangeListener getPromptChangeListener()
          Return the listener
 String getPromptEncoding()
          The editor is to return the codepage.
 Font getPromptFont()
          The editor is to return the font that it is using.
 String getPromptFormatLine(String strPageId)
          The editor is to return the format line for the given prompt page identifier.
 ISeriesEditorPromptGroup getPromptGroup()
          The adapter is to return the field information for a group of spec types.
 int getPromptMaxLineLength()
          Returns the maximum line length of all editor text lines excluding the sequence/prefix area, or -1 if unknown.
 int getPromptPageIndex(int iElement)
          The adapter is to return the page index for the given line number.
 boolean getRetainLowerCase()
          Multiple choice fields represented by a combo box display choices in upper case.
 IISeriesEditorSyntaxChecker getSyntaxChecker()
          Returns a syntax checker or null if not applicable.
 void promptElementChanged(int iElementNumber, String strText)
          The editor is being notified by the prompter that the line of text has been changed by the user within the prompt view.
 void promptLineChanged(int iLineNumber, String strText)
          The editor is being notified by the prompter that the line of text has been changed by the user within the prompt view.
 void removePromptChangeListener(IISeriesEditorPromptChangeListener listener)
          The editor is to remove a prompt change listener from its list of listeners.
 void setInsertModeAction(Action actionInsertMode)
          Gives the adapter the action that tells it whether a new line should be created when the prompt view's apply button is pressed, or whether an existing line should be replaced.
 

Field Detail

copyright

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

addPromptChangeListener

void addPromptChangeListener(IISeriesEditorPromptChangeListener listener)
The editor is to add a prompt change listener to its list of listeners. Whenever the cursor in the editor moves to a different line number, the listener's promptChange method is called.


displayHelp

void displayHelp(String strHelpResourceID)
Requests that the help for the given help resource identifier be displayed.


displayMessageHelp

void displayMessageHelp(String strMessageID)
Requests that the help for the given message identifier be displayed.


getPromptChangeListener

IISeriesEditorPromptChangeListener getPromptChangeListener()
Return the listener


getPromptEncoding

String getPromptEncoding()
The editor is to return the codepage.


getPromptFont

Font getPromptFont()
The editor is to return the font that it is using.


getPromptFormatLine

String getPromptFormatLine(String strPageId)
The editor is to return the format line for the given prompt page identifier.


getPromptMaxLineLength

int getPromptMaxLineLength()
Returns the maximum line length of all editor text lines excluding the sequence/prefix area, or -1 if unknown.


getPromptGroup

ISeriesEditorPromptGroup getPromptGroup()
The adapter is to return the field information for a group of spec types.


getPromptPageIndex

int getPromptPageIndex(int iElement)
The adapter is to return the page index for the given line number.


getRetainLowerCase

boolean getRetainLowerCase()
Multiple choice fields represented by a combo box display choices in upper case. However, a user may have typed in the value of the field in lower case. This method asks whether the field should retain its lower case characteristic.


getSyntaxChecker

IISeriesEditorSyntaxChecker getSyntaxChecker()
Returns a syntax checker or null if not applicable.


promptLineChanged

void promptLineChanged(int iLineNumber,
                       String strText)
The editor is being notified by the prompter that the line of text has been changed by the user within the prompt view. The editor is to replace the line text at the line number with the given line text.


promptElementChanged

void promptElementChanged(int iElementNumber,
                          String strText)
The editor is being notified by the prompter that the line of text has been changed by the user within the prompt view. The editor is to replace the line text at the line number with the given line text.


removePromptChangeListener

void removePromptChangeListener(IISeriesEditorPromptChangeListener listener)
The editor is to remove a prompt change listener from its list of listeners.


setInsertModeAction

void setInsertModeAction(Action actionInsertMode)
Gives the adapter the action that tells it whether a new line should be created when the prompt view's apply button is pressed, or whether an existing line should be replaced.


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.