com.esri.arcgis.display
Class GeometricEffectJog

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

All Implemented Interfaces:

IEditInteraction, IGeometricEffect, IGraphicAttributes, IGraphicAttributes2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class GeometricEffectJog
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeometricEffect, IGraphicAttributes, IGraphicAttributes2, IEditInteraction, IPersist, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'Constructs an Jog effect on a given line.' 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.IGeometricEffect

IID, IIDa5a4ca1c_1164_4dc4_ae82_5611a8f807e5, xxDummy

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

IID, IID7c843a64_dbfa_4de9_9cc9_0414cb2c68ba, xxDummy

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

IID7200f877_d9f9_4b54_940e_1e3a68363e2d

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

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

Constructor Summary

GeometricEffectJog()
Constructs a GeometricEffectJog using ArcGIS Engine.

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

Method Summary

java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCaption(int attrId) Caption of the graphic attribute.
java.lang.String	getClassCaption(int geomType) Caption of the object containing the graphic attributes.
void	getClassID(GUID[] pClassID) getClassID
java.lang.String	getClassName() Class name of the graphic attribute.
static java.lang.String	getClsid() getClsid.
int	getGraphicAttributeCount() Number of graphic attributes.
int	getID(int attrIndex) ID of graphic attributes.
int	getIDByName(java.lang.String name) ID of the graphic attribute, given its name.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName(int attrId) Name of the graphic attribute.
int	getOutputType(int inputType) The output type of the geometric effect.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IGraphicAttributeType	getType(int attrId) Type of the graphic attribute.
java.lang.Object	getValue(int attrId) Value of the graphic attribute.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEditableAttribute(java.lang.Object editParams, int attrIndex) Indicates if a graphic attribute is editable by a representation tool.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	modifyAttributes(java.lang.Object editParams, java.lang.Object attrArray) Modifies the graphic attributes according to the editing parameters of the representation tool.
IGeometry	nextGeometry() Accesses the next geometry generated by th effect.
void	readExternal(java.io.ObjectInput in)
void	release() Release a GeometricEffectJog.
void	reset(IGeometry geometry) Resets the collection of generated geometries.
void	save(IStream pstm, int fClearDirty) save
void	setValue(int attrId, java.lang.Object val) Value of the graphic attribute.
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

GeometricEffectJog

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

Constructs a GeometricEffectJog using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GeometricEffectJog

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

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

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

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

Specified by:

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

getOutputType

public int getOutputType(int inputType)
                  throws java.io.IOException,
                         AutomationException

The output type of the geometric effect.

Specified by:

getOutputType in interface IGeometricEffect

Parameters:

inputType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Resets the collection of generated geometries. Must be called before using NextGeometry.

Specified by:

reset in interface IGeometricEffect

Parameters:

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.

nextGeometry

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

Accesses the next geometry generated by th effect.

Specified by:

nextGeometry in interface IGeometricEffect

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.

getGraphicAttributeCount

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

Number of graphic attributes.

Specified by:

getGraphicAttributeCount in interface IGraphicAttributes

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

public int getID(int attrIndex)
          throws java.io.IOException,
                 AutomationException

ID of graphic attributes.

Specified by:

getID in interface IGraphicAttributes

Parameters:

attrIndex - The attrIndex (in)

Returns:

The attrId

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName(int attrId)
                         throws java.io.IOException,
                                AutomationException

Name of the graphic attribute.

Specified by:

getName in interface IGraphicAttributes

Parameters:

attrId - The attrId (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public IGraphicAttributeType getType(int attrId)
                              throws java.io.IOException,
                                     AutomationException

Type of the graphic attribute.

Specified by:

getType in interface IGraphicAttributes

Parameters:

attrId - The attrId (in)

Returns:

A reference to a com.esri.arcgis.display.IGraphicAttributeType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

public java.lang.Object getValue(int attrId)
                          throws java.io.IOException,
                                 AutomationException

Value of the graphic attribute. To erase override, set value to NULL or to original value.

Specified by:

getValue in interface IGraphicAttributes

Parameters:

attrId - The attrId (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int attrId,
                     java.lang.Object val)
              throws java.io.IOException,
                     AutomationException

Value of the graphic attribute. To erase override, set value to NULL or to original value.

Specified by:

setValue in interface IGraphicAttributes

Parameters:

attrId - The attrId (in)

val - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIDByName

public int getIDByName(java.lang.String name)
                throws java.io.IOException,
                       AutomationException

ID of the graphic attribute, given its name.

Specified by:

getIDByName in interface IGraphicAttributes

Parameters:

name - The name (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassName

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

Class name of the graphic attribute.

Specified by:

getClassName in interface IGraphicAttributes

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCaption

public java.lang.String getCaption(int attrId)
                            throws java.io.IOException,
                                   AutomationException

Caption of the graphic attribute.

Specified by:

getCaption in interface IGraphicAttributes2

Parameters:

attrId - The attrId (in)

Returns:

The caption

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassCaption

public java.lang.String getClassCaption(int geomType)
                                 throws java.io.IOException,
                                        AutomationException

Caption of the object containing the graphic attributes.

Specified by:

getClassCaption in interface IGraphicAttributes2

Parameters:

geomType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Returns:

The caption

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEditableAttribute

public boolean isEditableAttribute(java.lang.Object editParams,
                                   int attrIndex)
                            throws java.io.IOException,
                                   AutomationException

Indicates if a graphic attribute is editable by a representation tool.

Specified by:

isEditableAttribute in interface IEditInteraction

Parameters:

editParams - A Variant (in)

attrIndex - The attrIndex (in)

Returns:

The isEditable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

modifyAttributes

public void modifyAttributes(java.lang.Object editParams,
                             java.lang.Object attrArray)
                      throws java.io.IOException,
                             AutomationException

Modifies the graphic attributes according to the editing parameters of the representation tool.

Specified by:

modifyAttributes in interface IEditInteraction

Parameters:

editParams - A Variant (in)

attrArray - A Variant (in)

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.

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.

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