public class IlvHierarchicalLayoutGrapherProperty extends IlvGraphLayoutGrapherProperty
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.
IlvGrapherPropertyAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean)
,
IlvGrapherPropertyAdapter.loadParametersFromNamedProperties(IlvGraphLayout)
,
IlvGrapherPropertyAdapter.removeParametersFromNamedProperties()
,
IlvGraphLayout.createLayoutGrapherProperty(String, boolean)
,
Serialized FormModifier | 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 . |
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.
|
dispose, getLayout, omitDefaults
getName
public IlvHierarchicalLayoutGrapherProperty(String name, IlvHierarchicalLayout layout, boolean withDefaults)
IlvHierarchicalLayoutGrapherProperty
that
stores layout parameter settings of the layout
.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).public IlvHierarchicalLayoutGrapherProperty(IlvHierarchicalLayoutGrapherProperty source)
IlvHierarchicalLayoutGrapherProperty
by
copying an existing one.source
- The origin of the copy.public IlvHierarchicalLayoutGrapherProperty(IlvInputStream stream) throws IOException, IlvReadFileException
IlvHierarchicalLayoutGrapherProperty
from
an IlvInputStream
.stream
- The input stream from which the property must be read.IlvReadFileException
- if an error occurs while reading.IOException
protected IlvHierarchicalLayoutGrapherProperty(IlvInputStream stream, boolean fromSubclass) throws IOException, IlvReadFileException
IlvHierarchicalLayoutGrapherProperty
from
an IlvInputStream
. This method is for internal purpose.stream
- The input stream from which the property must be read.fromSubclass
- Whether this constructor is called from a subclass.IlvReadFileException
- if an error occurs while reading.IOException
protected boolean readProperties(IlvInputStream stream) throws IOException, IlvReadFileException
IlvInputStream
. This method
is for internal purpose.readProperties
in class IlvGraphLayoutGrapherProperty
stream
- The input stream from which the property must be read.IlvReadFileException
- if an error occurs while reading.IOException
public IlvNamedProperty copy()
copy
in class IlvGraphLayoutGrapherProperty
public boolean isPersistent()
true
if the property must be saved to an
.ivl
file.isPersistent
in class IlvGraphLayoutGrapherProperty
public void write(IlvOutputStream stream) throws IOException
write
in interface IlvPersistentObject
write
in class IlvGraphLayoutGrapherProperty
stream
- The output stream.IOException
- standard IO error.public void transfer(IlvGraphLayout graphLayout)
transfer
in class IlvGraphLayoutGrapherProperty
graphLayout
- The layout instance whose parameters are to be
recovered from this instance.public void dispose(IlvGrapherPropertyAdapter adapter)
dispose
in class IlvGraphLayoutGrapherProperty
adapter
- The grapher property adapter.IlvGrapherPropertyAdapter.loadParametersFromNamedProperties(IlvGraphLayout)
,
IlvGrapherPropertyAdapter.removeParametersFromNamedProperties()
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.