com.esri.arcgis.carto
Class BasicPlacedObject

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

All Implemented Interfaces:

IPlacedObject, IPlacedObject2, IPlacedObject3, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class BasicPlacedObject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPlacedObject, IPlacedObject2, IPlacedObject3

Placed object handed out by the standard label engine.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

BasicPlacedObject(Object obj)
Construct a BasicPlacedObject using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
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.
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.
String	getPlacementMessage() Placement result message.
int	hashCode() the hashcode for this object
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(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(String message) Placement result message.

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

BasicPlacedObject

public BasicPlacedObject(Object obj)
                  throws IOException

Construct a BasicPlacedObject using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BasicPlacedObject.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
BasicPlacedObject o = (BasicPlacedObject)obj; // will not work

BasicPlacedObject o = new BasicPlacedObject(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems BasicPlacedObject theBasicPlacedObject = (BasicPlacedObject) obj;

Method Detail

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

getObjectType

public int getObjectType()
                  throws IOException,
                         AutomationException

Type of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getObjectType in interface IPlacedObject

Specified by:

getObjectType in interface IPlacedObject2

Specified by:

getObjectType in interface IPlacedObject3

Returns:

A com.esri.arcgis.carto.esriPlacedObjectType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectType

public void setObjectType(int type)
                   throws IOException,
                          AutomationException

Type of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setObjectType in interface IPlacedObject

Specified by:

setObjectType in interface IPlacedObject2

Specified by:

setObjectType in interface IPlacedObject3

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureId

public int getFeatureId()
                 throws IOException,
                        AutomationException

FeatureID associated with the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureId in interface IPlacedObject

Specified by:

getFeatureId in interface IPlacedObject2

Specified by:

getFeatureId in interface IPlacedObject3

Returns:

The featureId

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureId

public void setFeatureId(int featureId)
                  throws IOException,
                         AutomationException

FeatureID associated with the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureId in interface IPlacedObject

Specified by:

setFeatureId in interface IPlacedObject2

Specified by:

setFeatureId in interface IPlacedObject3

Parameters:

featureId - The featureId (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getControlShape

public IGeometry getControlShape()
                          throws IOException,
                                 AutomationException

Control shape of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getControlShape in interface IPlacedObject

Specified by:

getControlShape in interface IPlacedObject2

Specified by:

getControlShape in interface IPlacedObject3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setControlShape

public void setControlShape(IGeometry shape)
                     throws IOException,
                            AutomationException

Control shape of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setControlShape in interface IPlacedObject

Specified by:

setControlShape in interface IPlacedObject2

Specified by:

setControlShape in interface IPlacedObject3

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException

Labeling string for the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabel in interface IPlacedObject

Specified by:

getLabel in interface IPlacedObject2

Specified by:

getLabel in interface IPlacedObject3

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException

Labeling string for the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabel in interface IPlacedObject

Specified by:

setLabel in interface IPlacedObject2

Specified by:

setLabel in interface IPlacedObject3

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassIndex

public int getClassIndex()
                  throws IOException,
                         AutomationException

Class index of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassIndex in interface IPlacedObject

Specified by:

getClassIndex in interface IPlacedObject2

Specified by:

getClassIndex in interface IPlacedObject3

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassIndex

public void setClassIndex(int index)
                   throws IOException,
                          AutomationException

Class index of the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClassIndex in interface IPlacedObject

Specified by:

setClassIndex in interface IPlacedObject2

Specified by:

setClassIndex in interface IPlacedObject3

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlacementCode

public int getPlacementCode()
                     throws IOException,
                            AutomationException

Code that indicates success/failure of placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPlacementCode in interface IPlacedObject

Specified by:

getPlacementCode in interface IPlacedObject2

Specified by:

getPlacementCode in interface IPlacedObject3

Returns:

A com.esri.arcgis.carto.esriPlacementCode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlacementCode

public void setPlacementCode(int placementCode)
                      throws IOException,
                             AutomationException

Code that indicates success/failure of placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPlacementCode in interface IPlacedObject

Specified by:

setPlacementCode in interface IPlacedObject2

Specified by:

setPlacementCode in interface IPlacedObject3

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlacementMessage

public String getPlacementMessage()
                           throws IOException,
                                  AutomationException

Placement result message.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPlacementMessage in interface IPlacedObject

Specified by:

getPlacementMessage in interface IPlacedObject2

Specified by:

getPlacementMessage in interface IPlacedObject3

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlacementMessage

public void setPlacementMessage(String message)
                         throws IOException,
                                AutomationException

Placement result message.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPlacementMessage in interface IPlacedObject

Specified by:

setPlacementMessage in interface IPlacedObject2

Specified by:

setPlacementMessage in interface IPlacedObject3

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

public double getAngle()
                throws IOException,
                       AutomationException

Angle for the placed object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAngle in interface IPlacedObject

Specified by:

getAngle in interface IPlacedObject2

Specified by:

getAngle in interface IPlacedObject3

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getControlShapeEndPoint

public _WKSPoint getControlShapeEndPoint()
                                  throws IOException,
                                         AutomationException

The end point of the control shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getControlShapeEndPoint in interface IPlacedObject2

Specified by:

getControlShapeEndPoint in interface IPlacedObject3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelWidth

public double getLabelWidth()
                     throws IOException,
                            AutomationException

Width of the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelWidth in interface IPlacedObject2

Specified by:

getLabelWidth in interface IPlacedObject3

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelHeight

public double getLabelHeight()
                      throws IOException,
                             AutomationException

Height of the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelHeight in interface IPlacedObject2

Specified by:

getLabelHeight in interface IPlacedObject3

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaCentroid

public _WKSPoint getAreaCentroid()
                          throws IOException,
                                 AutomationException

The centroid of the polygon shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaCentroid in interface IPlacedObject3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelInsidePolygon

public boolean isLabelInsidePolygon()
                             throws IOException,
                                    AutomationException

Indicates whether the label is completely inside the polygons.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isLabelInsidePolygon in interface IPlacedObject3

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.