public class IlvAnnealingLabelLayoutLabelProperty extends IlvLabelLayoutLabelProperty
IlvAnnealingLabelLayoutLabelProperty
allows you
to store the settings of an instance of
IlvAnnealingLabelLayout
for an individual label as a
named property in the label. This is used by IlvDefaultLabelingModel.saveParametersToNamedProperties(IlvLabelLayout,
boolean)
which is an auxiliary to be used before IlvManager.write(IlvOutputStream)
if you want to store layout
parameter settings in .ivl
files.
IlvDefaultLabelingModel.saveParametersToNamedProperties(IlvLabelLayout, boolean)
,
IlvDefaultLabelingModel.loadParametersFromNamedProperties(IlvLabelLayout)
,
IlvDefaultLabelingModel.removeParametersFromNamedProperties()
,
IlvLabelLayout.createLayoutLabelProperty(String, IlvGraphic, boolean)
,
Serialized FormConstructor and Description |
---|
IlvAnnealingLabelLayoutLabelProperty(IlvAnnealingLabelLayoutLabelProperty source)
Creates a new
IlvAnnealingLabelLayoutLabelProperty by
copying an existing one. |
IlvAnnealingLabelLayoutLabelProperty(IlvInputStream stream)
Creates a new
IlvAnnealingLabelLayoutLabelProperty from
an IlvInputStream . |
IlvAnnealingLabelLayoutLabelProperty(String name,
IlvAnnealingLabelLayout layout,
IlvGraphic label,
boolean withDefaults)
Creates a new
IlvAnnealingLabelLayoutLabelProperty that
stores layout parameter settings of the layout for the
label . |
Modifier and Type | Method and Description |
---|---|
IlvNamedProperty |
copy()
Copies the named property.
|
void |
dispose(IlvDefaultLabelingModel model)
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(IlvLabelLayout labelLayout,
IlvGraphic label)
Transfers the layout parameter settings stored in this named property
back to the input layout for the input label.
|
void |
write(IlvOutputStream stream)
Writes the property to the output stream.
|
getLayout, isWritten, omitDefaults
getName
public IlvAnnealingLabelLayoutLabelProperty(String name, IlvAnnealingLabelLayout layout, IlvGraphic label, boolean withDefaults)
IlvAnnealingLabelLayoutLabelProperty
that
stores layout parameter settings of the layout
for the
label
.name
- The name of the property.layout
- The layout instance to be stored.label
- The label 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 IlvAnnealingLabelLayoutLabelProperty(IlvAnnealingLabelLayoutLabelProperty source)
IlvAnnealingLabelLayoutLabelProperty
by
copying an existing one.source
- The origin of the copy.public IlvAnnealingLabelLayoutLabelProperty(IlvInputStream stream) throws IOException, IlvReadFileException
IlvAnnealingLabelLayoutLabelProperty
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 IlvLabelLayoutLabelProperty
public boolean isPersistent()
true
if the property must be saved to an
.ivl
file.isPersistent
in class IlvLabelLayoutLabelProperty
public void write(IlvOutputStream stream) throws IOException
write
in interface IlvPersistentObject
write
in class IlvLabelLayoutLabelProperty
stream
- The output stream.IOException
- standard IO error.public void transfer(IlvLabelLayout labelLayout, IlvGraphic label)
transfer
in class IlvLabelLayoutLabelProperty
labelLayout
- The layout instance whose parameters are to be
recovered from this named property.label
- The label whose layout parameters are to be recovered from
this named property.public void dispose(IlvDefaultLabelingModel model)
dispose
in class IlvLabelLayoutLabelProperty
model
- The labeling model.IlvDefaultLabelingModel.loadParametersFromNamedProperties(IlvLabelLayout)
,
IlvDefaultLabelingModel.removeParametersFromNamedProperties()
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.