com.esri.arcgis.location
Class HatchLayerExtension

java.lang.Object
  com.esri.arcgis.location.HatchLayerExtension

All Implemented Interfaces:

ILayerExtensionDraw, ILayerExtensionInvalidate, com.esri.arcgis.interop.RemoteObjRef, IHatchLayerExtension, IClone, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class HatchLayerExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IHatchLayerExtension, ILayerExtensionDraw, ILayerExtensionInvalidate, IPersistStream, IPersist, IClone, ISupportErrorInfo, Externalizable

Hatch layer extension manages a collection of hatch classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

HatchLayerExtension()
Constructs a HatchLayerExtension using ArcGIS Engine.

HatchLayerExtension(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HatchLayerExtension theHatchLayerExtension = (HatchLayerExtension) obj;

Method Summary

void	addClass(String name, IHatchClass hatchClass) Adds a class to the hatch extension.
void	afterLayerDraw(ILayer pLayer, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel) Drawing event called after layer draws.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	beforeLayerDraw(ILayer pLayer, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel) Drawing event called before layer draws.
void	convertToGraphics(IFeatureLayer pFLayer, IGraphicsLayer pGraphicsLayer, IDisplay pDisplay) Converts hatches to graphics.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
IHatchClass	hatchClass(String name) The hatch class at the specified index.
int	hatchClassCount() The number of hatch classes.
Object	hatchClassNames() String array of class names.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	invalidateVisibleExtent() Indicates whether map should refresh visible extent for layer.
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	isShowHatches() Indicates whether to show hatches.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	removeAll() Removes all classes from the hatch extension.
void	removeClass(String name) Removes a class from the hatch extension.
void	save(IStream pstm, int fClearDirty) save
void	setShowHatches(boolean pshowHatches) Indicates whether to show hatches.
void	writeExternal(ObjectOutput out)

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

HatchLayerExtension

public HatchLayerExtension()
                    throws IOException,
                           UnknownHostException

Constructs a HatchLayerExtension using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

HatchLayerExtension

public HatchLayerExtension(Object obj)
                    throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

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

setShowHatches

public void setShowHatches(boolean pshowHatches)
                    throws IOException,
                           AutomationException

Indicates whether to show hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowHatches in interface IHatchLayerExtension

Parameters:

pshowHatches - The pshowHatches (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowHatches

public boolean isShowHatches()
                      throws IOException,
                             AutomationException

Indicates whether to show hatches.

Remarks

The ShowHatches property (as boolean) indicates whether to show hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowHatches in interface IHatchLayerExtension

Returns:

The pshowHatches

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hatchClassCount

public int hatchClassCount()
                    throws IOException,
                           AutomationException

The number of hatch classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

hatchClassCount in interface IHatchLayerExtension

Returns:

The hatchClassCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hatchClass

public IHatchClass hatchClass(String name)
                       throws IOException,
                              AutomationException

The hatch class at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

hatchClass in interface IHatchLayerExtension

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.location.IHatchClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addClass

public void addClass(String name,
                     IHatchClass hatchClass)
              throws IOException,
                     AutomationException

Adds a class to the hatch extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addClass in interface IHatchLayerExtension

Parameters:

name - The name (in)

hatchClass - A reference to a com.esri.arcgis.location.IHatchClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hatchClassNames

public Object hatchClassNames()
                       throws IOException,
                              AutomationException

String array of class names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

hatchClassNames in interface IHatchLayerExtension

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeClass

public void removeClass(String name)
                 throws IOException,
                        AutomationException

Removes a class from the hatch extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeClass in interface IHatchLayerExtension

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all classes from the hatch extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAll in interface IHatchLayerExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToGraphics

public void convertToGraphics(IFeatureLayer pFLayer,
                              IGraphicsLayer pGraphicsLayer,
                              IDisplay pDisplay)
                       throws IOException,
                              AutomationException

Converts hatches to graphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

convertToGraphics in interface IHatchLayerExtension

Parameters:

pFLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

pGraphicsLayer - A reference to a com.esri.arcgis.carto.IGraphicsLayer (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeLayerDraw

public void beforeLayerDraw(ILayer pLayer,
                            int drawPhase,
                            IDisplay pDisplay,
                            ITrackCancel pTrackCancel)
                     throws IOException,
                            AutomationException

Drawing event called before layer draws.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

beforeLayerDraw in interface ILayerExtensionDraw

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterLayerDraw

public void afterLayerDraw(ILayer pLayer,
                           int drawPhase,
                           IDisplay pDisplay,
                           ITrackCancel pTrackCancel)
                    throws IOException,
                           AutomationException

Drawing event called after layer draws.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterLayerDraw in interface ILayerExtensionDraw

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

invalidateVisibleExtent

public boolean invalidateVisibleExtent()
                                throws IOException,
                                       AutomationException

Indicates whether map should refresh visible extent for layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

invalidateVisibleExtent in interface ILayerExtensionInvalidate

Returns:

The pInvalidateVisibleExtent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException