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