Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.util.clprompter
Class ClSelectivePromptCharacter

java.lang.Object
  extended by com.ibm.etools.iseries.rse.util.clprompter.ClSelectivePromptCharacter

public class ClSelectivePromptCharacter
extends Object

This class contains the functional information for selective prompts.

Since:
6.0

Field Summary
static String Copyright
           
 
Method Summary
 String getSelectivePromptCharacter()
          used to retrieve the selective prompt character string
 boolean isDefaultPassedToCPP()
          indicates whether or not the default value or the specified value should be returned to the CPP
 boolean isF5BlankDefault()
          used to retrieve the behavour when F5 is pressed or when a user blanks out the field.
 boolean isProtected()
          used to determine whether or not the parameter is readonly (protected from input)
 boolean isShowAngleBracket()
          use to figure out whether or not to show the angle bracket > before the parameter
 boolean isValueSpecified()
          indicates whether a value was specified for the parameter with the selective prompt
 boolean isVisible()
          indicates whether or not the field is allowed to be displayed.
 boolean isVisibleOnlyWhenF9()
          indicates whether or not the parameter should only be displayed when F9 is pressed.
 
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
Method Detail

isF5BlankDefault

public boolean isF5BlankDefault()
used to retrieve the behavour when F5 is pressed or when a user blanks out the field.

Returns:
true if the default is to be displayed, false if the value passed in should be displayed

isShowAngleBracket

public boolean isShowAngleBracket()
use to figure out whether or not to show the angle bracket > before the parameter

Returns:
truw if > is to be diaplyed, false otherwise.

getSelectivePromptCharacter

public String getSelectivePromptCharacter()
used to retrieve the selective prompt character string

Returns:
the string to display in front of the prompt

isProtected

public boolean isProtected()
used to determine whether or not the parameter is readonly (protected from input)

Returns:
true if the parameter is protected, false otherwise

isVisible

public boolean isVisible()
indicates whether or not the field is allowed to be displayed. ?- is never displayed. All others are always displayed.

Returns:
true if the selective prompt indicates that the parameter is to be displayed false otherwise.

isDefaultPassedToCPP

public boolean isDefaultPassedToCPP()
indicates whether or not the default value or the specified value should be returned to the CPP

Returns:
true if the default should be passed, false otherwise.

isVisibleOnlyWhenF9

public boolean isVisibleOnlyWhenF9()
indicates whether or not the parameter should only be displayed when F9 is pressed.

Returns:
true if only displayed when F9 is pressed, false otherwise.

isValueSpecified

public boolean isValueSpecified()
indicates whether a value was specified for the parameter with the selective prompt

Returns:
true if a value was specified, false otherwise

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.