us.temerity.pipeline
Interface ActionParam

All Superinterfaces:

Glueable

All Known Implementing Classes:

BooleanActionParam, ByteSizeActionParam, Color3dActionParam, DoubleActionParam, EnumActionParam, IntegerActionParam, LinkActionParam, StringActionParam, TextAreaActionParam, Tuple2dActionParam, Tuple2iActionParam, Tuple3dActionParam, Tuple3iActionParam, Tuple4dActionParam

public interface ActionParam
extends Glueable

A parameter of Action plugins.

Method Summary

Object	clone() Return a deep copy of this object.
String	getDescription() Gets the short description of the parameter used in tooltips.
String	getName() Gets the name of the Action parameter.
String	getNameUI() Gets a modified form of the name of this instance with spaces inserted between each word.
Comparable	getValue() Gets the value of the parameter.
void	setValue(Comparable value) Sets the value of the parameter.

Methods inherited from interface us.temerity.pipeline.glue.Glueable

fromGlue, toGlue

Method Detail

getName

String getName()

Gets the name of the Action parameter.

getNameUI

String getNameUI()

Gets a modified form of the name of this instance with spaces inserted between each word.

This name is used in the UI to label fields and table columns in a more human friendly manner.

getDescription

String getDescription()

Gets the short description of the parameter used in tooltips.

getValue

Comparable getValue()

Gets the value of the parameter.

setValue

void setValue(Comparable value)

Sets the value of the parameter.

clone

Object clone()

Return a deep copy of this object.