quoggles.parameters
Class OptionParameter

java.lang.Object
  |
  +--org.graffiti.plugin.parameter.AbstractSingleParameter
        |
        +--quoggles.parameters.OptionParameter
All Implemented Interfaces:
org.graffiti.plugin.Displayable, org.graffiti.plugin.parameter.Parameter, org.graffiti.plugin.parameter.SingleParameter

public class OptionParameter
extends org.graffiti.plugin.parameter.AbstractSingleParameter


Field Summary
protected  boolean isEditable
           
protected  int optionNr
           
protected  java.lang.Object[] options
           
 
Fields inherited from class org.graffiti.plugin.parameter.AbstractSingleParameter
 
Constructor Summary
OptionParameter(java.lang.Object[] opts, boolean editable, java.lang.String name, java.lang.String description)
          Constructor for OptionParameter.
OptionParameter(java.lang.Object[] opts, int optionNr, boolean editable, java.lang.String name, java.lang.String description)
          Constructor for OptionParameter.
OptionParameter(java.lang.Object[] opts, int optionNr, java.lang.String name, java.lang.String description)
          Constructor for OptionParameter.
OptionParameter(java.lang.Object[] opts, java.lang.String name, java.lang.String description)
          Constructor for OptionParameter.
 
Method Summary
 int getOptionNr()
           
 java.lang.Object[] getOptions()
          Returns the options array.
 boolean isEditable()
          Returns true if new values can be added to this parameter later on.
 void setOptions(java.lang.Object[] opts)
           
 void setValue(java.lang.Object val)
           
 java.lang.String toXMLString()
           
 
Methods inherited from class org.graffiti.plugin.parameter.AbstractSingleParameter
getDescription, getImage, getName, getStandardXML, getValue, setDescription, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

options

protected java.lang.Object[] options

optionNr

protected int optionNr

isEditable

protected boolean isEditable
Constructor Detail

OptionParameter

public OptionParameter(java.lang.Object[] opts,
                       java.lang.String name,
                       java.lang.String description)
Constructor for OptionParameter. Selects first option.

Parameters:
opts -
name -
description -

OptionParameter

public OptionParameter(java.lang.Object[] opts,
                       int optionNr,
                       java.lang.String name,
                       java.lang.String description)
Constructor for OptionParameter. Selects option with index optionNr.

Parameters:
opts -
optionNr -
name -
description -

OptionParameter

public OptionParameter(java.lang.Object[] opts,
                       boolean editable,
                       java.lang.String name,
                       java.lang.String description)
Constructor for OptionParameter. Selects first option. Can choose whether or not values can be added later on.

Parameters:
opts -
editable -
name -
description -

OptionParameter

public OptionParameter(java.lang.Object[] opts,
                       int optionNr,
                       boolean editable,
                       java.lang.String name,
                       java.lang.String description)
Constructor for OptionParameter. Selects option with index optionNr. Can choose whether or not values can be added later on.

Parameters:
opts -
optionNr -
editable -
name -
description -
Method Detail

isEditable

public boolean isEditable()
Returns true if new values can be added to this parameter later on.

Returns:

setValue

public void setValue(java.lang.Object val)
              throws java.lang.IllegalArgumentException
Specified by:
setValue in interface org.graffiti.plugin.Displayable
Overrides:
setValue in class org.graffiti.plugin.parameter.AbstractSingleParameter
java.lang.IllegalArgumentException
See Also:
quoggles.parameters.AbstractParameter#setValue(java.lang.Object)

getOptionNr

public int getOptionNr()

setOptions

public void setOptions(java.lang.Object[] opts)

getOptions

public java.lang.Object[] getOptions()
Returns the options array.

Returns:
the options array.

toXMLString

public java.lang.String toXMLString()
Specified by:
toXMLString in interface org.graffiti.plugin.Displayable
Overrides:
toXMLString in class org.graffiti.plugin.parameter.AbstractSingleParameter
See Also:
Displayable.toXMLString()