com.esri.arcgis.display
Class LineStroke

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

All Implemented Interfaces:

IDrawingOutline, IGraphicAttributes, IGraphicAttributes2, ILineStroke, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class LineStroke
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILineStroke, IGraphicAttributes, IGraphicAttributes2, IDrawingOutline, IPersist, IPersistStream, ISupportErrorInfo, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'A line stroke 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.ILineStroke

IID, IID84f0a9dd_8b74_4b84_bd38_5eee0154cd34, 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.IDrawingOutline

IID, IID5b50cf13_4f70_4bed_b1b7_55f3aa8d26f8, 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.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

LineStroke()
Constructs a LineStroke using ArcGIS Engine.

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

Method Summary

java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	draw(IOutputContext context, IGeometry geometry, IEnvelope envelope) Draws the line stroke.
boolean	equals(java.lang.Object o) Compare this object with another
IGeometry	getAllOutlineParts(IGeometry geometry, int type, int option, double buffer, IEnvelope clipEnvelope) Constructs the entire drawing outline of a drawing rule.
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.
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
boolean	hitTest(IGeometry geometry, IPoint point, double tolerance) Tests if a point is located on the drawing outline.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
IGeometry	nextOutlinePart() Retrieves the next part of the outline.
void	readExternal(java.io.ObjectInput in)
void	release() Release a LineStroke.
void	reset(IGeometry geometry, int type, int option, double buffer, IEnvelope clipEnvelope) Resets the outline part enumeration.
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

LineStroke

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

Constructs a LineStroke using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LineStroke

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

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

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

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

Specified by:

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

draw

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

Draws the line stroke.

Specified by:

draw in interface ILineStroke

Parameters:

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

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (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.

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.

hitTest

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

Tests if a point is located on the drawing outline.

Specified by:

hitTest in interface IDrawingOutline

Parameters:

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

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(IGeometry geometry,
                                    int type,
                                    int option,
                                    double buffer,
                                    IEnvelope clipEnvelope)
                             throws java.io.IOException,
                                    AutomationException

Constructs the entire drawing outline of a drawing rule.

Specified by:

getAllOutlineParts in interface IDrawingOutline

Parameters:

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

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(IGeometry geometry,
                  int type,
                  int option,
                  double buffer,
                  IEnvelope clipEnvelope)
           throws java.io.IOException,
                  AutomationException

Resets the outline part enumeration.

Specified by:

reset in interface IDrawingOutline

Parameters:

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

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

Retrieves the next part of the outline.

Specified by:

nextOutlinePart in interface IDrawingOutline

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

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