com.esri.arcgis.display
Class RepresentationMarker

java.lang.Object
  com.esri.arcgis.display.RepresentationMarker

All Implemented Interfaces:

IGraphicsOutline, IRepresentationGraphics, IRepresentationMarker, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class RepresentationMarker
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRepresentationMarker, IRepresentationGraphics, IGraphicsOutline, IPersist, IPersistStream, IClone, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'RepresentationMarker'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'A representation marker object.' 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.display.IRepresentationMarker

IID, IIDdd9693df_153c_4290_a5ea_c4cf9e818724, xxDummy

Fields inherited from interface com.esri.arcgis.display.IRepresentationGraphics

IID, IIDb3eb5501_8998_498f_9b38_05caeb8d8599, xxDummy

Fields inherited from interface com.esri.arcgis.display.IGraphicsOutline

IID, IID2af790ad_4539_43c8_870e_fa75a50b9988, 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

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

RepresentationMarker()
Constructs a RepresentationMarker using ArcGIS Engine.

RepresentationMarker(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RepresentationMarker theRepresentationMarker = (RepresentationMarker) obj;

Method Summary

void	add(IGeometry geometry, IRepresentationRule repRule) Adds a new component in a representation graphic.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	changeGeometry(int iD, IGeometry geometry) Changes a geometry in a representation graphic.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	draw(IOutputContext context, IAffineTransformation2D transfo, IEnvelope envelope) Draws the representation marker.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IGeometry	getAllOutlineParts(int type, int option, double buffer, IEnvelope clipEnvelope) Constructs the entire drawing outline of a graphics.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
double	getHeight() The height in points (1/72 of an inch) of the marker.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IGeometry	getOutline(int type) The outline of the marker, returned as a polygon.
double	getSize() The size in points (1/72 of an inch) of the marker.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getWidth() The width in points (1/72 of an inch) of the marker.
int	hashCode() the hashcode for this object
boolean	hitTest(IPoint point, double tolerance) Tests if a point is located on the graphics outline.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	next(IGeometry[] geometry, IRepresentationRule[] repRule) Retrieves the next component in a representation graphic.
void	nextGeometry(int[] iD, IGeometry[] geometry) Accesses the next geometry in a representation graphic.
IGeometry	nextOutlinePart() Hands back the next drawing outline part.
void	readExternal(java.io.ObjectInput in)
void	release() Release a RepresentationMarker.
void	remove(IGeometry geometry, IRepresentationRule repRule) Removes a component in a representation graphic.
void	removeAll() Removes all components in a representation graphic.
void	reset() Resets the enumeration of components in a representation graphic.
void	reset(int type, int option, double buffer, IEnvelope clipEnvelope) Resets the collection of drawing outline parts to the beginning, before calling NextOutlinePart.
void	resetGeometry() Resets the geometry enumeration in a representation graphic.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
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

RepresentationMarker

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

Constructs a RepresentationMarker using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RepresentationMarker

public RepresentationMarker(java.lang.Object obj)
                     throws java.io.IOException

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

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

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 RepresentationMarker.

Specified by:

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

draw

public void draw(IOutputContext context,
                 IAffineTransformation2D transfo,
                 IEnvelope envelope)
          throws java.io.IOException,
                 AutomationException

Draws the representation marker.

Specified by:

draw in interface IRepresentationMarker

Parameters:

context - A reference to a com.esri.arcgis.display.IOutputContext (in)

transfo - A reference to a com.esri.arcgis.geometry.IAffineTransformation2D (in)

envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutline

public IGeometry getOutline(int type)
                     throws java.io.IOException,
                            AutomationException

The outline of the marker, returned as a polygon.

Specified by:

getOutline in interface IRepresentationMarker

Parameters:

type - A com.esri.arcgis.display.esriOutlineType constant (in)

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.

getSize

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

The size in points (1/72 of an inch) of the marker.

Specified by:

getSize in interface IRepresentationMarker

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

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

The width in points (1/72 of an inch) of the marker.

Specified by:

getWidth in interface IRepresentationMarker

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

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

The height in points (1/72 of an inch) of the marker.

Specified by:

getHeight in interface IRepresentationMarker

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Resets the enumeration of components in a representation graphic.

Specified by:

reset in interface IRepresentationGraphics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

next

public void next(IGeometry[] geometry,
                 IRepresentationRule[] repRule)
          throws java.io.IOException,
                 AutomationException

Retrieves the next component in a representation graphic.

Specified by:

next in interface IRepresentationGraphics

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IGeometry geometry,
                IRepresentationRule repRule)
         throws java.io.IOException,
                AutomationException

Adds a new component in a representation graphic.

Specified by:

add in interface IRepresentationGraphics

Parameters:

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

repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(IGeometry geometry,
                   IRepresentationRule repRule)
            throws java.io.IOException,
                   AutomationException

Removes a component in a representation graphic.

Specified by:

remove in interface IRepresentationGraphics

Parameters:

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

repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all components in a representation graphic.

Specified by:

removeAll in interface IRepresentationGraphics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetGeometry

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

Resets the geometry enumeration in a representation graphic.

Specified by:

resetGeometry in interface IRepresentationGraphics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

nextGeometry

public void nextGeometry(int[] iD,
                         IGeometry[] geometry)
                  throws java.io.IOException,
                         AutomationException

Accesses the next geometry in a representation graphic.

Specified by:

nextGeometry in interface IRepresentationGraphics

Parameters:

iD - The iD (out: use single element array)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

changeGeometry

public void changeGeometry(int iD,
                           IGeometry geometry)
                    throws java.io.IOException,
                           AutomationException

Changes a geometry in a representation graphic.

Specified by:

changeGeometry in interface IRepresentationGraphics

Parameters:

iD - The iD (in)

geometry - 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.

hitTest

public boolean hitTest(IPoint point,
                       double tolerance)
                throws java.io.IOException,
                       AutomationException

Tests if a point is located on the graphics outline.

Specified by:

hitTest in interface IGraphicsOutline

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

The hit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllOutlineParts

public IGeometry getAllOutlineParts(int type,
                                    int option,
                                    double buffer,
                                    IEnvelope clipEnvelope)
                             throws java.io.IOException,
                                    AutomationException

Constructs the entire drawing outline of a graphics.

Specified by:

getAllOutlineParts in interface IGraphicsOutline

Parameters:

type - A com.esri.arcgis.display.esriOutlineType constant (in)

option - A com.esri.arcgis.display.esriOutlineOption constant (in)

buffer - The buffer (in)

clipEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

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.

reset

public void reset(int type,
                  int option,
                  double buffer,
                  IEnvelope clipEnvelope)
           throws java.io.IOException,
                  AutomationException

Resets the collection of drawing outline parts to the beginning, before calling NextOutlinePart. To be used when drawing outline of a graphics is accessed part by part.

Specified by:

reset in interface IGraphicsOutline

Parameters:

type - A com.esri.arcgis.display.esriOutlineType constant (in)

option - A com.esri.arcgis.display.esriOutlineOption constant (in)

buffer - The buffer (in)

clipEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

nextOutlinePart

public IGeometry nextOutlinePart()
                          throws java.io.IOException,
                                 AutomationException

Hands back the next drawing outline part. It is necessary to call the Reset method before iterating with the NextOutlinePart method.

Specified by:

nextOutlinePart in interface IGraphicsOutline

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.

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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