com.esri.arcgis.cartox.cim

Class CIMStandardLabelPlacementProperties

java.lang.Object

com.esri.arcgis.cartox.cim.CIMObject

com.esri.arcgis.cartox.cim.CIMLabelPlacementProperties

com.esri.arcgis.cartox.cim.CIMStandardLabelPlacementProperties

public class CIMStandardLabelPlacementProperties
extends CIMLabelPlacementProperties

Represents standard label engine label placement properties.

Constructor Summary

Constructors

Constructor and Description
CIMStandardLabelPlacementProperties()

Method Summary

Modifier and Type	Method and Description
void	deserialize(JSONObject jsonObject) Deserializes this object from its JSON representation.
static CIMStandardLabelPlacementProperties	fromJSON(java.lang.String json) Creates the object with a specified state from a JSON encoding.
boolean	getAllowOverlappingLabels() Gets a value indicating whether or not to allow overlapping labels.
double	getBufferRatio() Gets the buffer ratio.
StandardFeatureWeight	getFeatureWeight() Gets the feature weight.
StandardLabelWeight	getLabelWeight() Gets the label weight.
CIMStandardLineLabelPosition	getLineLabelPosition() Gets the line label position.
CIMStandardLineLabelPriorities	getLineLabelPriorities() Gets the line label priorities.
double	getLineOffset() Gets the line offset.
double	getMaxDistanceFromTarget() Gets the maximum distance from target.
StandardNumLabelsOption	getNumLabelsOption() Gets the option for number of labels.
boolean	getPerpendicularToAngle() Gets a value indicating whether or not to place the label perpendicular to the angle.
boolean	getPlaceOnlyInsidePolygon() Gets a value indicating whether or not to place the label only inside a polygon.
double[]	getPointPlacementAngles() Gets an array of point placement angles.
StandardPointPlacementMethod	getPointPlacementMethod() Gets the point placement method.
CIMStandardPointPlacementPriorities	getPointPlacementPriorities() Gets the point placement priorities.
StandardPolygonPlacementMethod	getPolygonPlacementMethod() Gets the polygon placement method.
java.lang.String	getRotationField() Gets the rotation field.
StandardLabelRotationType	getRotationType() Gets the rotation type.
void	serialize(JSONObject jsonObject) Serializes this object to its JSON representation.
void	setAllowOverlappingLabels(boolean allowOverlappingLabels) Sets a value indicating whether or not to allow overlapping labels.
void	setBufferRatio(double bufferRatio) Sets the buffer ratio.
void	setFeatureWeight(StandardFeatureWeight featureWeight) Sets the feature weight.
void	setLabelWeight(StandardLabelWeight labelWeight) Sets the label weight.
void	setLineLabelPosition(CIMStandardLineLabelPosition lineLabelPosition) Sets the line label position.
void	setLineLabelPriorities(CIMStandardLineLabelPriorities lineLabelPriorities) Sets the line label priorities.
void	setLineOffset(double lineOffset) Sets the line offset.
void	setMaxDistanceFromTarget(double maxDistanceFromTarget) Sets the maximum distance from target.
void	setNumLabelsOption(StandardNumLabelsOption numLabelsOption) Sets the option for number of labels.
void	setPerpendicularToAngle(boolean perpendicularToAngle) Sets a value indicating whether or not to place the label perpendicular to the angle.
void	setPlaceOnlyInsidePolygon(boolean placeOnlyInsidePolygon) Sets a value indicating whether or not to place the label only inside a polygon.
void	setPointPlacementAngles(double[] pointPlacementAngles) Sets an array of point placement angles.
void	setPointPlacementMethod(StandardPointPlacementMethod pointPlacementMethod) Sets the point placement method.
void	setPointPlacementPriorities(CIMStandardPointPlacementPriorities pointPlacementPriorities) Sets the point placement priorities.
void	setPolygonPlacementMethod(StandardPolygonPlacementMethod polygonPlacementMethod) Sets the polygon placement method.
void	setRotationField(java.lang.String rotationField) Sets the rotation field.
void	setRotationType(StandardLabelRotationType rotationType) Sets the rotation type.
java.lang.String	toJSON() Creates a JSON encoding of the object and its current state.

Methods inherited from class com.esri.arcgis.cartox.cim.CIMLabelPlacementProperties

getFeatureType, setFeatureType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CIMStandardLabelPlacementProperties

public CIMStandardLabelPlacementProperties()

Method Detail

getFeatureWeight

public StandardFeatureWeight getFeatureWeight()

Gets the feature weight.

setFeatureWeight

public void setFeatureWeight(StandardFeatureWeight featureWeight)

Sets the feature weight.

getLabelWeight

public StandardLabelWeight getLabelWeight()

Gets the label weight.

setLabelWeight

public void setLabelWeight(StandardLabelWeight labelWeight)

Sets the label weight.

getNumLabelsOption

public StandardNumLabelsOption getNumLabelsOption()

Gets the option for number of labels.

setNumLabelsOption

public void setNumLabelsOption(StandardNumLabelsOption numLabelsOption)

Sets the option for number of labels.

getLineLabelPosition

public CIMStandardLineLabelPosition getLineLabelPosition()

Gets the line label position.

setLineLabelPosition

public void setLineLabelPosition(CIMStandardLineLabelPosition lineLabelPosition)

Sets the line label position.

getLineLabelPriorities

public CIMStandardLineLabelPriorities getLineLabelPriorities()

Gets the line label priorities.

setLineLabelPriorities

public void setLineLabelPriorities(CIMStandardLineLabelPriorities lineLabelPriorities)

Sets the line label priorities.

getPointPlacementMethod

public StandardPointPlacementMethod getPointPlacementMethod()

Gets the point placement method.

setPointPlacementMethod

public void setPointPlacementMethod(StandardPointPlacementMethod pointPlacementMethod)

Sets the point placement method.

getPointPlacementPriorities

public CIMStandardPointPlacementPriorities getPointPlacementPriorities()

Gets the point placement priorities.

setPointPlacementPriorities

public void setPointPlacementPriorities(CIMStandardPointPlacementPriorities pointPlacementPriorities)

Sets the point placement priorities.

getPointPlacementAngles

public double[] getPointPlacementAngles()

Gets an array of point placement angles.

setPointPlacementAngles

public void setPointPlacementAngles(double[] pointPlacementAngles)

Sets an array of point placement angles.

getBufferRatio

public double getBufferRatio()

Gets the buffer ratio.

setBufferRatio

public void setBufferRatio(double bufferRatio)

Sets the buffer ratio.

getLineOffset

public double getLineOffset()

Gets the line offset.

setLineOffset

public void setLineOffset(double lineOffset)

Sets the line offset.

getMaxDistanceFromTarget

public double getMaxDistanceFromTarget()

Gets the maximum distance from target.

setMaxDistanceFromTarget

public void setMaxDistanceFromTarget(double maxDistanceFromTarget)

Sets the maximum distance from target.

getRotationType

public StandardLabelRotationType getRotationType()

Gets the rotation type.

setRotationType

public void setRotationType(StandardLabelRotationType rotationType)

Sets the rotation type.

getRotationField

public java.lang.String getRotationField()

Gets the rotation field.

setRotationField

public void setRotationField(java.lang.String rotationField)

Sets the rotation field.

getPerpendicularToAngle

public boolean getPerpendicularToAngle()

Gets a value indicating whether or not to place the label perpendicular to the angle.

setPerpendicularToAngle

public void setPerpendicularToAngle(boolean perpendicularToAngle)

Sets a value indicating whether or not to place the label perpendicular to the angle.

getPolygonPlacementMethod

public StandardPolygonPlacementMethod getPolygonPlacementMethod()

Gets the polygon placement method.

setPolygonPlacementMethod

public void setPolygonPlacementMethod(StandardPolygonPlacementMethod polygonPlacementMethod)

Sets the polygon placement method.

getPlaceOnlyInsidePolygon

public boolean getPlaceOnlyInsidePolygon()

Gets a value indicating whether or not to place the label only inside a polygon.

setPlaceOnlyInsidePolygon

public void setPlaceOnlyInsidePolygon(boolean placeOnlyInsidePolygon)

Sets a value indicating whether or not to place the label only inside a polygon.

getAllowOverlappingLabels

public boolean getAllowOverlappingLabels()

Gets a value indicating whether or not to allow overlapping labels.

setAllowOverlappingLabels

public void setAllowOverlappingLabels(boolean allowOverlappingLabels)

Sets a value indicating whether or not to allow overlapping labels.

fromJSON

public static CIMStandardLabelPlacementProperties fromJSON(java.lang.String json)
                                                    throws CIMJSONException

Creates the object with a specified state from a JSON encoding.

Throws:

CIMJSONException

toJSON

public java.lang.String toJSON()

Creates a JSON encoding of the object and its current state.

Specified by:

toJSON in class CIMObject

deserialize

public void deserialize(JSONObject jsonObject)
                 throws CIMJSONException

Deserializes this object from its JSON representation.

Overrides:

deserialize in class CIMLabelPlacementProperties

Throws:

CIMJSONException

serialize

public void serialize(JSONObject jsonObject)

Serializes this object to its JSON representation.

Overrides:

serialize in class CIMLabelPlacementProperties