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, java.io.Externalizable, java.io.Serializable

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

COM Class 'BasicOverposterLayerProperties'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Controls the placement of labels or symbols relative to features using conflict detection.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IBasicOverposterLayerProperties

IID, IID3141f2fb_38e2_11d1_8809_080009ec732a, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IBasicOverposterLayerProperties2

IID, IID6cc4facb_5f13_418a_bf24_d2c61d56fe66, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IBasicOverposterLayerProperties3

IID, IID7bdbb1ec_e951_4058_8140_d5cd88556613, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IBasicOverposterLayerProperties4

IID, IIDf64b3a44_c14c_4b12_994f_ae72196eec56, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IOverposterLayerProperties

IID, IID3141f2f7_38e2_11d1_8809_080009ec732a, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IOverposterLayerProperties2

IID, IIDc1e3c2fd_dcc1_4f7e_be2d_2f989b0b7e6a, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

BasicOverposterLayerProperties()
Constructs a BasicOverposterLayerProperties using ArcGIS Engine.

BasicOverposterLayerProperties(java.lang.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(java.lang.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 java.lang.String	getClsid() getClsid.
int	getFeatureType() Feature type.
int	getFeatureWeight() Barrier weighting for features in the layer.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
java.lang.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.
java.lang.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(java.io.ObjectInput in)
void	release() Release a BasicOverposterLayerProperties.
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(java.lang.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(java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

BasicOverposterLayerProperties

public BasicOverposterLayerProperties()
                               throws java.io.IOException,
                                      java.net.UnknownHostException

Constructs a BasicOverposterLayerProperties using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

BasicOverposterLayerProperties

public BasicOverposterLayerProperties(java.lang.Object obj)
                               throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a BasicOverposterLayerProperties.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getFeatureType

public int getFeatureType()
                   throws java.io.IOException,
                          AutomationException

Feature type.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureType

public void setFeatureType(int type)
                    throws java.io.IOException,
                           AutomationException

Feature type.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureWeight

public int getFeatureWeight()
                     throws java.io.IOException,
                            AutomationException

Barrier weighting for features in the layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureWeight

public void setFeatureWeight(int weight)
                      throws java.io.IOException,
                             AutomationException

Barrier weighting for features in the layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelWeight

public int getLabelWeight()
                   throws java.io.IOException,
                          AutomationException

Barrier weighting for labels in the layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelWeight

public void setLabelWeight(int weight)
                    throws java.io.IOException,
                           AutomationException

Barrier weighting for labels in the layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumLabelsOption

public int getNumLabelsOption()
                       throws java.io.IOException,
                              AutomationException

Feature labeling option for the layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumLabelsOption

public void setNumLabelsOption(int option)
                        throws java.io.IOException,
                               AutomationException

Feature labeling option for the layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineLabelPosition

public ILineLabelPosition getLineLabelPosition()
                                        throws java.io.IOException,
                                               AutomationException

Line label placement position options.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineLabelPosition

public void setLineLabelPosition(ILineLabelPosition position)
                          throws java.io.IOException,
                                 AutomationException

Line label placement position options.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineLabelPlacementPriorities

public ILineLabelPlacementPriorities getLineLabelPlacementPriorities()
                                                              throws java.io.IOException,
                                                                     AutomationException

Line label placement position priority options.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineLabelPlacementPriorities

public void setLineLabelPlacementPriorities(ILineLabelPlacementPriorities linePlacementPriorities)
                                     throws java.io.IOException,
                                            AutomationException

Line label placement position priority options.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGenerateUnplacedLabels

public boolean isGenerateUnplacedLabels()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if unplaced labels are generated.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGenerateUnplacedLabels

public void setGenerateUnplacedLabels(boolean flag)
                               throws java.io.IOException,
                                      AutomationException

Indicates if unplaced labels are generated.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointPlacementMethod

public int getPointPlacementMethod()
                            throws java.io.IOException,
                                   AutomationException

Point label placement method.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointPlacementMethod

public void setPointPlacementMethod(int method)
                             throws java.io.IOException,
                                    AutomationException

Point label placement method.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPointPlacementOnTop

public boolean isPointPlacementOnTop()
                              throws java.io.IOException,
                                     AutomationException

Indicates if point labels are placed on top of features.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointPlacementOnTop

public void setPointPlacementOnTop(boolean onTop)
                            throws java.io.IOException,
                                   AutomationException

Indicates if point labels are placed on top of features.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointPlacementPriorities

public IPointPlacementPriorities getPointPlacementPriorities()
                                                      throws java.io.IOException,
                                                             AutomationException

Point label placement position priority options.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointPlacementPriorities

public void setPointPlacementPriorities(IPointPlacementPriorities pointPlacementPriorities)
                                 throws java.io.IOException,
                                        AutomationException

Point label placement position priority options.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointPlacementAngles

public java.lang.Object getPointPlacementAngles()
                                         throws java.io.IOException,
                                                AutomationException

Point label placement angle(s).

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointPlacementAngles

public void setPointPlacementAngles(java.lang.Object angles)
                             throws java.io.IOException,
                                    AutomationException

Point label placement angle(s).

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferRatio

public double getBufferRatio()
                      throws java.io.IOException,
                             AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferRatio

public void setBufferRatio(double bufferRatio)
                    throws java.io.IOException,
                           AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineOffset

public double getLineOffset()
                     throws java.io.IOException,
                            AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineOffset

public void setLineOffset(double lineOffset)
                   throws java.io.IOException,
                          AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxDistanceFromTarget

public double getMaxDistanceFromTarget()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

getMaxDistanceFromTarget in interface IBasicOverposterLayerProperties2

Specified by:

getMaxDistanceFromTarget in interface IBasicOverposterLayerProperties3

Specified by:

getMaxDistanceFromTarget in interface IBasicOverposterLayerProperties4

Returns:

The distance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxDistanceFromTarget

public void setMaxDistanceFromTarget(double distance)
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

setMaxDistanceFromTarget in interface IBasicOverposterLayerProperties2

Specified by:

setMaxDistanceFromTarget in interface IBasicOverposterLayerProperties3

Specified by:

setMaxDistanceFromTarget in interface IBasicOverposterLayerProperties4

Parameters:

distance - The distance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationType

public int getRotationType()
                    throws java.io.IOException,
                           AutomationException

Defines the format is the rotation field in.

Specified by:

getRotationType in interface IBasicOverposterLayerProperties3

Specified by:

getRotationType in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriLabelRotationType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationType

public void setRotationType(int type)
                     throws java.io.IOException,
                            AutomationException

Defines the format is the rotation field in.

Specified by:

setRotationType in interface IBasicOverposterLayerProperties3

Specified by:

setRotationType in interface IBasicOverposterLayerProperties4

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationField

public java.lang.String getRotationField()
                                  throws java.io.IOException,
                                         AutomationException

The attribute field that contains the label angle.

Specified by:

getRotationField in interface IBasicOverposterLayerProperties3

Specified by:

getRotationField in interface IBasicOverposterLayerProperties4

Returns:

The field

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationField

public void setRotationField(java.lang.String field)
                      throws java.io.IOException,
                             AutomationException

The attribute field that contains the label angle.

Specified by:

setRotationField in interface IBasicOverposterLayerProperties3

Specified by:

setRotationField in interface IBasicOverposterLayerProperties4

Parameters:

field - The field (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPerpendicularToAngle

public boolean isPerpendicularToAngle()
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

isPerpendicularToAngle in interface IBasicOverposterLayerProperties3

Specified by:

isPerpendicularToAngle in interface IBasicOverposterLayerProperties4

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerpendicularToAngle

public void setPerpendicularToAngle(boolean flag)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setPerpendicularToAngle in interface IBasicOverposterLayerProperties3

Specified by:

setPerpendicularToAngle in interface IBasicOverposterLayerProperties4

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolygonPlacementMethod

public int getPolygonPlacementMethod()
                              throws java.io.IOException,
                                     AutomationException

Polygon label placement method.

Specified by:

getPolygonPlacementMethod in interface IBasicOverposterLayerProperties4

Returns:

A com.esri.arcgis.carto.esriOverposterPolygonPlacementMethod constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolygonPlacementMethod

public void setPolygonPlacementMethod(int method)
                               throws java.io.IOException,
                                      AutomationException

Polygon label placement method.

Specified by:

setPolygonPlacementMethod in interface IBasicOverposterLayerProperties4

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlaceOnlyInsidePolygon

public boolean isPlaceOnlyInsidePolygon()
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:

isPlaceOnlyInsidePolygon in interface IBasicOverposterLayerProperties4

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlaceOnlyInsidePolygon

public void setPlaceOnlyInsidePolygon(boolean flag)
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

setPlaceOnlyInsidePolygon in interface IBasicOverposterLayerProperties4

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlaceLabels

public void setPlaceLabels(boolean place)
                    throws java.io.IOException,
                           AutomationException

Indicates if labels are placed for the layer.

Specified by:

setPlaceLabels in interface IOverposterLayerProperties

Specified by:

setPlaceLabels in interface IOverposterLayerProperties2

Parameters:

place - The place (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlaceLabels

public boolean isPlaceLabels()
                      throws java.io.IOException,
                             AutomationException

Indicates if labels are placed for the layer.

Specified by:

isPlaceLabels in interface IOverposterLayerProperties

Specified by:

isPlaceLabels in interface IOverposterLayerProperties2

Returns:

The place

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlaceSymbols

public void setPlaceSymbols(boolean place)
                     throws java.io.IOException,
                            AutomationException

Indicates if symbols are placed for the layer.

Specified by:

setPlaceSymbols in interface IOverposterLayerProperties

Specified by:

setPlaceSymbols in interface IOverposterLayerProperties2

Parameters:

place - The place (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlaceSymbols

public boolean isPlaceSymbols()
                       throws java.io.IOException,
                              AutomationException

Indicates if symbols are placed for the layer.

Specified by:

isPlaceSymbols in interface IOverposterLayerProperties

Specified by:

isPlaceSymbols in interface IOverposterLayerProperties2

Returns:

The place

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsBarrier

public void setIsBarrier(boolean isBarrier)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

setIsBarrier in interface IOverposterLayerProperties

Specified by:

setIsBarrier in interface IOverposterLayerProperties2

Parameters:

isBarrier - The isBarrier (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBarrier

public boolean isBarrier()
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

isBarrier in interface IOverposterLayerProperties

Specified by:

isBarrier in interface IOverposterLayerProperties2

Returns:

The isBarrier

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTagUnplaced

public boolean isTagUnplaced()
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

isTagUnplaced in interface IOverposterLayerProperties2

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTagUnplaced

public void setTagUnplaced(boolean value)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setTagUnplaced in interface IOverposterLayerProperties2

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasFeatureWeight

public boolean isHasFeatureWeight()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the layer has a feature weight.

Specified by:

isHasFeatureWeight in interface IOverposterLayerProperties2

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException