com.borland.primetime.properties
Class NodeArrayProperty

java.lang.Object
  |
  +--com.borland.primetime.properties.Property
        |
        +--com.borland.primetime.properties.NodeArrayProperty

public class NodeArrayProperty

extends Property

Instances of NodeArrayProperty are used to represent global settings with a related set of zero or more values under the user's control.

Fields inherited from class com.borland.primetime.properties.Property

category, name

Constructor Summary

NodeArrayProperty(java.lang.String category, java.lang.String name)
Creates a node property whose values will be stored as a sequence of individual properties with the names 'name.0', 'name.1', etc.

Method Summary

void	addPropertyListener(NodeArrayPropertyListener listener) Adds a NodeArrayPropertyListener to the list of listeners that receive events.
void	firePropertyChange(Node node, java.lang.String[] newValue) Notifies all registered NodeArrayPropertyListeners that the value of the property has been changed.
java.lang.String[]	getValues(Node node) Fetches the current setting of this property.
void	removePropertyListener(NodeArrayPropertyListener listener) Removes a NodeArrayPropertyListener from the list of listeners that receive events.
boolean	setValues(Node node, java.lang.String[] values) Changes the current setting of the property to the array of strings provided.

Methods inherited from class com.borland.primetime.properties.Property

compareTo, equals, getPropertyCategory, getPropertyName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NodeArrayProperty

public NodeArrayProperty(java.lang.String category,
                         java.lang.String name)

Creates a node property whose values will be stored as a sequence of individual properties with the names 'name.0', 'name.1', etc.

Parameters:

category - The category this property will be stored under.

name - The root name used to generate each of the individual property names for entries in the array.

Method Detail

setValues

public boolean setValues(Node node,
                         java.lang.String[] values)

Changes the current setting of the property to the array of strings provided.

Parameters:

values - The desired array of parameter values. Null is treated the same as an empty array.

Returns:

True if one or more changes were made, false otherwise.

getValues

public java.lang.String[] getValues(Node node)

Fetches the current setting of this property.

Returns:

The stored array of parameter values, or an empty array if no values have been stored.

addPropertyListener

public void addPropertyListener(NodeArrayPropertyListener listener)

Adds a NodeArrayPropertyListener to the list of listeners that receive events.

Parameters:

listener - The listener.

removePropertyListener

public void removePropertyListener(NodeArrayPropertyListener listener)

Removes a NodeArrayPropertyListener from the list of listeners that receive events.

Parameters:

listener - The listener.

firePropertyChange

public void firePropertyChange(Node node,
                               java.lang.String[] newValue)

Notifies all registered NodeArrayPropertyListeners that the value of the property has been changed.