com.esri.arcgis.carto
Class IPlacedObject2Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IPlacedObject2Proxy
All Implemented Interfaces:
IPlacedObject2, Externalizable, Serializable

public class IPlacedObject2Proxy
extends com.esri.arcgis.interop.Dispatch
implements IPlacedObject2, Serializable

Provides access to members work with symbols that are placed as labels.

Superseded By

IPlacedObject3

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IPlacedObject2Proxy()
           
  IPlacedObject2Proxy(Object obj)
           
protected IPlacedObject2Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 double getAngle()
          Angle for the placed object.
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 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.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IPlacedObject2Proxy

public IPlacedObject2Proxy()

IPlacedObject2Proxy

public IPlacedObject2Proxy(Object obj)
                    throws IOException
Throws:
IOException

IPlacedObject2Proxy

protected IPlacedObject2Proxy(Object obj,
                              String iid)
                       throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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 IPlacedObject2
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
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
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
Returns:
The height
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
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException