ilog.views.graphlayout.tree

Class IlvTreeLayoutNodeProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.graphlayout.IlvGraphLayoutNodeProperty

ilog.views.graphlayout.tree.IlvTreeLayoutNodeProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvTreeLayoutNodeProperty
extends IlvGraphLayoutNodeProperty

The class IlvTreeLayoutNodeProperty allows you to store the settings of an instance of IlvTreeLayout for an individual node as a named property in the node. This is used by IlvGrapherPropertyAdapter.saveParametersToNamedProperties(IlvGraphLayout, 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 3.5

See Also:

IlvGrapherPropertyAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean), IlvGrapherPropertyAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherPropertyAdapter.removeParametersFromNamedProperties(), IlvGraphLayout.createLayoutNodeProperty(String, IlvGraphic, boolean), Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	IlvTreeLayoutNodeProperty(IlvInputStream stream) Creates a new IlvTreeLayoutNodeProperty from an IlvInputStream.
protected	IlvTreeLayoutNodeProperty(IlvInputStream stream, boolean fromSubclass) Creates a new IlvTreeLayoutNodeProperty from an IlvInputStream.
	IlvTreeLayoutNodeProperty(IlvTreeLayoutNodeProperty source) Creates a new IlvTreeLayoutNodeProperty by copying an existing one.
	IlvTreeLayoutNodeProperty(String name, IlvTreeLayout layout, IlvGraphic node, boolean withDefaults) Creates a new IlvTreeLayoutNodeProperty that stores layout parameter settings of the layout for the node.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Copies the named property.
void	dispose(IlvGrapherPropertyAdapter 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.
protected boolean	readProperties(IlvInputStream stream) Reads the properties from an IlvInputStream.
void	transfer(IlvGraphLayout graphLayout, IlvGraphic node) Transfers the layout parameter settings stored in this named property back to the input layout for the input node.
void	write(IlvOutputStream stream) Writes the property to the output stream.

Methods inherited from class ilog.views.graphlayout.IlvGraphLayoutNodeProperty

dispose, 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

IlvTreeLayoutNodeProperty

public IlvTreeLayoutNodeProperty(String name,
                                 IlvTreeLayout layout,
                                 IlvGraphic node,
                                 boolean withDefaults)

Creates a new IlvTreeLayoutNodeProperty that stores layout parameter settings of the layout for the node.

Parameters:

name - The name of the property.

layout - The layout instance to be stored.

node - The node 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).

IlvTreeLayoutNodeProperty

public IlvTreeLayoutNodeProperty(IlvTreeLayoutNodeProperty source)

Creates a new IlvTreeLayoutNodeProperty by copying an existing one.

Parameters:

source - The origin of the copy.

IlvTreeLayoutNodeProperty

public IlvTreeLayoutNodeProperty(IlvInputStream stream)
                          throws IOException,
                                 IlvReadFileException

Creates a new IlvTreeLayoutNodeProperty from an IlvInputStream.

Parameters:

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

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

IlvTreeLayoutNodeProperty

protected IlvTreeLayoutNodeProperty(IlvInputStream stream,
                                    boolean fromSubclass)
                             throws IOException,
                                    IlvReadFileException

Creates a new IlvTreeLayoutNodeProperty from an IlvInputStream. This method is for internal purpose.

Parameters:

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

fromSubclass - Whether this constructor is called from a subclass.

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

Since:

JViews 8.8

Method Detail

readProperties

protected boolean readProperties(IlvInputStream stream)
                          throws IOException,
                                 IlvReadFileException

Reads the properties from an IlvInputStream. This method is for internal purpose.

Overrides:

readProperties in class IlvGraphLayoutNodeProperty

Parameters:

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

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

Since:

JViews 8.8

copy

public IlvNamedProperty copy()

Copies the named property.

Overrides:

copy in class IlvGraphLayoutNodeProperty

isPersistent

public boolean isPersistent()

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

Overrides:

isPersistent in class IlvGraphLayoutNodeProperty

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 IlvGraphLayoutNodeProperty

Parameters:

stream - The output stream.

Throws:

IOException - standard IO error.

transfer

public void transfer(IlvGraphLayout graphLayout,
                     IlvGraphic node)

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

Overrides:

transfer in class IlvGraphLayoutNodeProperty

Parameters:

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

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

dispose

public void dispose(IlvGrapherPropertyAdapter 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 IlvGraphLayoutNodeProperty

Parameters:

adapter - The grapher property adapter.

Since:

JViews 8.8

See Also:

IlvGrapherPropertyAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherPropertyAdapter.removeParametersFromNamedProperties()