ilog.views.graphlayout.labellayout.annealing

Class IlvAnnealingLabelLayoutManagerProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.graphlayout.labellayout.IlvLabelLayoutManagerProperty

ilog.views.graphlayout.labellayout.annealing.IlvAnnealingLabelLayoutManagerProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvAnnealingLabelLayoutManagerProperty
extends IlvLabelLayoutManagerProperty

The class IlvAnnealingLabelLayoutManagerProperty allows you to store the global settings of an instance of IlvAnnealingLabelLayout as a named property in the manager. This is used by IlvDefaultLabelingModel.saveParametersToNamedProperties(IlvLabelLayout, boolean) which is an auxiliary to be used before IlvManager.write(IlvOutputStream) if you want to store layout parameter settings in .ivl files.

Since:

JViews 5.0

See Also:

IlvDefaultLabelingModel.saveParametersToNamedProperties(IlvLabelLayout, boolean), IlvDefaultLabelingModel.loadParametersFromNamedProperties(IlvLabelLayout), IlvDefaultLabelingModel.removeParametersFromNamedProperties(), IlvLabelLayout.createLayoutManagerProperty(String, boolean), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvAnnealingLabelLayoutManagerProperty(IlvAnnealingLabelLayoutManagerProperty source) Creates a new IlvAnnealingLabelLayoutManagerProperty by copying an existing one.
IlvAnnealingLabelLayoutManagerProperty(IlvInputStream stream) Creates a new IlvAnnealingLabelLayoutManagerProperty from an IlvInputStream.
IlvAnnealingLabelLayoutManagerProperty(String name, IlvAnnealingLabelLayout layout, boolean withDefaults) Creates a new IlvAnnealingLabelLayoutManagerProperty that stores layout parameter settings of the layout.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Copies the named property.
void	dispose(IlvDefaultLabelingModel model) Disposes of the property and releases any resources that it is using.
boolean	isPersistent() Returns true if the property must be saved to an .ivl file.
void	transfer(IlvLabelLayout labelLayout) Transfers the layout parameter settings stored in this named property back to the input layout.
void	write(IlvOutputStream stream) Writes the property to the output stream.

Methods inherited from class ilog.views.graphlayout.labellayout.IlvLabelLayoutManagerProperty

getLayout, omitDefaults

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

Constructor Detail

IlvAnnealingLabelLayoutManagerProperty

public IlvAnnealingLabelLayoutManagerProperty(String name,
                                              IlvAnnealingLabelLayout layout,
                                              boolean withDefaults)

Creates a new IlvAnnealingLabelLayoutManagerProperty that stores layout parameter settings of the layout.

Parameters:

name - The name of the property.

layout - The layout instance to be stored.

withDefaults - If true, the layout property is always persistent. If false, it is persistent only if nondefault parameter settings exist (that is, if the the property is saved to an .ivl file, the default parameter settings are not saved).

IlvAnnealingLabelLayoutManagerProperty

public IlvAnnealingLabelLayoutManagerProperty(IlvAnnealingLabelLayoutManagerProperty source)

Creates a new IlvAnnealingLabelLayoutManagerProperty by copying an existing one.

Parameters:

source - The origin of the copy.

IlvAnnealingLabelLayoutManagerProperty

public IlvAnnealingLabelLayoutManagerProperty(IlvInputStream stream)
                                       throws IOException,
                                              IlvReadFileException

Creates a new IlvAnnealingLabelLayoutManagerProperty from an IlvInputStream.

Parameters:

stream - The input stream from which the property must be read.

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

Method Detail

copy

public IlvNamedProperty copy()

Copies the named property.

Overrides:

copy in class IlvLabelLayoutManagerProperty

isPersistent

public boolean isPersistent()

Returns true if the property must be saved to an .ivl file.

Overrides:

isPersistent in class IlvLabelLayoutManagerProperty

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the property to the output stream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvLabelLayoutManagerProperty

Parameters:

stream - The output stream.

Throws:

IOException - standard IO error.

transfer

public void transfer(IlvLabelLayout labelLayout)

Transfers the layout parameter settings stored in this named property back to the input layout.

Overrides:

transfer in class IlvLabelLayoutManagerProperty

Parameters:

labelLayout - The layout instance whose parameters are to be recovered from this instance.

dispose

public void dispose(IlvDefaultLabelingModel model)

Disposes of the property and releases any resources that it is using. This is called if the property was loaded and removed from the manager.

Overrides:

dispose in class IlvLabelLayoutManagerProperty

Parameters:

model - The labeling model.

See Also:

IlvDefaultLabelingModel.loadParametersFromNamedProperties(IlvLabelLayout), IlvDefaultLabelingModel.removeParametersFromNamedProperties()