shout3d.core
Class NodeField
java.lang.Object
|
+--shout3d.core.Field
|
+--shout3d.core.NodeField
- public class NodeField
- extends Field
A Field whose value stores a Node.
Constructor Summary |
NodeField(Node owner,
java.lang.String fieldName,
int usage,
Node value)
Constructs a new NodeField. |
Method Summary |
Node |
getValue()
Returns the current value of the field. |
boolean |
isRecursivelySearchable()
Returns whether node values in this field are recursively
searched by searchers. |
void |
setRecursivelySearchable(boolean newVal)
Sets whether node values in this field should be recursively
searched by searchers. |
void |
setValue(Node newVal)
Sets the value of the field from the input argument. |
Methods inherited from class shout3d.core.Field |
addFieldObserver,
addRoute,
deleteRoute,
fieldNotify,
getName,
getNumRoutes,
getOwner,
getRoutedField,
getTypeName,
getUsage,
getValueByString,
isOfType,
isRouted,
removeFieldObserver,
setValueByString |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
NodeField
public NodeField(Node owner,
java.lang.String fieldName,
int usage,
Node value)
- Constructs a new NodeField.
- Parameters:
owner
- this Field's ownername
- this Field's nameusage
- this Field's usagevalue
- this Field's value
setValue
public void setValue(Node newVal)
- Sets the value of the field from the input argument.
Afterward, notifies all registered FieldObservers.
- Parameters:
newVal
- the new value for the field
getValue
public Node getValue()
- Returns the current value of the field.
setRecursivelySearchable
public void setRecursivelySearchable(boolean newVal)
- Sets whether node values in this field should be recursively
searched by searchers.
For example, if this is set to true and the value of the field is a
Group node, then when this field is searched, the children field of the
Group will be searched as well.
- Parameters:
newVal
- whether the node values should be recursively searched
isRecursivelySearchable
public boolean isRecursivelySearchable()
- Returns whether node values in this field are recursively
searched by searchers.
For example, if this method returns true and the value of the field is a
Group node, then when this field is searched, the children field of the
Group will be searched as well.
- Returns:
- whether the node values are recursively searched