public class IltShortLinkLayoutLinkProperty extends IlvGraphLayoutLinkProperty
IltShortLinkLayoutLinkProperty
allows you to store
the settings of an instance of IltShortLinkLayout
for an individual link as a named property in the link.
This is used by
IlvGrapherAdapter.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.
IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean)
,
IlvGrapherAdapter.loadParametersFromNamedProperties(IlvGraphLayout)
,
IlvGrapherAdapter.removeParametersFromNamedProperties()
,
IlvGraphLayout.createLayoutLinkProperty(String, IlvGraphic, boolean)
,
Serialized FormConstructor and Description |
---|
IltShortLinkLayoutLinkProperty(IltShortLinkLayoutLinkProperty source)
Creates a new
IltShortLinkLayoutLinkProperty by copying an
existing one. |
IltShortLinkLayoutLinkProperty(IlvInputStream stream)
Creates a new
IltShortLinkLayoutLinkProperty from
an IlvInputStream . |
IltShortLinkLayoutLinkProperty(String name,
IltShortLinkLayout layout,
IlvGraphic link,
boolean withDefaults)
Creates a new
IltShortLinkLayoutLinkProperty 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(IlvGrapherAdapter 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. |
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, readProperties
getName
public IltShortLinkLayoutLinkProperty(String name, IltShortLinkLayout layout, IlvGraphic link, boolean withDefaults)
IltShortLinkLayoutLinkProperty
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 IltShortLinkLayoutLinkProperty(IltShortLinkLayoutLinkProperty source)
IltShortLinkLayoutLinkProperty
by copying an
existing one.source
- The origin of the copy.public IltShortLinkLayoutLinkProperty(IlvInputStream stream) throws IOException, IlvReadFileException
IltShortLinkLayoutLinkProperty
from
an IlvInputStream
.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(IlvGrapherAdapter adapter)
dispose
in class IlvGraphLayoutLinkProperty
adapter
- The grapher adapter.IlvGrapherAdapter.loadParametersFromNamedProperties(IlvGraphLayout)
,
IlvGrapherAdapter.removeParametersFromNamedProperties()
© Copyright 2024 Rogue Wave Software, Inc., a Perforce company.. All Rights Reserved.