ilog.views.graphlayout.hierarchical

Class IlvHierarchicalLayoutGrapherProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.graphlayout.IlvGraphLayoutGrapherProperty

ilog.views.graphlayout.hierarchical.IlvHierarchicalLayoutGrapherProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvHierarchicalLayoutGrapherProperty
extends IlvGraphLayoutGrapherProperty

The class IlvHierarchicalLayoutGrapherProperty allows you to store the global settings of an instance of IlvHierarchicalLayout as a named property in the grapher. This is used by IlvGrapherPropertyAdapter.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:

JViews 3.5

See Also:

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

Constructor Summary

Constructors

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

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) 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

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

IlvHierarchicalLayoutGrapherProperty

public IlvHierarchicalLayoutGrapherProperty(String name,
                                            IlvHierarchicalLayout layout,
                                            boolean withDefaults)

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

IlvHierarchicalLayoutGrapherProperty

public IlvHierarchicalLayoutGrapherProperty(IlvHierarchicalLayoutGrapherProperty source)

Creates a new IlvHierarchicalLayoutGrapherProperty by copying an existing one.

Parameters:

source - The origin of the copy.

IlvHierarchicalLayoutGrapherProperty

public IlvHierarchicalLayoutGrapherProperty(IlvInputStream stream)
                                     throws IOException,
                                            IlvReadFileException

Creates a new IlvHierarchicalLayoutGrapherProperty from an IlvInputStream.

Parameters:

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

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

IlvHierarchicalLayoutGrapherProperty

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

Creates a new IlvHierarchicalLayoutGrapherProperty 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 IlvGraphLayoutGrapherProperty

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 IlvGraphLayoutGrapherProperty

isPersistent

public boolean isPersistent()

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

Overrides:

isPersistent in class IlvGraphLayoutGrapherProperty

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.

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.

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 IlvGraphLayoutGrapherProperty

Parameters:

adapter - The grapher property adapter.

Since:

JViews 8.8

See Also:

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