ilog.views.graphlayout.hierarchical

Class IlvHierarchicalLayoutLinkProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.graphlayout.IlvGraphLayoutLinkProperty

ilog.views.graphlayout.hierarchical.IlvHierarchicalLayoutLinkProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvHierarchicalLayoutLinkProperty
extends IlvGraphLayoutLinkProperty

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

Constructor Summary

Constructors

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

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

Methods inherited from class ilog.views.graphlayout.IlvGraphLayoutLinkProperty

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

IlvHierarchicalLayoutLinkProperty

public IlvHierarchicalLayoutLinkProperty(String name,
                                         IlvHierarchicalLayout layout,
                                         IlvGraphic link,
                                         boolean withDefaults)

Creates a new IlvHierarchicalLayoutLinkProperty that stores layout parameter settings of the layout for the link.

Parameters:

name - The name of the property.

layout - The layout instance to be stored.

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

IlvHierarchicalLayoutLinkProperty

public IlvHierarchicalLayoutLinkProperty(IlvHierarchicalLayoutLinkProperty source)

Creates a new IlvHierarchicalLayoutLinkProperty by copying an existing one.

Parameters:

source - The origin of the copy.

IlvHierarchicalLayoutLinkProperty

public IlvHierarchicalLayoutLinkProperty(IlvInputStream stream)
                                  throws IOException,
                                         IlvReadFileException

Creates a new IlvHierarchicalLayoutLinkProperty from an IlvInputStream.

Parameters:

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

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

IlvHierarchicalLayoutLinkProperty

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

Creates a new IlvHierarchicalLayoutLinkProperty 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 IlvGraphLayoutLinkProperty

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 IlvGraphLayoutLinkProperty

isPersistent

public boolean isPersistent()

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

Overrides:

isPersistent in class IlvGraphLayoutLinkProperty

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 IlvGraphLayoutLinkProperty

Parameters:

stream - The output stream.

Throws:

IOException - standard IO error.

transfer

public void transfer(IlvGraphLayout graphLayout,
                     IlvGraphic link)

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

Overrides:

transfer in class IlvGraphLayoutLinkProperty

Parameters:

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

link - The link 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 IlvGraphLayoutLinkProperty

Parameters:

adapter - The grapher property adapter.

Since:

JViews 8.8

See Also:

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