com.esri.arcgis.carto
Interface IPlacedObject3

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasicPlacedObject, IPlacedObject3Proxy

public interface IPlacedObject3
extends java.io.Serializable

COM Interface 'IPlacedObject3'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members work with symbols that are placed as labels.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID2f68dd01_d7e6_4e21_8ef9_14165ef00552
static int	xxDummy Deprecated. Internal use only

Method Summary

double	getAngle() Angle for the placed object.
_WKSPoint	getAreaCentroid() The centroid of the polygon shape.
int	getClassIndex() Class index of the placed object.
IGeometry	getControlShape() Control shape of the placed object.
_WKSPoint	getControlShapeEndPoint() The end point of the control shape.
int	getFeatureId() FeatureID associated with the placed object.
java.lang.String	getLabel() Labeling string for the placed object.
double	getLabelHeight() Height of the label.
double	getLabelWidth() Width of the label.
int	getObjectType() Type of the placed object.
int	getPlacementCode() Code that indicates success/failure of placement.
java.lang.String	getPlacementMessage() Placement result message.
boolean	isLabelInsidePolygon() Indicates whether the label is completely inside the polygons.
void	setClassIndex(int index) Class index of the placed object.
void	setControlShape(IGeometry shape) Control shape of the placed object.
void	setFeatureId(int featureId) FeatureID associated with the placed object.
void	setLabel(java.lang.String label) Labeling string for the placed object.
void	setObjectType(int type) Type of the placed object.
void	setPlacementCode(int placementCode) Code that indicates success/failure of placement.
void	setPlacementMessage(java.lang.String message) Placement result message.

Field Detail

IID2f68dd01_d7e6_4e21_8ef9_14165ef00552

static final int IID2f68dd01_d7e6_4e21_8ef9_14165ef00552

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getObjectType

int getObjectType()
                  throws java.io.IOException,
                         AutomationException

Type of the placed object.

Returns:

A com.esri.arcgis.carto.esriPlacedObjectType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setObjectType

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

Type of the placed object.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureId

int getFeatureId()
                 throws java.io.IOException,
                        AutomationException

FeatureID associated with the placed object.

Returns:

The featureId

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureId

void setFeatureId(int featureId)
                  throws java.io.IOException,
                         AutomationException

FeatureID associated with the placed object.

Parameters:

featureId - The featureId (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getControlShape

IGeometry getControlShape()
                          throws java.io.IOException,
                                 AutomationException

Control shape of the placed object.

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setControlShape

void setControlShape(IGeometry shape)
                     throws java.io.IOException,
                            AutomationException

Control shape of the placed object.

Parameters:

shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException

Labeling string for the placed object.

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Labeling string for the placed object.

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassIndex

int getClassIndex()
                  throws java.io.IOException,
                         AutomationException

Class index of the placed object.

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClassIndex

void setClassIndex(int index)
                   throws java.io.IOException,
                          AutomationException

Class index of the placed object.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlacementCode

int getPlacementCode()
                     throws java.io.IOException,
                            AutomationException

Code that indicates success/failure of placement.

Returns:

A com.esri.arcgis.carto.esriPlacementCode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPlacementCode

void setPlacementCode(int placementCode)
                      throws java.io.IOException,
                             AutomationException

Code that indicates success/failure of placement.

Parameters:

placementCode - A com.esri.arcgis.carto.esriPlacementCode constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlacementMessage

java.lang.String getPlacementMessage()
                                     throws java.io.IOException,
                                            AutomationException

Placement result message.

Returns:

The message

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPlacementMessage

void setPlacementMessage(java.lang.String message)
                         throws java.io.IOException,
                                AutomationException

Placement result message.

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAngle

double getAngle()
                throws java.io.IOException,
                       AutomationException

Angle for the placed object.

Returns:

The angle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getControlShapeEndPoint

_WKSPoint getControlShapeEndPoint()
                                  throws java.io.IOException,
                                         AutomationException

The end point of the control shape.

Returns:

A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelWidth

double getLabelWidth()
                     throws java.io.IOException,
                            AutomationException

Width of the label.

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelHeight

double getLabelHeight()
                      throws java.io.IOException,
                             AutomationException

Height of the label.

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaCentroid

_WKSPoint getAreaCentroid()
                          throws java.io.IOException,
                                 AutomationException

The centroid of the polygon shape.

Returns:

A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLabelInsidePolygon

boolean isLabelInsidePolygon()
                             throws java.io.IOException,
                                    AutomationException

Indicates whether the label is completely inside the polygons.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.