ilog.views.graphlayout.labellayout.annealing
Class IlvAnnealingLabelLayoutLabelProperty

java.lang.Object
  ilog.views.IlvNamedProperty
      ilog.views.graphlayout.labellayout.IlvLabelLayoutLabelProperty
          ilog.views.graphlayout.labellayout.annealing.IlvAnnealingLabelLayoutLabelProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvAnnealingLabelLayoutLabelProperty
extends IlvLabelLayoutLabelProperty

The class IlvAnnealingLabelLayoutLabelProperty allows you to store the settings of an instance of IlvAnnealingLabelLayout for an individual label as a named property in the label. 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.createLayoutLabelProperty(String, IlvGraphic, boolean), Serialized Form

Constructor Summary

IlvAnnealingLabelLayoutLabelProperty(IlvAnnealingLabelLayoutLabelProperty source)
Creates a new IlvAnnealingLabelLayoutLabelProperty by copying an existing one.

IlvAnnealingLabelLayoutLabelProperty(IlvInputStream stream)
Creates a new IlvAnnealingLabelLayoutLabelProperty from an IlvInputStream.

IlvAnnealingLabelLayoutLabelProperty(String name, IlvAnnealingLabelLayout layout, IlvGraphic label, boolean withDefaults)
Creates a new IlvAnnealingLabelLayoutLabelProperty that stores layout parameter settings of the layout for the label.

Method Summary

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, IlvGraphic label) Transfers the layout parameter settings stored in this named property back to the input layout for the input label.
void	write(IlvOutputStream stream) Writes the property to the output stream.

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

getLayout, isWritten, 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

IlvAnnealingLabelLayoutLabelProperty

public IlvAnnealingLabelLayoutLabelProperty(String name,
                                            IlvAnnealingLabelLayout layout,
                                            IlvGraphic label,
                                            boolean withDefaults)

Creates a new IlvAnnealingLabelLayoutLabelProperty that stores layout parameter settings of the layout for the label.

Parameters:

name - The name of the property.

layout - The layout instance to be stored.

label - The label whose layout parameters are 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).

IlvAnnealingLabelLayoutLabelProperty

public IlvAnnealingLabelLayoutLabelProperty(IlvAnnealingLabelLayoutLabelProperty source)

Creates a new IlvAnnealingLabelLayoutLabelProperty by copying an existing one.

Parameters:

source - The origin of the copy.

IlvAnnealingLabelLayoutLabelProperty

public IlvAnnealingLabelLayoutLabelProperty(IlvInputStream stream)
                                     throws IOException,
                                            IlvReadFileException

Creates a new IlvAnnealingLabelLayoutLabelProperty 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 IlvLabelLayoutLabelProperty

isPersistent

public boolean isPersistent()

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

Overrides:

isPersistent in class IlvLabelLayoutLabelProperty

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 IlvLabelLayoutLabelProperty

Parameters:

stream - The output stream.

Throws:

IOException - standard IO error.

transfer

public void transfer(IlvLabelLayout labelLayout,
                     IlvGraphic label)

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

Overrides:

transfer in class IlvLabelLayoutLabelProperty

Parameters:

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

label - The label whose layout parameters are to be recovered from this named property.

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 IlvLabelLayoutLabelProperty

Parameters:

model - The labeling model.

See Also:

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