Constructor Detail

• ColorParameter

  public ColorParameter​(java.lang.String name)

  Constructor.

  Parameters:

  name - parameter name

Method Detail

• colorValue

  public java.awt.Color colorValue​(uk.ac.starlink.task.Environment env)
                            throws uk.ac.starlink.task.TaskException

  Returns the value of this parameter as a Color object.

  Parameters:

  env - execution environment

  Throws:

  uk.ac.starlink.task.TaskException

• setDefaultColor

  public void setDefaultColor​(java.awt.Color color)

  Sets the default value of this parameter to a given color object.

  Parameters:

  color - colour

• toString

  public java.lang.String toString​(java.awt.Color option)

  Description copied from class: NamedObjectParameter
  Translates a possible option value of this parameter into a string which represents it as a string value.

  Overrides:

  toString in class NamedObjectParameter<java.awt.Color>

  Parameters:

  option - object value

  Returns:

  corresponding string

• fromString

  public java.awt.Color fromString​(java.lang.String name)

  Description copied from class: NamedObjectParameter
  Translates a string value for this parameter into the object value which it represents. Must return a suitable object value for this parameter, or throw an unchecked exception.

  The implementation must be such that fromString(toString(o)).equals(o).

  Specified by:

  fromString in class NamedObjectParameter<java.awt.Color>

  Parameters:

  name - option name

  Returns:

  corresponding option value

• getFormatDescription

  public java.lang.String getFormatDescription​()

  Returns an XML string, suitable for inclusion in a parameter description, which explains the format of values accepted by this parameter. The returned string is not enclosed in a <p> element.

  Returns:

  format description XML string