artisynth.core.modelbase

Class FieldPropertyList

java.lang.Object

maspack.properties.PropertyList

artisynth.core.modelbase.FieldPropertyList

All Implemented Interfaces:

java.lang.Iterable<PropertyInfo>, PropertyInfoList

public class FieldPropertyList
extends PropertyList

Extension to PropertyList in which properties can optionally be associated with Fields. This information can then be easily saved or loaded from external files, using writePropertyFields(java.io.PrintWriter, maspack.properties.HasProperties, maspack.util.NumberFormat, artisynth.core.modelbase.CompositeComponent), scanPropertyField(maspack.util.ReaderTokenizer, maspack.properties.HasProperties, java.util.Deque<artisynth.core.util.ScanToken>), and postscanPropertyField(java.util.Deque<artisynth.core.util.ScanToken>, maspack.properties.HasProperties, artisynth.core.modelbase.CompositeComponent).

Constructor Summary

Constructors

Constructor and Description
FieldPropertyList(java.lang.Class<?> hostClass)
FieldPropertyList(java.lang.Class<?> hostClass, java.lang.Class<?> ancestorClass)

Method Summary

Modifier and Type	Method and Description
FieldPropertyDesc	addInheritableWithField(java.lang.String nameAndMethods, java.lang.String description, java.lang.Object defaultValue)
FieldPropertyDesc	addInheritableWithField(java.lang.String nameAndMethods, java.lang.String description, java.lang.Object defaultValue, java.lang.String options)
FieldPropertyDesc	addWithField(java.lang.String nameAndMethods, java.lang.String description, java.lang.Object defaultValue)
FieldPropertyDesc	addWithField(java.lang.String nameAndMethods, java.lang.String description, java.lang.Object defaultValue, java.lang.String options)
void	getPropertyFields(HasProperties host, java.util.List<FieldComponent> fields) Adds to fields each field that is bound to one of the field properties in this list for the specified host.
boolean	postscanPropertyField(java.util.Deque<ScanToken> tokens, HasProperties host, CompositeComponent ancestor)
boolean	scanPropertyField(ReaderTokenizer rtok, HasProperties host, java.util.Deque<ScanToken> tokens)
void	writePropertyFields(java.io.PrintWriter pw, HasProperties host, NumberFormat fmt, CompositeComponent ancestor)

Methods inherited from class maspack.properties.PropertyList

add, add, add, addInheritable, addInheritable, addReadOnly, addReadOnly, findPropertyInfoList, get, get, getProperty, hasNoInheritableProperties, iterator, remove, remove, scanNamedProp, scanProp, setDefaultModes, setDefaultValue, setDefaultValues, setDefaultValuesAndModes, setOptions, size, toArray, writeNonDefaultProps, writeNonDefaultProps, writeProps

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FieldPropertyList

public FieldPropertyList(java.lang.Class<?> hostClass)

FieldPropertyList

public FieldPropertyList(java.lang.Class<?> hostClass,
                         java.lang.Class<?> ancestorClass)

Method Detail

addInheritableWithField

public FieldPropertyDesc addInheritableWithField(java.lang.String nameAndMethods,
                                                 java.lang.String description,
                                                 java.lang.Object defaultValue,
                                                 java.lang.String options)

addInheritableWithField

public FieldPropertyDesc addInheritableWithField(java.lang.String nameAndMethods,
                                                 java.lang.String description,
                                                 java.lang.Object defaultValue)

addWithField

public FieldPropertyDesc addWithField(java.lang.String nameAndMethods,
                                      java.lang.String description,
                                      java.lang.Object defaultValue,
                                      java.lang.String options)

addWithField

public FieldPropertyDesc addWithField(java.lang.String nameAndMethods,
                                      java.lang.String description,
                                      java.lang.Object defaultValue)

writePropertyFields

public void writePropertyFields(java.io.PrintWriter pw,
                                HasProperties host,
                                NumberFormat fmt,
                                CompositeComponent ancestor)
                         throws java.io.IOException

Throws:

java.io.IOException

getPropertyFields

public void getPropertyFields(HasProperties host,
                              java.util.List<FieldComponent> fields)

Adds to fields each field that is bound to one of the field properties in this list for the specified host.

Parameters:

host - host object for the properties

fields - list to which bound fields are added

scanPropertyField

public boolean scanPropertyField(ReaderTokenizer rtok,
                                 HasProperties host,
                                 java.util.Deque<ScanToken> tokens)
                          throws java.io.IOException

Throws:

java.io.IOException

postscanPropertyField

public boolean postscanPropertyField(java.util.Deque<ScanToken> tokens,
                                     HasProperties host,
                                     CompositeComponent ancestor)
                              throws java.io.IOException

Throws:

java.io.IOException