ilog.views.maps.label
Class IlvMapLabelerProperty

java.lang.Object
  ilog.views.IlvNamedProperty
      ilog.views.maps.label.IlvMapLabelerProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvMapLabelerProperty
extends IlvNamedProperty

IlvMapLabelerProperty represents a named property that holds a IlvMapLabeler.

The following code example shows how a labeler can be retrieved from a manager:

 IlvManager manager = ...;
 
 IlvMapLabeler model = 
    IlvMapLabelerProperty.GetMapLabeler(manager);
 

Note: if no labeler has been attached previous to the GetMapLabeler method being called, a new instance is created and attached.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

static String

NAME The name of the property.

Constructor Summary

IlvMapLabelerProperty(IlvInputStream stream)
Reads an IlvMapLabelerProperty from an IlvInputStream.

IlvMapLabelerProperty(IlvMapLabeler labeler)
Creates an IlvMapLabelerProperty instance from an IlvMapLabeler object.

IlvMapLabelerProperty(IlvMapLabelerProperty source)
Creates an IlvMapLabelerProperty instance by copying an existing one.

Method Summary

IlvNamedProperty	copy() Returns a copy of this IlvMapLabelerProperty instance.
IlvMapLabeler	getMapLabeler() Retrieves the value of this property.
static IlvMapLabeler	GetMapLabeler(IlvManager manager) Retrieves the value of the IlvMapLayerTreeProperty attached to an IlvManager instance.
boolean	isPersistent() Tests if the property may be saved to an IVL file.
void	write(IlvOutputStream stream) Writes this IlvMapLabelerProperty instance to an output stream.

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

IlvMapLabelerProperty

public IlvMapLabelerProperty(IlvMapLabeler labeler)

Creates an IlvMapLabelerProperty instance from an IlvMapLabeler object.

Parameters:

labeler - The value of this property.

IlvMapLabelerProperty

public IlvMapLabelerProperty(IlvMapLabelerProperty source)

Creates an IlvMapLabelerProperty instance by copying an existing one.

Parameters:

source - The property to copy.

IlvMapLabelerProperty

public IlvMapLabelerProperty(IlvInputStream stream)
                      throws IlvReadFileException

Reads an IlvMapLabelerProperty 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 IlvMapLabelerProperty instance.

Specified by:

copy in class IlvNamedProperty

Returns:

A copy of this IlvMapLabelerProperty instance.

See Also:

IlvNamedProperty.copy()

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this IlvMapLabelerProperty instance to an output stream.

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.

See Also:

IlvNamedProperty.write(ilog.views.io.IlvOutputStream)

getMapLabeler

public IlvMapLabeler getMapLabeler()

Retrieves the value of this property.

Returns:

The IlvMapLabeler value of this property.

isPersistent

public boolean isPersistent()

Tests if the property may be saved to an IVL file.

Specified by:

isPersistent in class IlvNamedProperty

Returns:

If this method returns true, the property is saved.

See Also:

IlvNamedProperty.isPersistent()

GetMapLabeler

public static IlvMapLabeler GetMapLabeler(IlvManager manager)

Retrieves the value of the IlvMapLayerTreeProperty attached to an IlvManager instance.

Parameters:

manager - The IlvManager to retrieve the property from.

Returns:

The attached IlvMapLayerTreeModel. If no labeler has been attached, a new IlvMapDefaultLabeler instance is created and attached to manager.