maspack.properties

Class PropertyTemplate

java.lang.Object

maspack.properties.PropertyTemplate

All Implemented Interfaces:

HasProperties

public class PropertyTemplate
extends java.lang.Object
implements HasProperties

Template showing how to define properties within a class

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ACTIVE
static double	DEFAULT_SCALE
static java.lang.String	DEFAULT_TEXT
static PropertyList	myProps

Constructor Summary

Constructors

Constructor and Description
PropertyTemplate()

Method Summary

Modifier and Type	Method and Description
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
Property	getProperty(java.lang.String name) Returns a property associated with a specified path name.
double	getScale()
PropertyMode	getScaleMode()
int	getStatus()
java.lang.String	getText()
boolean	isActive()
static void	main(java.lang.String[] args)
void	setActive(boolean active)
void	setScale(double scale)
void	setScaleMode(PropertyMode mode)
void	setText(java.lang.String text)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT

DEFAULT_ACTIVE

public static final boolean DEFAULT_ACTIVE

See Also:

Constant Field Values

DEFAULT_SCALE

public static final double DEFAULT_SCALE

See Also:

Constant Field Values

myProps

public static PropertyList myProps

Constructor Detail

PropertyTemplate

public PropertyTemplate()

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Returns:

static information for all exported properties

getProperty

public Property getProperty(java.lang.String name)

Description copied from interface: HasProperties

Returns a property associated with a specified path name. All properties exported by this object must have a name which is a valid Java identifier. Specifying one of these names causes the corresponding Property to be returned. Handles to subproperties can also be obtained by delimiting the sub-property name(s) by '.' characters. A sub-property exists if the value of a property is itself an object which exports properties. It is only possible to obtain a sub-property handle if each of its ancestor properties exports their values by reference.

Specified by:

getProperty in interface HasProperties

Parameters:

name - name of the desired property or sub-property

Returns:

handle to the property

getStatus

public int getStatus()

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getScale

public double getScale()

setScale

public void setScale(double scale)

getScaleMode

public PropertyMode getScaleMode()

setScaleMode

public void setScaleMode(PropertyMode mode)

main

public static void main(java.lang.String[] args)