ilog.views.maps

Class IlvMapLayerTreeProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.maps.IlvMapLayerTreeProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvMapLayerTreeProperty
extends IlvNamedProperty

IlvMapLayerTreeProperty is a subclass of IlvNamedProperty used to store an IlvMapLayerTreeModel.
The following code example show how to retrieve the layer tree model from a manager:

 IlvManager manager = ...;
 
 IlvMapLayerTreeModel model = 
    IlvMapLayerTreeModel.GetMapLayerTreeModel(manager);
 

Note: if no model has been previously attached, a new one is created and attached by calling GetMapLayerTreeModel.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of the property.

Constructor Summary

Constructors

Constructor and Description
IlvMapLayerTreeProperty(IlvInputStream stream) Reads an IlvMapLayerTreeProperty instance from an IlvInputStream.
IlvMapLayerTreeProperty(IlvMapLayerTreeModel model) Creates a new IlvMapLayerProperty from an IlvMapLayerTreeModel.
IlvMapLayerTreeProperty(IlvMapLayerTreeProperty source) Creates a IlvMapLayerTreeProperty by copying an existing one.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Returns a copy of this property.
IlvMapLayerTreeModel	getMapLayerTreeModel() Retrieves the value of this property.
static IlvMapLayerTreeModel	GetMapLayerTreeModel(IlvManager manager) Retrieves the value of an IlvMapLayerTreeProperty instance attached to an IlvManager object.
boolean	isPersistent() Tests if this property is persistent.
void	write(IlvOutputStream stream) Write this property to an IlvMapOutputStream.

Methods inherited from class ilog.views.IlvNamedProperty

getName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The name of the property.

See Also:

Constant Field Values

Constructor Detail

IlvMapLayerTreeProperty

public IlvMapLayerTreeProperty(IlvMapLayerTreeModel model)

Creates a new IlvMapLayerProperty from an IlvMapLayerTreeModel.

Parameters:

model - The value of this property.

IlvMapLayerTreeProperty

public IlvMapLayerTreeProperty(IlvMapLayerTreeProperty source)

Creates a IlvMapLayerTreeProperty by copying an existing one.

Parameters:

source - The property to copy.

IlvMapLayerTreeProperty

public IlvMapLayerTreeProperty(IlvInputStream stream)
                        throws IlvReadFileException

Reads an IlvMapLayerTreeProperty instance from an IlvInputStream.

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException - if there is a problem reading stream.

Method Detail

copy

public IlvNamedProperty copy()

Returns a copy of this property.

Specified by:

copy in class IlvNamedProperty

Returns:

A copy of this property.

isPersistent

public boolean isPersistent()

Tests if this property is persistent.

Specified by:

isPersistent in class IlvNamedProperty

Returns:

This method always returns true as a tree property is always persistent.

write

public void write(IlvOutputStream stream)
           throws IOException

Write this property to an IlvMapOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - The stream to write to.

Throws:

IOException - If there is a problem writing to stream.

getMapLayerTreeModel

public IlvMapLayerTreeModel getMapLayerTreeModel()

Retrieves the value of this property.

Returns:

The IlvMapLayerTreeModel instance that is the value of this property.

GetMapLayerTreeModel

public static IlvMapLayerTreeModel GetMapLayerTreeModel(IlvManager manager)

Retrieves the value of an IlvMapLayerTreeProperty instance attached to an IlvManager object. If no property has been set to this manager, a new one is created and attached to manager.

Parameters:

manager - The IlvManager to retrieve the property from.

Returns:

The IlvMapLayerTreeModel attached to manager or null.