ilog.views.maps

Class IlvDisplayPreferencesProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.maps.IlvDisplayPreferencesProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvDisplayPreferencesProperty
extends IlvNamedProperty

This class defines a named property used to store the coordinate display preferences in an IlvManager containing cartographic data. Using GetDisplayPreferences(IlvManager) will return the display preference object attached to the manager or create a new one if necessary.

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
IlvDisplayPreferencesProperty(IlvDisplayPreferences ap) Creates a new IlvDisplayPreferencesProperty object with the specified display preferences.
IlvDisplayPreferencesProperty(IlvDisplayPreferencesProperty source) Creates a new IlvDisplayPreferencesProperty by copying an existing one.
IlvDisplayPreferencesProperty(IlvInputStream stream) Creates a new IlvDisplayPreferencesProperty from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Copies the property.
IlvDisplayPreferences	getDisplayPreferences() Returns the Display Preferences of this property.
static IlvDisplayPreferences	GetDisplayPreferences(IlvManager manager) Returns the Display Preferences of a manager.
boolean	isPersistent() Returns true if the property can be saved.
void	write(IlvOutputStream stream) Writes the property to an IlvOutputStream.

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

IlvDisplayPreferencesProperty

public IlvDisplayPreferencesProperty(IlvDisplayPreferences ap)

Creates a new IlvDisplayPreferencesProperty object with the specified display preferences.

Parameters:

ap - The Display Preferences.

IlvDisplayPreferencesProperty

public IlvDisplayPreferencesProperty(IlvDisplayPreferencesProperty source)

Creates a new IlvDisplayPreferencesProperty by copying an existing one.

Parameters:

source - The source property to be copied.

IlvDisplayPreferencesProperty

public IlvDisplayPreferencesProperty(IlvInputStream stream)
                              throws IlvReadFileException

Creates a new IlvDisplayPreferencesProperty from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if an error occurs while reading.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the property to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - The output stream.

Throws:

IOException - if an I/O exception occurs.

copy

public IlvNamedProperty copy()

Copies the property.

Specified by:

copy in class IlvNamedProperty

Returns:

A new IlvDisplayPreferencesProperty.

isPersistent

public boolean isPersistent()

Returns true if the property can be saved.

Specified by:

isPersistent in class IlvNamedProperty

Returns:

true.

getDisplayPreferences

public IlvDisplayPreferences getDisplayPreferences()

Returns the Display Preferences of this property.

Returns:

The Display Preferences of this property.

GetDisplayPreferences

public static IlvDisplayPreferences GetDisplayPreferences(IlvManager manager)

Returns the Display Preferences of a manager. This method tries to determine the Display Preferences of the manager using the following order: If an IlvDisplayPreferencesProperty is attached to the manager, the Display Preferences of the property is returned. Otherwise, a new IlvDisplayPreferences is created, stored and returned.

Parameters:

manager - The manager.

Returns:

The Display Preferences of this manager.