public class IlvTopologicalMeshLayoutNodeProperty extends IlvBasicLinkStyleLayoutNodeProperty
IlvTopologicalMeshLayoutNodeProperty
allows you
to store the settings of an instance of
IlvTopologicalMeshLayout
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.
IlvGrapherPropertyAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean)
,
IlvGrapherPropertyAdapter.loadParametersFromNamedProperties(IlvGraphLayout)
,
IlvGrapherPropertyAdapter.removeParametersFromNamedProperties()
,
IlvGraphLayout.createLayoutNodeProperty(String, IlvGraphic, boolean)
,
Serialized FormModifier | Constructor and Description |
---|---|
|
IlvTopologicalMeshLayoutNodeProperty(IlvInputStream stream)
Creates a new
IlvTopologicalMeshLayoutNodeProperty from
an IlvInputStream . |
protected |
IlvTopologicalMeshLayoutNodeProperty(IlvInputStream stream,
boolean fromSubclass)
Creates a new
IlvTopologicalMeshLayoutNodeProperty from
an IlvInputStream . |
|
IlvTopologicalMeshLayoutNodeProperty(IlvTopologicalMeshLayoutNodeProperty source)
Creates a new
IlvTopologicalMeshLayoutNodeProperty by
copying an existing one. |
|
IlvTopologicalMeshLayoutNodeProperty(String name,
IlvTopologicalMeshLayout layout,
IlvGraphic node,
boolean withDefaults)
Creates a new
IlvTopologicalMeshLayoutNodeProperty that
stores layout parameter settings of the layout for the
node . |
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.
|
dispose, getLayout, isWritten, omitDefaults
getName
public IlvTopologicalMeshLayoutNodeProperty(String name, IlvTopologicalMeshLayout layout, IlvGraphic node, boolean withDefaults)
IlvTopologicalMeshLayoutNodeProperty
that
stores layout parameter settings of the layout
for the
node
.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).public IlvTopologicalMeshLayoutNodeProperty(IlvTopologicalMeshLayoutNodeProperty source)
IlvTopologicalMeshLayoutNodeProperty
by
copying an existing one.source
- The origin of the copy.public IlvTopologicalMeshLayoutNodeProperty(IlvInputStream stream) throws IOException, IlvReadFileException
IlvTopologicalMeshLayoutNodeProperty
from
an IlvInputStream
.stream
- The input stream from which the property must be read.IlvReadFileException
- if an error occurs while reading.IOException
protected IlvTopologicalMeshLayoutNodeProperty(IlvInputStream stream, boolean fromSubclass) throws IOException, IlvReadFileException
IlvTopologicalMeshLayoutNodeProperty
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 IlvBasicLinkStyleLayoutNodeProperty
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 IlvBasicLinkStyleLayoutNodeProperty
public boolean isPersistent()
true
if the property must be saved to an
.ivl
file.isPersistent
in class IlvBasicLinkStyleLayoutNodeProperty
public void write(IlvOutputStream stream) throws IOException
write
in interface IlvPersistentObject
write
in class IlvBasicLinkStyleLayoutNodeProperty
stream
- The output stream.IOException
- standard IO error.public void transfer(IlvGraphLayout graphLayout, IlvGraphic node)
transfer
in class IlvBasicLinkStyleLayoutNodeProperty
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.public void dispose(IlvGrapherPropertyAdapter adapter)
dispose
in class IlvBasicLinkStyleLayoutNodeProperty
adapter
- The grapher property adapter.IlvGrapherPropertyAdapter.loadParametersFromNamedProperties(IlvGraphLayout)
,
IlvGrapherPropertyAdapter.removeParametersFromNamedProperties()
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.