ilog.tgo.graphic.graphlayout

Class IltLinkLayoutGrapherProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.graphlayout.IlvGraphLayoutGrapherProperty

ilog.tgo.graphic.graphlayout.IltLinkLayoutGrapherProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IltLinkLayoutGrapherProperty
extends IlvGraphLayoutGrapherProperty

The class IltLinkLayoutGrapherProperty allows you to store the global settings of an instance of IltLinkLayout as a named property in the grapher. This is used by IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean) which is an auxiliary to be used before IlvGrapher.write(IlvOutputStream) if you want to store layout parameter settings in .ivl files.

Since:

JTGO 2.6

See Also:

IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean), IlvGrapherAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherAdapter.removeParametersFromNamedProperties(), IlvGraphLayout.createLayoutGrapherProperty(String, boolean), Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Copies the named property.
void	dispose(IlvGrapherAdapter adapter) 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(IlvGraphLayout graphLayout) 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.IlvGraphLayoutGrapherProperty

dispose, getLayout, omitDefaults, readProperties

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

IltLinkLayoutGrapherProperty

public IltLinkLayoutGrapherProperty(String name,
                                    IltLinkLayout layout,
                                    boolean withDefaults)

Creates a new IltLinkLayoutGrapherProperty 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).

Internal: do not use!

IltLinkLayoutGrapherProperty

public IltLinkLayoutGrapherProperty(IltLinkLayoutGrapherProperty source)

Creates a new IltLinkLayoutGrapherProperty by copying an existing one.

Parameters:

source - The origin of the copy.

Internal: do not use!

IltLinkLayoutGrapherProperty

public IltLinkLayoutGrapherProperty(IlvInputStream stream)
                             throws IOException,
                                    IlvReadFileException

Creates a new IltLinkLayoutGrapherProperty from an IlvInputStream.

Parameters:

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

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

Internal: do not use!

Method Detail

copy

public IlvNamedProperty copy()

Copies the named property.

Overrides:

copy in class IlvGraphLayoutGrapherProperty

Internal: do not use!

isPersistent

public boolean isPersistent()

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

Overrides:

isPersistent in class IlvGraphLayoutGrapherProperty

Internal: do not use!

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 IlvGraphLayoutGrapherProperty

Parameters:

stream - The output stream.

Throws:

IOException - standard IO error.

Internal: do not use!

transfer

public void transfer(IlvGraphLayout graphLayout)

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

Overrides:

transfer in class IlvGraphLayoutGrapherProperty

Parameters:

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

Internal: do not use!

dispose

public void dispose(IlvGrapherAdapter adapter)

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

Overrides:

dispose in class IlvGraphLayoutGrapherProperty

Parameters:

adapter - The grapher adapter.

Since:

JViews 5.0

See Also:

IlvGrapherAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherAdapter.removeParametersFromNamedProperties()

Internal: do not use!