IlvGroupElement (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.prototypes.IlvGroupElement

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IlvGraphicElement, IlvGroup, IlvValueSource
```
public abstract class IlvGroupElement
extends Object
implements IlvPersistentObject, Serializable
```
The class IlvGroupElement is the abstract base class for all the objects contained in instances of IlvGroup. Its predefined subclasses are IlvGraphicElement, which is used to include IlvGraphic objects in groups, and IlvGroup, which is used to include subgroups (and thus build hierarchical structures).
An IlvGroupElement has a set of static or dynamic properties. These named properties can be read and set to a new value using the get and set methods.
An IlvGroupElement can also have output properties. An output property is similar to an event in that it is generated by the IlvGroupElement (through a call to the pushValues method), and can be connected to an input property handled by another object (using the subscribe method).
You do not need to know the exact type of the properties you set or read on an IlvGroupElement since all values are automatically converted to the correct type as needed.
For example, to set the horizontal position of an object, you could set the "x" property to the string "100" as follows:
```
     obj.set("x", "100");
 
```
The string "100" will be automatically converted to a double when required.
You could also call one of the various overloaded set methods that accept value parameters with different primitive types:
```
     obj.set("x", 100);
     obj.set("y", 99.9);
 
```
Conversely, values returned by the get methods must often be converted to the appropriate type for them to be used by the application. The shortest way do this is to call the get<Type> method that retrieves the property and convert its result to a specific type:
```
     int x = obj.getInt("x");
     double y = obj.getDouble("y");
 
```
You can also call the generic get method and convert the result to the desired type with the static methods of the class IlvValueConverter:
```
     Object xval = obj.get("x");
     double x = IlvValueConverter.convertToDouble(xval);
 
```
See Also:

IlvGroup, IlvGraphicElement, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IlvGroupElement()
Creates a group element.

Constructors
Constructor and Description
`IlvGroupElement()` Creates a group element.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyTransform(IlvTransformer t)` Applies a transformer to all the graphic subelements of the group element.
`void`	`applyTransform(IlvTransformer t, boolean redraw)` Applies a transformer to all the graphic subelements of the group element.
`IlvRect`	`boundingBox(IlvTransformer t)` Returns the bounding box of this group element, which is the union of the bounding boxes of all the graphic elements that it contains.
`IlvRect`	`boundingBox(IlvTransformer t, boolean includeInvisible)` Returns the bounding box of this group element, which is the union of the bounding boxes of all the graphic elements that it contains.
`abstract IlvGroupElement`	`copy()` Makes a copy of this group element.
`Object`	`get(String name)` Retrieves one of the properties handled by this object.
`Object[]`	`get(String[] names)` Retrieves a set of properties handled by the object.
`void`	`get(String[] names, Object[] values)` Retrieves a set of properties handled by this object.
`boolean`	`getBoolean(String name)` Retrieves a boolean property.
`double`	`getDouble(String name)` Retrieves a double property.
`float`	`getFloat(String name)` Retrieves a float property.
`int`	`getInt(String name)` Retrieves an integer property.
`long`	`getLong(String name)` Retrieves a long property.
`String`	`getName()` Returns the name of this group element.
`IlvGroup`	`getParent()` Returns the parent of this group element or `null` if the element does not belong to a group.
`String`	`getRelativePath(IlvGroup group)` Returns the access path to this group element relative to the specified group.
`String`	`getString(String name)` Retrieves a string.
`IlvGroupElement[]`	`getSubscribers()` Returns all the objects that are connected to this group element, that is, all the subscribers passed to the `subscribe` method applied to this object.
`String[]`	`getSubscriptionValues(IlvGroupElement subscriber)` Returns the names of the source and destination properties of the connections established between this group element and `subscriber`.
`String[]`	`getValueNames(boolean publicOnly)` Returns the names of the properties handled by this group element.
`boolean`	`isOutput(String name)` Returns `true` if the specified property is an output property.
`void`	`move(double x, double y)` Moves the group element.
`void`	`pushValue(String name, Object value)` Propagates a single value through the connections established between this group element and its subscribers.
`void`	`pushValues(String[] names, Object[] values)` Propagates a set of values through the connections established between this group element and its subscribers.
`void`	`set(String[] names, Object[] values)` Sets a set of properties handled by this object to a new value.
`void`	`set(String name, boolean value)` Sets a boolean property to a new value.
`void`	`set(String name, double value)` Sets a double property to a new value.
`void`	`set(String name, float value)` Sets a double property to a new value.
`void`	`set(String name, int value)` Sets an integer property to a new value.
`void`	`set(String name, long value)` Sets a long property to a new value.
`void`	`set(String name, Object value)` Sets one of the properties handled by this object to a new value.
`void`	`setName(String name)` Changes the name of this group element to the name specified.
`void`	`subscribe(IlvGroupElement subscriber, String sourceValue, String subscriberValue)` Connects this group element to the `subscriber` object.
`boolean`	`traverse(IlvGroupTraverser traverser)` Called when the group to which this group element belongs is traversed using the `IlvGroup.traverse` method.
`void`	`unsubscribe(IlvGroupElement subscriber, String sourceValue, String subscriberValue)` Breaks the connection between the group element and the `subscriber` object.
`abstract void`	`write(IlvOutputStream out)` Writes this group element to a Rogue Wave JViews output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvGroupElement
```
public IlvGroupElement()
```
    Creates a group element.
- Method Detail
  - copy
```
public abstract IlvGroupElement copy()
                              throws IlvValueException
```
    Makes a copy of this group element. This method is called by the copy method of the class IlvGroup to copy all the elements belonging to the group.
    
    Returns:
    
    a copy of the group element.
    
    Throws:
    
    IlvValueException - if an error occurred while setting or reading a value.
    
    See Also:
    
    IlvGroup.copy(ilog.views.prototypes.IlvGroup)
  - write
```
public abstract void write(IlvOutputStream out)
                    throws IOException
```
    Writes this group element to a Rogue Wave JViews output stream. This method is called by the write method of the class IlvGroup to write all the elements belonging the group.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Parameters:
    
    out - the output stream.
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
    
    See Also:
    
    IlvGroup.write(ilog.views.io.IlvOutputStream)
  - getParent
```
public IlvGroup getParent()
```
    Returns the parent of this group element or null if the element does not belong to a group.
  - getName
```
public String getName()
```
    Returns the name of this group element.
  - setName
```
public void setName(String name)
```
    Changes the name of this group element to the name specified.
    
    Parameters:
    
    name - the new name of the group element.
  - getRelativePath
```
public String getRelativePath(IlvGroup group)
                       throws IlvGroupException
```
    Returns the access path to this group element relative to the specified group. The path is composed of the name of the various ancestors of the group element up to group. These names are separated by dot ('.') characters. Calling group.findNode(path) with the resulting path returns this group element (provided that all elements have unique names at a given level).
    
    Returns:
    
    the access path to this group element.
    
    Throws:
    
    IlvGroupException - if the group element does not belong to the specified group.
  - traverse
```
public boolean traverse(IlvGroupTraverser traverser)
```
    Called when the group to which this group element belongs is traversed using the IlvGroup.traverse method.
    It must return true to allow the operation to continue. If it returns false, the operation is stopped and the top level traverse method returns false
    
    Parameters:
    
    traverser - the IlvGroupTraverser object whose preOrder and postOrder methods will be called for each element in the group.
    
    Returns:
    
    true in the base class implementation.
    
    See Also:
    
    IlvGroup.traverse(ilog.views.prototypes.IlvGroupTraverser)
  - boundingBox
```
public IlvRect boundingBox(IlvTransformer t)
```
    Returns the bounding box of this group element, which is the union of the bounding boxes of all the graphic elements that it contains.
    
    Parameters:
    
    t - the transformer used to compute the bounding boxes of the graphic elements.
    
    Returns:
    
    the union of all the bounding boxes of the graphic elements or null if the group element has no graphic element.
  - boundingBox
```
public IlvRect boundingBox(IlvTransformer t,
                           boolean includeInvisible)
```
    Returns the bounding box of this group element, which is the union of the bounding boxes of all the graphic elements that it contains.
    This method is similar to boundingBox except for the additional includeInvisible argument.
    
    Parameters:
    
    t - the transformer used to compute the bounding boxes of the graphic elements.
    
    includeInvisible - if this parameter is true, the bounding box includes all the elements of the group. If it is false, the bounding box includes only the visible elements.
    
    Returns:
    
    the union of all the bounding boxes of the graphic elements, or null if the group element has no graphic element.
  - applyTransform
```
public void applyTransform(IlvTransformer t)
```
    Applies a transformer to all the graphic subelements of the group element.
    
    Parameters:
    
    t - the transformer to be applied.
  - applyTransform
```
public void applyTransform(IlvTransformer t,
                           boolean redraw)
```
    Applies a transformer to all the graphic subelements of the group element.
    
    Parameters:
    
    t - the transformer to be applied.
    
    redraw - If true, the element is redrawn, otherwise no redraw occurs.
    
    Since:
    
    JViews 6.0
  - move
```
public void move(double x,
                 double y)
```
    Moves the group element. This method calls the applyTransform method.
  - getValueNames
```
public String[] getValueNames(boolean publicOnly)
                       throws IlvValueException
```
    Returns the names of the properties handled by this group element.
    
    Parameters:
    
    publicOnly - if true, only the public properties of the group element are returned.
    
    Returns:
    
    the names of the properties handled by this group element.
    
    Throws:
    
    IlvValueException - if an error occurred while reading a value.
  - isOutput
```
public boolean isOutput(String name)
```
    Returns true if the specified property is an output property.
  - set
```
public final void set(String[] names,
                      Object[] values)
               throws IlvValueException
```
    Sets a set of properties handled by this object to a new value.
    
    Parameters:
    
    names - the names of the properties to be set.
    
    values - the new values. Primitive values must be wrapped in reference objects. For example, to set an integer value, you must create an object of the class Integer and store a reference to this object in the values argument.
    
    Throws:
    
    IlvValueException - if one or more properties are not handled by this object, the exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
  - get
```
public final void get(String[] names,
                      Object[] values)
               throws IlvValueException
```
    Retrieves a set of properties handled by this object.
    
    Parameters:
    
    names - the names of the properties to be retrieved.
    
    values - the array where the values read will be stored. Primitive values are wrapped in reference objects. Integer values, for example, are returned in an object of the class Integer. Once you get this object, you have to retrieve the primitive integer value from it.
    
    Throws:
    
    IlvValueException - if one or more properties are not handled by this object, the exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while reading the properties.
  - get
```
public final Object[] get(String[] names)
                   throws IlvValueException
```
    Retrieves a set of properties handled by the object. This method is equivalent to get(String[] names, Object[] values), except that it allocates the array of returned values itself.
    
    Parameters:
    
    names - the names of the properties to be retrieved.
    
    Returns:
    
    an array containing the values read.
    
    Throws:
    
    IlvValueException - if one or more properties are not handled by this object, the exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while retrieving the properties.
    
    See Also:
    
    get(java.lang.String[], java.lang.Object[])
  - set
```
public final void set(String name,
                      Object value)
               throws IlvValueException
```
    Sets one of the properties handled by this object to a new value.
    
    Parameters:
    
    name - the name of the property to be set.
    
    value - the new value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, the exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    set(java.lang.String[], java.lang.Object[])
  - get
```
public final Object get(String name)
                 throws IlvValueException
```
    Retrieves one of the properties handled by this object.
    
    Parameters:
    
    name - the name of the property to be retrieved.
    
    Returns:
    
    the value read.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, the exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while retrieving the value.
    
    See Also:
    
    get(java.lang.String[], java.lang.Object[])
  - set
```
public final void set(String name,
                      boolean value)
               throws IlvValueException
```
    Sets a boolean property to a new value.
    This method wraps the boolean value in a Boolean object and calls the method set(String, Object).
    
    Parameters:
    
    name - the name of the property to be set.
    
    value - the new value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, the exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    set(java.lang.String, java.lang.Object)
  - set
```
public final void set(String name,
                      int value)
               throws IlvValueException
```
    Sets an integer property to a new value.
    This method wraps the integer value in an Integer object and calls the method set(String, Object).
    
    Parameters:
    
    name - the name of the property to be set.
    
    value - the new value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, the exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    set(java.lang.String, java.lang.Object)
  - set
```
public final void set(String name,
                      long value)
               throws IlvValueException
```
    Sets a long property to a new value.
    This method wraps the long value in a Long object and calls the method set(String, Object).
    
    Parameters:
    
    name - the name of the property to be set.
    
    value - the new value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    set(java.lang.String, java.lang.Object)
  - set
```
public final void set(String name,
                      float value)
               throws IlvValueException
```
    Sets a double property to a new value.
    This method wraps the float value in a Float object and calls the method set(String, Object).
    
    Parameters:
    
    name - the name of the property to be set.
    
    value - the new value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    set(java.lang.String, java.lang.Object)
  - set
```
public final void set(String name,
                      double value)
               throws IlvValueException
```
    Sets a double property to a new value.
    This method wraps the double value in a Double object and calls the method set(String, Object).
    
    Parameters:
    
    name - the name of the property to be set.
    
    value - the new value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    set(java.lang.String, java.lang.Object)
  - getBoolean
```
public final boolean getBoolean(String name)
                         throws IlvValueException
```
    Retrieves a boolean property.
    This method calls the method get(String) and converts the result to a boolean value.
    
    Parameters:
    
    name - the name of the property to be retrieved.
    
    Returns:
    
    the converted value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    get(java.lang.String)
  - getInt
```
public final int getInt(String name)
                 throws IlvValueException
```
    Retrieves an integer property.
    This method calls the method get(String) and converts the result to an integer.
    
    Parameters:
    
    name - the name of the property to be retrieved.
    
    Returns:
    
    the converted value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that another error occurred while changing the properties.
    
    See Also:
    
    get(java.lang.String)
  - getLong
```
public final long getLong(String name)
                   throws IlvValueException
```
    Retrieves a long property.
    This method calls the method get(String) and converts the result to a long.
    
    Parameters:
    
    name - the name of the property to be retrieved.
    
    Returns:
    
    the converted value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    get(java.lang.String)
  - getFloat
```
public final float getFloat(String name)
                     throws IlvValueException
```
    Retrieves a float property.
    This method calls the method get(String) and converts the result to a float.
    
    Parameters:
    
    name - the name of the property to be retrieved.
    
    Returns:
    
    the converted value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    get(java.lang.String)
  - getDouble
```
public final double getDouble(String name)
                       throws IlvValueException
```
    Retrieves a double property.
    This method calls the method get(String) and converts the result to a double.
    
    Parameters:
    
    name - the name of the property to be retrieved.
    
    Returns:
    
    the converted value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    get(java.lang.String)
  - getString
```
public final String getString(String name)
                       throws IlvValueException
```
    Retrieves a string.
    This method calls the method get(String) and converts the result to a string.
    
    Parameters:
    
    name - the name of the property to be retrieved.
    
    Returns:
    
    the converted value.
    
    Throws:
    
    IlvValueException - if the value is not handled by this object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
    
    See Also:
    
    get(java.lang.String)
  - subscribe
```
public void subscribe(IlvGroupElement subscriber,
                      String sourceValue,
                      String subscriberValue)
```
    Connects this group element to the subscriber object. When two IlvGroupElement objects are connected, calling the pushValues method for the source object will cause the set method for the destination object to be invoked. When the source property is generated, the subscriber property is set for the subscriber.
    
    Parameters:
    
    subscriber - the destination object of the connection.
    
    sourceValue - the name of the source property of the new connection.
    
    subscriberValue - the name of the destination property of the new connection.
  - unsubscribe
```
public void unsubscribe(IlvGroupElement subscriber,
                        String sourceValue,
                        String subscriberValue)
```
    Breaks the connection between the group element and the subscriber object.
    
    Parameters:
    
    subscriber - the destination object of the connection.
    
    sourceValue - the name of the source property of the new connection. If this parameter is null, all the connections between the group element and the subscriber object are broken regardless of their source property.
    
    subscriberValue - the name of the source property of the new connection. If this parameter is null, all the connections between the group element and the subscriber object are broken regardless of their destination property.
  - pushValues
```
public final void pushValues(String[] names,
                             Object[] values)
                      throws IlvValueException
```
    Propagates a set of values through the connections established between this group element and its subscribers.
    Example:
    If the source and subscriber objects are connected as follows:
```
 source.subscribe(susbcriber, "sourceProp1", "destProp2");
 source.subscribe(subscriber, "sourceProp2", "destProp2");
 
```
    Then this call to pushValues:
```
 String[] sourceNames = { "sourceProp1", "sourceProp2" };
 Object[] values = { v1, v2 };
 source.pushValues(sourceNames, values);
 
```
    will set the following values of subscriber:
```
 String[] destNames = { "destProp1", "destProp2" };
 Object[] values = { v1, v2 };
 subscriber.set(destNames, values);
 
```
    Throws:
    
    IlvValueException - if one or more propagated values are not handled by the destination object, this exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
  - pushValue
```
public final void pushValue(String name,
                            Object value)
                     throws IlvValueException
```
    Propagates a single value through the connections established between this group element and its subscribers. This method is similar to pushValues except that it propagates only one value.
    
    Throws:
    
    IlvValueException - if the propagated value is not handled by the destination object, the exception is an instance of the class IlvValuesNotHandledException. Otherwise, the exception means that an error occurred while changing the properties.
  - getSubscribers
```
public final IlvGroupElement[] getSubscribers()
```
    Returns all the objects that are connected to this group element, that is, all the subscribers passed to the subscribe method applied to this object. A given subscriber is stored only once in the returned array.
    For each subscriber returned, the details of the connection (that is, the names of the source and destination properties) can be obtained using the getSubscriptionValues method.
    
    See Also:
    
    subscribe(IlvGroupElement, String, String), getSubscriptionValues(ilog.views.prototypes.IlvGroupElement)
  - getSubscriptionValues
```
public final String[] getSubscriptionValues(IlvGroupElement subscriber)
```
    Returns the names of the source and destination properties of the connections established between this group element and subscriber. Both the source and destination property names are returned: the first element of the array is the source property of the first connection, the second element is the destination property of the first connection, the third element is the source property of the second connection, the fourth element is the destination property of the second connection, and so on.
    
    Parameters:
    
    subscriber - the subscriber of the connection.
    
    See Also:
    
    subscribe(IlvGroupElement, String, String), getSubscribers()

Class IlvGroupElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvGroupElement

Method Detail

copy

write

getParent

getName

setName

getRelativePath

traverse

boundingBox

boundingBox

applyTransform

applyTransform

move

getValueNames

isOutput

set

get

get

set

get

set

set

set

set

set

getBoolean

getInt

getLong

getFloat

getDouble

getString

subscribe

unsubscribe

pushValues

pushValue

getSubscribers

getSubscriptionValues