com.esri.arcgis.carto
Class BasicOverposterLayerProperties

java.lang.Object
  com.esri.arcgis.carto.BasicOverposterLayerProperties

All Implemented Interfaces:

IBasicOverposterLayerProperties, IBasicOverposterLayerProperties2, IBasicOverposterLayerProperties3, IBasicOverposterLayerProperties4, IOverposterLayerProperties, IOverposterLayerProperties2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class BasicOverposterLayerProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IBasicOverposterLayerProperties, IBasicOverposterLayerProperties2, IBasicOverposterLayerProperties3, IBasicOverposterLayerProperties4, IOverposterLayerProperties, IOverposterLayerProperties2, IPersist, IPersistStream, IClone, Externalizable

Controls the placement of labels or symbols relative to features using conflict detection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

BasicOverposterLayerProperties()
Constructs a BasicOverposterLayerProperties using ArcGIS Engine.

BasicOverposterLayerProperties(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicOverposterLayerProperties theBasicOverposterLayerProperties = (BasicOverposterLayerProperties) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
double	getBufferRatio() Label buffer ratio.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getFeatureType() Feature type.
int	getFeatureWeight() Barrier weighting for features in the layer.
int	getLabelWeight() Barrier weighting for labels in the layer.
ILineLabelPlacementPriorities	getLineLabelPlacementPriorities() Line label placement position priority options.
ILineLabelPosition	getLineLabelPosition() Line label placement position options.
double	getLineOffset() Offset in map units at which labels will be placed away from line features.
double	getMaxDistanceFromTarget() Maximum distance in map units the label is allowed to be away from the feature.
int	getNumLabelsOption() Feature labeling option for the layer.
Object	getPointPlacementAngles() Point label placement angle(s).
int	getPointPlacementMethod() Point label placement method.
IPointPlacementPriorities	getPointPlacementPriorities() Point label placement position priority options.
int	getPolygonPlacementMethod() Polygon label placement method.
String	getRotationField() The attribute field that contains the label angle.
int	getRotationType() Defines the format is the rotation field in.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isBarrier() Indicates if features are treated as barriers to label/symbol placement.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isGenerateUnplacedLabels() Indicates if unplaced labels are generated.
boolean	isHasFeatureWeight() Indicates if the layer has a feature weight.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isPerpendicularToAngle() Indicates whether the label should be drawn perpendicular to the angle.
boolean	isPlaceLabels() Indicates if labels are placed for the layer.
boolean	isPlaceOnlyInsidePolygon() Indicates whether label is to be placed only within the polygon.
boolean	isPlaceSymbols() Indicates if symbols are placed for the layer.
boolean	isPointPlacementOnTop() Indicates if point labels are placed on top of features.
boolean	isTagUnplaced() Indicates if overflow labels are put into a graphics container tagged placed or unplaced.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setBufferRatio(double bufferRatio) Label buffer ratio.
void	setFeatureType(int type) Feature type.
void	setFeatureWeight(int weight) Barrier weighting for features in the layer.
void	setGenerateUnplacedLabels(boolean flag) Indicates if unplaced labels are generated.
void	setIsBarrier(boolean isBarrier) Indicates if features are treated as barriers to label/symbol placement.
void	setLabelWeight(int weight) Barrier weighting for labels in the layer.
void	setLineLabelPlacementPriorities(ILineLabelPlacementPriorities linePlacementPriorities) Line label placement position priority options.
void	setLineLabelPosition(ILineLabelPosition position) Line label placement position options.
void	setLineOffset(double lineOffset) Offset in map units at which labels will be placed away from line features.
void	setMaxDistanceFromTarget(double distance) Maximum distance in map units the label is allowed to be away from the feature.
void	setNumLabelsOption(int option) Feature labeling option for the layer.
void	setPerpendicularToAngle(boolean flag) Indicates whether the label should be drawn perpendicular to the angle.
void	setPlaceLabels(boolean place) Indicates if labels are placed for the layer.
void	setPlaceOnlyInsidePolygon(boolean flag) Indicates whether label is to be placed only within the polygon.
void	setPlaceSymbols(boolean place) Indicates if symbols are placed for the layer.
void	setPointPlacementAngles(Object angles) Point label placement angle(s).
void	setPointPlacementMethod(int method) Point label placement method.
void	setPointPlacementOnTop(boolean onTop) Indicates if point labels are placed on top of features.
void	setPointPlacementPriorities(IPointPlacementPriorities pointPlacementPriorities) Point label placement position priority options.
void	setPolygonPlacementMethod(int method) Polygon label placement method.
void	setRotationField(String field) The attribute field that contains the label angle.
void	setRotationType(int type) Defines the format is the rotation field in.
void	setTagUnplaced(boolean value) Indicates if overflow labels are put into a graphics container tagged placed or unplaced.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

BasicOverposterLayerProperties

public BasicOverposterLayerProperties()
                               throws IOException,
                                      UnknownHostException

Constructs a BasicOverposterLayerProperties using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

BasicOverposterLayerProperties

public BasicOverposterLayerProperties(Object obj)
                               throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicOverposterLayerProperties theBasicOverposterLayerProperties = (BasicOverposterLayerProperties) obj;

Construct a BasicOverposterLayerProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BasicOverposterLayerProperties.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getFeatureType

public int getFeatureType()
                   throws IOException,
                          AutomationException

Feature type.

Description

FeatureType is the type of feature, defined by esriBasicOverposterFeatureType (point, line or polygon), being labeled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureType in interface IBasicOverposterLayerProperties

Specified by:

getFeatureType in interface IBasicOverposterLayerProperties2

Specified by:

getFeatureType in interface IBasicOverposterLayerProperties3

Specified by:

getFeatureType in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriBasicOverposterFeatureType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureType

public void setFeatureType(int type)
                    throws IOException,
                           AutomationException

Feature type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureType in interface IBasicOverposterLayerProperties

Specified by:

setFeatureType in interface IBasicOverposterLayerProperties2

Specified by:

setFeatureType in interface IBasicOverposterLayerProperties3

Specified by:

setFeatureType in interface IBasicOverposterLayerProperties4

Parameters:

type - A com.esri.arcgis.carto.esriBasicOverposterFeatureType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureWeight

public int getFeatureWeight()
                     throws IOException,
                            AutomationException

Barrier weighting for features in the layer.

Description

FeatureWeight is the weight assigned to features, defined by esriBasicOverposterWeight (none, low, medium, high). This determines whether or not labels, in this and other layers, can overlap features in this layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureWeight in interface IBasicOverposterLayerProperties

Specified by:

getFeatureWeight in interface IBasicOverposterLayerProperties2

Specified by:

getFeatureWeight in interface IBasicOverposterLayerProperties3

Specified by:

getFeatureWeight in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriBasicOverposterWeight constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureWeight

public void setFeatureWeight(int weight)
                      throws IOException,
                             AutomationException

Barrier weighting for features in the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureWeight in interface IBasicOverposterLayerProperties

Specified by:

setFeatureWeight in interface IBasicOverposterLayerProperties2

Specified by:

setFeatureWeight in interface IBasicOverposterLayerProperties3

Specified by:

setFeatureWeight in interface IBasicOverposterLayerProperties4

Parameters:

weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelWeight

public int getLabelWeight()
                   throws IOException,
                          AutomationException

Barrier weighting for labels in the layer.

Description

LabelWeight is the weight assigned to labels, defined by esriBasicOverposterWeight. This determines whether or not labels in other layers can overlap labels in this layer. All weight values except esriNoWeight are accepted by this property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelWeight in interface IBasicOverposterLayerProperties

Specified by:

getLabelWeight in interface IBasicOverposterLayerProperties2

Specified by:

getLabelWeight in interface IBasicOverposterLayerProperties3

Specified by:

getLabelWeight in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriBasicOverposterWeight constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelWeight

public void setLabelWeight(int weight)
                    throws IOException,
                           AutomationException

Barrier weighting for labels in the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelWeight in interface IBasicOverposterLayerProperties

Specified by:

setLabelWeight in interface IBasicOverposterLayerProperties2

Specified by:

setLabelWeight in interface IBasicOverposterLayerProperties3

Specified by:

setLabelWeight in interface IBasicOverposterLayerProperties4

Parameters:

weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumLabelsOption

public int getNumLabelsOption()
                       throws IOException,
                              AutomationException

Feature labeling option for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNumLabelsOption in interface IBasicOverposterLayerProperties

Specified by:

getNumLabelsOption in interface IBasicOverposterLayerProperties2

Specified by:

getNumLabelsOption in interface IBasicOverposterLayerProperties3

Specified by:

getNumLabelsOption in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriBasicNumLabelsOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumLabelsOption

public void setNumLabelsOption(int option)
                        throws IOException,
                               AutomationException

Feature labeling option for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNumLabelsOption in interface IBasicOverposterLayerProperties

Specified by:

setNumLabelsOption in interface IBasicOverposterLayerProperties2

Specified by:

setNumLabelsOption in interface IBasicOverposterLayerProperties3

Specified by:

setNumLabelsOption in interface IBasicOverposterLayerProperties4

Parameters:

option - A com.esri.arcgis.carto.esriBasicNumLabelsOption constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineLabelPosition

public ILineLabelPosition getLineLabelPosition()
                                        throws IOException,
                                               AutomationException

Line label placement position options.

Description

LineLabelPosition is the placement option(s) relative to line features.

Remarks

This is only used when the FeatureType is of type esriOverposterPolyline.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLineLabelPosition in interface IBasicOverposterLayerProperties

Specified by:

getLineLabelPosition in interface IBasicOverposterLayerProperties2

Specified by:

getLineLabelPosition in interface IBasicOverposterLayerProperties3

Specified by:

getLineLabelPosition in interface IBasicOverposterLayerProperties4

Returns:

A reference to a com.esri.arcgis.carto.ILineLabelPosition

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineLabelPosition

public void setLineLabelPosition(ILineLabelPosition position)
                          throws IOException,
                                 AutomationException

Line label placement position options.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLineLabelPosition in interface IBasicOverposterLayerProperties

Specified by:

setLineLabelPosition in interface IBasicOverposterLayerProperties2

Specified by:

setLineLabelPosition in interface IBasicOverposterLayerProperties3

Specified by:

setLineLabelPosition in interface IBasicOverposterLayerProperties4

Parameters:

position - A reference to a com.esri.arcgis.carto.ILineLabelPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineLabelPlacementPriorities

public ILineLabelPlacementPriorities getLineLabelPlacementPriorities()
                                                              throws IOException,
                                                                     AutomationException

Line label placement position priority options.

Description

LineLabelPlacementPriorities is the placement priorities relative to line features.

Remarks

This is only used when the FeatureType is of type esriOverposterPolyline.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLineLabelPlacementPriorities in interface IBasicOverposterLayerProperties

Specified by:

getLineLabelPlacementPriorities in interface IBasicOverposterLayerProperties2

Specified by:

getLineLabelPlacementPriorities in interface IBasicOverposterLayerProperties3

Specified by:

getLineLabelPlacementPriorities in interface IBasicOverposterLayerProperties4

Returns:

A reference to a com.esri.arcgis.carto.ILineLabelPlacementPriorities

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineLabelPlacementPriorities

public void setLineLabelPlacementPriorities(ILineLabelPlacementPriorities linePlacementPriorities)
                                     throws IOException,
                                            AutomationException

Line label placement position priority options.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLineLabelPlacementPriorities in interface IBasicOverposterLayerProperties

Specified by:

setLineLabelPlacementPriorities in interface IBasicOverposterLayerProperties2

Specified by:

setLineLabelPlacementPriorities in interface IBasicOverposterLayerProperties3

Specified by:

setLineLabelPlacementPriorities in interface IBasicOverposterLayerProperties4

Parameters:

linePlacementPriorities - A reference to a com.esri.arcgis.carto.ILineLabelPlacementPriorities (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGenerateUnplacedLabels

public boolean isGenerateUnplacedLabels()
                                 throws IOException,
                                        AutomationException

Indicates if unplaced labels are generated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isGenerateUnplacedLabels in interface IBasicOverposterLayerProperties

Specified by:

isGenerateUnplacedLabels in interface IBasicOverposterLayerProperties2

Specified by:

isGenerateUnplacedLabels in interface IBasicOverposterLayerProperties3

Specified by:

isGenerateUnplacedLabels in interface IBasicOverposterLayerProperties4

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGenerateUnplacedLabels

public void setGenerateUnplacedLabels(boolean flag)
                               throws IOException,
                                      AutomationException

Indicates if unplaced labels are generated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGenerateUnplacedLabels in interface IBasicOverposterLayerProperties

Specified by:

setGenerateUnplacedLabels in interface IBasicOverposterLayerProperties2

Specified by:

setGenerateUnplacedLabels in interface IBasicOverposterLayerProperties3

Specified by:

setGenerateUnplacedLabels in interface IBasicOverposterLayerProperties4

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointPlacementMethod

public int getPointPlacementMethod()
                            throws IOException,
                                   AutomationException

Point label placement method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPointPlacementMethod in interface IBasicOverposterLayerProperties

Specified by:

getPointPlacementMethod in interface IBasicOverposterLayerProperties2

Specified by:

getPointPlacementMethod in interface IBasicOverposterLayerProperties3

Specified by:

getPointPlacementMethod in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriOverposterPointPlacementMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointPlacementMethod

public void setPointPlacementMethod(int method)
                             throws IOException,
                                    AutomationException

Point label placement method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPointPlacementMethod in interface IBasicOverposterLayerProperties

Specified by:

setPointPlacementMethod in interface IBasicOverposterLayerProperties2

Specified by:

setPointPlacementMethod in interface IBasicOverposterLayerProperties3

Specified by:

setPointPlacementMethod in interface IBasicOverposterLayerProperties4

Parameters:

method - A com.esri.arcgis.carto.esriOverposterPointPlacementMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPointPlacementOnTop

public boolean isPointPlacementOnTop()
                              throws IOException,
                                     AutomationException

Indicates if point labels are placed on top of features.

Description

PointPlacementOnTop PointPlacementOnTop specifies whether or not labels are to be placed centered on top of point features.

Remarks

This is only used when the FeatureType is of type esriOverposterPoint.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPointPlacementOnTop in interface IBasicOverposterLayerProperties

Specified by:

isPointPlacementOnTop in interface IBasicOverposterLayerProperties2

Specified by:

isPointPlacementOnTop in interface IBasicOverposterLayerProperties3

Specified by:

isPointPlacementOnTop in interface IBasicOverposterLayerProperties4

Returns:

The onTop

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointPlacementOnTop

public void setPointPlacementOnTop(boolean onTop)
                            throws IOException,
                                   AutomationException

Indicates if point labels are placed on top of features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPointPlacementOnTop in interface IBasicOverposterLayerProperties

Specified by:

setPointPlacementOnTop in interface IBasicOverposterLayerProperties2

Specified by:

setPointPlacementOnTop in interface IBasicOverposterLayerProperties3

Specified by:

setPointPlacementOnTop in interface IBasicOverposterLayerProperties4

Parameters:

onTop - The onTop (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointPlacementPriorities

public IPointPlacementPriorities getPointPlacementPriorities()
                                                      throws IOException,
                                                             AutomationException

Point label placement position priority options.

Description

PointPlacementPriorities is the placement priorities relative to point features.

Remarks

This is only used when the FeatureType is of type esriOverposterPoint.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPointPlacementPriorities in interface IBasicOverposterLayerProperties

Specified by:

getPointPlacementPriorities in interface IBasicOverposterLayerProperties2

Specified by:

getPointPlacementPriorities in interface IBasicOverposterLayerProperties3

Specified by:

getPointPlacementPriorities in interface IBasicOverposterLayerProperties4

Returns:

A reference to a com.esri.arcgis.carto.IPointPlacementPriorities

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointPlacementPriorities

public void setPointPlacementPriorities(IPointPlacementPriorities pointPlacementPriorities)
                                 throws IOException,
                                        AutomationException

Point label placement position priority options.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPointPlacementPriorities in interface IBasicOverposterLayerProperties

Specified by:

setPointPlacementPriorities in interface IBasicOverposterLayerProperties2

Specified by:

setPointPlacementPriorities in interface IBasicOverposterLayerProperties3

Specified by:

setPointPlacementPriorities in interface IBasicOverposterLayerProperties4

Parameters:

pointPlacementPriorities - A reference to a com.esri.arcgis.carto.IPointPlacementPriorities (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointPlacementAngles

public Object getPointPlacementAngles()
                               throws IOException,
                                      AutomationException

Point label placement angle(s).

Description

PointPlacementAngles is an array of angle(s) at which labels are to be placed relative to point features.

Remarks

This is only used when the FeatureType is of type esriOverposterPoint.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPointPlacementAngles in interface IBasicOverposterLayerProperties

Specified by:

getPointPlacementAngles in interface IBasicOverposterLayerProperties2

Specified by:

getPointPlacementAngles in interface IBasicOverposterLayerProperties3

Specified by:

getPointPlacementAngles in interface IBasicOverposterLayerProperties4

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointPlacementAngles

public void setPointPlacementAngles(Object angles)
                             throws IOException,
                                    AutomationException

Point label placement angle(s).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPointPlacementAngles in interface IBasicOverposterLayerProperties

Specified by:

setPointPlacementAngles in interface IBasicOverposterLayerProperties2

Specified by:

setPointPlacementAngles in interface IBasicOverposterLayerProperties3

Specified by:

setPointPlacementAngles in interface IBasicOverposterLayerProperties4

Parameters:

angles - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferRatio

public double getBufferRatio()
                      throws IOException,
                             AutomationException

Label buffer ratio. A value of 1 means a buffer the size of the label height.

Description

BufferRatio is the ratio, expressed as fraction of text size, at which the label extent will be detected (effectively increasing/decreasing the available area around a label). Use this to avoid labels being placed to close to each other.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBufferRatio in interface IBasicOverposterLayerProperties

Specified by:

getBufferRatio in interface IBasicOverposterLayerProperties2

Specified by:

getBufferRatio in interface IBasicOverposterLayerProperties3

Specified by:

getBufferRatio in interface IBasicOverposterLayerProperties4

Returns:

The bufferRatio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferRatio

public void setBufferRatio(double bufferRatio)
                    throws IOException,
                           AutomationException

Label buffer ratio. A value of 1 means a buffer the size of the label height.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBufferRatio in interface IBasicOverposterLayerProperties

Specified by:

setBufferRatio in interface IBasicOverposterLayerProperties2

Specified by:

setBufferRatio in interface IBasicOverposterLayerProperties3

Specified by:

setBufferRatio in interface IBasicOverposterLayerProperties4

Parameters:

bufferRatio - The bufferRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineOffset

public double getLineOffset()
                     throws IOException,
                            AutomationException

Offset in map units at which labels will be placed away from line features.

Description

LineOffset is the offset, expressed in mapunits, at which labels will be placed away from line features.

Remarks

This is only used when the FeatureType is of type esriOverposterPolyline and when the LineLabelPosition is either Above, Below, Left or Right.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLineOffset in interface IBasicOverposterLayerProperties

Specified by:

getLineOffset in interface IBasicOverposterLayerProperties2

Specified by:

getLineOffset in interface IBasicOverposterLayerProperties3

Specified by:

getLineOffset in interface IBasicOverposterLayerProperties4

Returns:

The lineOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineOffset

public void setLineOffset(double lineOffset)
                   throws IOException,
                          AutomationException

Offset in map units at which labels will be placed away from line features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLineOffset in interface IBasicOverposterLayerProperties

Specified by:

setLineOffset in interface IBasicOverposterLayerProperties2

Specified by:

setLineOffset in interface IBasicOverposterLayerProperties3

Specified by:

setLineOffset in interface IBasicOverposterLayerProperties4

Parameters:

lineOffset - The lineOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxDistanceFromTarget

public double getMaxDistanceFromTarget()
                                throws IOException,
                                       AutomationException

Maximum distance in map units the label is allowed to be away from the feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxDistanceFromTarget in interface IBasicOverposterLayerProperties2

Specified by:

getMaxDistanceFromTarget in interface IBasicOverposterLayerProperties3

Specified by:

getMaxDistanceFromTarget in interface IBasicOverposterLayerProperties4

Returns:

The distance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxDistanceFromTarget

public void setMaxDistanceFromTarget(double distance)
                              throws IOException,
                                     AutomationException

Maximum distance in map units the label is allowed to be away from the feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxDistanceFromTarget in interface IBasicOverposterLayerProperties2

Specified by:

setMaxDistanceFromTarget in interface IBasicOverposterLayerProperties3

Specified by:

setMaxDistanceFromTarget in interface IBasicOverposterLayerProperties4

Parameters:

distance - The distance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationType

public int getRotationType()
                    throws IOException,
                           AutomationException

Defines the format is the rotation field in.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRotationType in interface IBasicOverposterLayerProperties3

Specified by:

getRotationType in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriLabelRotationType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationType

public void setRotationType(int type)
                     throws IOException,
                            AutomationException

Defines the format is the rotation field in.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRotationType in interface IBasicOverposterLayerProperties3

Specified by:

setRotationType in interface IBasicOverposterLayerProperties4

Parameters:

type - A com.esri.arcgis.carto.esriLabelRotationType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationField

public String getRotationField()
                        throws IOException,
                               AutomationException

The attribute field that contains the label angle.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRotationField in interface IBasicOverposterLayerProperties3

Specified by:

getRotationField in interface IBasicOverposterLayerProperties4

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationField

public void setRotationField(String field)
                      throws IOException,
                             AutomationException

The attribute field that contains the label angle.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRotationField in interface IBasicOverposterLayerProperties3

Specified by:

setRotationField in interface IBasicOverposterLayerProperties4

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPerpendicularToAngle

public boolean isPerpendicularToAngle()
                               throws IOException,
                                      AutomationException

Indicates whether the label should be drawn perpendicular to the angle.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPerpendicularToAngle in interface IBasicOverposterLayerProperties3

Specified by:

isPerpendicularToAngle in interface IBasicOverposterLayerProperties4

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerpendicularToAngle

public void setPerpendicularToAngle(boolean flag)
                             throws IOException,
                                    AutomationException

Indicates whether the label should be drawn perpendicular to the angle.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPerpendicularToAngle in interface IBasicOverposterLayerProperties3

Specified by:

setPerpendicularToAngle in interface IBasicOverposterLayerProperties4

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolygonPlacementMethod

public int getPolygonPlacementMethod()
                              throws IOException,
                                     AutomationException

Polygon label placement method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPolygonPlacementMethod in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriOverposterPolygonPlacementMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolygonPlacementMethod

public void setPolygonPlacementMethod(int method)
                               throws IOException,
                                      AutomationException

Polygon label placement method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPolygonPlacementMethod in interface IBasicOverposterLayerProperties4

Parameters:

method - A com.esri.arcgis.carto.esriOverposterPolygonPlacementMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlaceOnlyInsidePolygon

public boolean isPlaceOnlyInsidePolygon()
                                 throws IOException,
                                        AutomationException

Indicates whether label is to be placed only within the polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPlaceOnlyInsidePolygon in interface IBasicOverposterLayerProperties4

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlaceOnlyInsidePolygon

public void setPlaceOnlyInsidePolygon(boolean flag)
                               throws IOException,
                                      AutomationException

Indicates whether label is to be placed only within the polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPlaceOnlyInsidePolygon in interface IBasicOverposterLayerProperties4

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlaceLabels

public void setPlaceLabels(boolean place)
                    throws IOException,
                           AutomationException

Indicates if labels are placed for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPlaceLabels in interface IOverposterLayerProperties

Specified by:

setPlaceLabels in interface IOverposterLayerProperties2

Parameters:

place - The place (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlaceLabels

public boolean isPlaceLabels()
                      throws IOException,
                             AutomationException

Indicates if labels are placed for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPlaceLabels in interface IOverposterLayerProperties

Specified by:

isPlaceLabels in interface IOverposterLayerProperties2

Returns:

The place

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlaceSymbols

public void setPlaceSymbols(boolean place)
                     throws IOException,
                            AutomationException

Indicates if symbols are placed for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPlaceSymbols in interface IOverposterLayerProperties

Specified by:

setPlaceSymbols in interface IOverposterLayerProperties2

Parameters:

place - The place (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlaceSymbols

public boolean isPlaceSymbols()
                       throws IOException,
                              AutomationException

Indicates if symbols are placed for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPlaceSymbols in interface IOverposterLayerProperties

Specified by:

isPlaceSymbols in interface IOverposterLayerProperties2

Returns:

The place

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsBarrier

public void setIsBarrier(boolean isBarrier)
                  throws IOException,
                         AutomationException

Indicates if features are treated as barriers to label/symbol placement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsBarrier in interface IOverposterLayerProperties

Specified by:

setIsBarrier in interface IOverposterLayerProperties2

Parameters:

isBarrier - The isBarrier (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBarrier

public boolean isBarrier()
                  throws IOException,
                         AutomationException

Indicates if features are treated as barriers to label/symbol placement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isBarrier in interface IOverposterLayerProperties

Specified by:

isBarrier in interface IOverposterLayerProperties2

Returns:

The isBarrier

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTagUnplaced

public boolean isTagUnplaced()
                      throws IOException,
                             AutomationException

Indicates if overflow labels are put into a graphics container tagged placed or unplaced.

Remarks

This property specifies whether or not unplaced labels are drawn for this label class. Setting TagUnplaced to True specifies that unplaced labels will not be drawn. Setting it to False specifies that they will be drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isTagUnplaced in interface IOverposterLayerProperties2

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTagUnplaced

public void setTagUnplaced(boolean value)
                    throws IOException,
                           AutomationException

Indicates if overflow labels are put into a graphics container tagged placed or unplaced.

Remarks

This property specifies whether or not unplaced labels are drawn for this label class. Setting TagUnplaced to True specifies that unplaced labels will not be drawn. Setting it to False specifies that they will be drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTagUnplaced in interface IOverposterLayerProperties2

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasFeatureWeight

public boolean isHasFeatureWeight()
                           throws IOException,
                                  AutomationException

Indicates if the layer has a feature weight.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isHasFeatureWeight in interface IOverposterLayerProperties2

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException