ilog.views.maps.theme

Class IlvMapStyleControllerProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.maps.theme.IlvMapStyleControllerProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvMapStyleControllerProperty
extends IlvNamedProperty

IlvMapStyleControllerProperty represents a IlvNamedProperty for storing an IlvMapStyleController.

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
IlvMapStyleControllerProperty(IlvInputStream stream) Reads an IlvMapStyleProperty object from an IlvInputStream.
IlvMapStyleControllerProperty(IlvMapStyleController model) Creates an IlvMapStyleProperty instance from an IlvMapStyleController object.
IlvMapStyleControllerProperty(IlvMapStyleControllerProperty source) Creates a IlvMapStyleProperty by copying an existing one.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Returns a copy of this property.
IlvMapStyleController	getMapStyleController() Retrieves the value of this property.
static IlvMapStyleController	GetMapStyleController(IlvManager manager) Retrieves the value of an IlvMapStyleProperty 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

IlvMapStyleControllerProperty

public IlvMapStyleControllerProperty(IlvMapStyleController model)

Creates an IlvMapStyleProperty instance from an IlvMapStyleController object.

Parameters:

model - The value of this property.

IlvMapStyleControllerProperty

public IlvMapStyleControllerProperty(IlvMapStyleControllerProperty source)

Creates a IlvMapStyleProperty by copying an existing one.

Parameters:

source - The property to copy.

IlvMapStyleControllerProperty

public IlvMapStyleControllerProperty(IlvInputStream stream)
                              throws IlvReadFileException

Reads an IlvMapStyleProperty object from an IlvInputStream.

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException - if there is a problem reading from 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:

If this property is persistent, true is returned.

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.

getMapStyleController

public IlvMapStyleController getMapStyleController()

Retrieves the value of this property.

Returns:

The value of this property.

GetMapStyleController

public static IlvMapStyleController GetMapStyleController(IlvManager manager)

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

Parameters:

manager - The IlvManager to retrieve the property from.

Returns:

The attached IlvMapStyleController. You may need to connect the style controller to your view if you want it to react to scale changes automatically.