com.esri.arcgis.location
Class HatchMarkerDefinition

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IHatchDefinition, IHatchMarkerDefinition, IClone, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class HatchMarkerDefinition
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IHatchDefinition, IHatchMarkerDefinition, IPersistStream, IPersist, IClone, ISupportErrorInfo, Externalizable

Hatch using a marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

HatchMarkerDefinition()
Constructs a HatchMarkerDefinition using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
int	getAlignment() The hatch alignment.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getDisplayPrecision() The display precision.
String	getExpression() The Expression.
int	getExpressionParserEngine() The Expression Parser Engine.
ISymbol	getHatchSymbol() The hatch symbol.
double	getOffset() The offset.
String	getPrefix() The prefix.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getSuffix() The suffix.
int	getTextDisplay() Text display setting for the style.
ITextSymbol	getTextSymbol() The text symbol.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAdjustTextOrientation() Indicates whether to adjust text orientation.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isExpressionSimple() Indicates whether the expression is simple.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isShowSign() Indicates whether to show negative sign in hatch text for negative M values.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setAdjustTextOrientation(boolean pAdjustTextOrientation) Indicates whether to adjust text orientation.
void	setAlignment(int pAlignment) The hatch alignment.
void	setDisplayPrecision(int pDisplayPrecision) The display precision.
void	setExpression(String expression) The Expression.
void	setExpressionParserEngine(int parserEngine) The Expression Parser Engine.
void	setExpressionSimple(boolean expressionSimple) Indicates whether the expression is simple.
void	setHatchSymbolByRef(ISymbol ppSymbol) The hatch symbol.
void	setOffset(double pAngle) The offset.
void	setPrefix(String pPrefix) The prefix.
void	setShowSign(boolean pShowSign) Indicates whether to show negative sign in hatch text for negative M values.
void	setSuffix(String pSuffix) The suffix.
void	setTextDisplay(int display) Text display setting for the style.
void	setTextSymbolByRef(ITextSymbol ppSymbol) The text symbol.
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

HatchMarkerDefinition

public HatchMarkerDefinition()
                      throws IOException,
                             UnknownHostException

Constructs a HatchMarkerDefinition using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

HatchMarkerDefinition

public HatchMarkerDefinition(Object obj)
                      throws IOException

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

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

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

getHatchSymbol

public ISymbol getHatchSymbol()
                       throws IOException,
                              AutomationException

The hatch symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHatchSymbol in interface IHatchDefinition

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchSymbolByRef

public void setHatchSymbolByRef(ISymbol ppSymbol)
                         throws IOException,
                                AutomationException

The hatch symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHatchSymbolByRef in interface IHatchDefinition

Parameters:

ppSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

public double getOffset()
                 throws IOException,
                        AutomationException

The offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOffset in interface IHatchDefinition

Returns:

The pAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

public void setOffset(double pAngle)
               throws IOException,
                      AutomationException

The offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOffset in interface IHatchDefinition

Parameters:

pAngle - The pAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextDisplay

public void setTextDisplay(int display)
                    throws IOException,
                           AutomationException

Text display setting for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTextDisplay in interface IHatchDefinition

Parameters:

display - A com.esri.arcgis.location.esriHatchTextDisplay constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextDisplay

public int getTextDisplay()
                   throws IOException,
                          AutomationException

Text display setting for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTextDisplay in interface IHatchDefinition

Returns:

A com.esri.arcgis.location.esriHatchTextDisplay constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

The text symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTextSymbol in interface IHatchDefinition

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol ppSymbol)
                        throws IOException,
                               AutomationException

The text symbol.

Product Availability

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

Specified by:

setTextSymbolByRef in interface IHatchDefinition

Parameters:

ppSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayPrecision

public int getDisplayPrecision()
                        throws IOException,
                               AutomationException

The display precision.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDisplayPrecision in interface IHatchDefinition

Returns:

The pDisplayPrecision

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayPrecision

public void setDisplayPrecision(int pDisplayPrecision)
                         throws IOException,
                                AutomationException

The display precision.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayPrecision in interface IHatchDefinition

Parameters:

pDisplayPrecision - The pDisplayPrecision (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowSign

public void setShowSign(boolean pShowSign)
                 throws IOException,
                        AutomationException

Indicates whether to show negative sign in hatch text for negative M values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowSign in interface IHatchDefinition

Parameters:

pShowSign - The pShowSign (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowSign

public boolean isShowSign()
                   throws IOException,
                          AutomationException

Indicates whether to show negative sign in hatch text for negative M values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowSign in interface IHatchDefinition

Returns:

The pShowSign

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrefix

public String getPrefix()
                 throws IOException,
                        AutomationException

The prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPrefix in interface IHatchDefinition

Returns:

The pPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrefix

public void setPrefix(String pPrefix)
               throws IOException,
                      AutomationException

The prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPrefix in interface IHatchDefinition

Parameters:

pPrefix - The pPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSuffix

public String getSuffix()
                 throws IOException,
                        AutomationException

The suffix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSuffix in interface IHatchDefinition

Returns:

The pSuffix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuffix

public void setSuffix(String pSuffix)
               throws IOException,
                      AutomationException

The suffix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSuffix in interface IHatchDefinition

Parameters:

pSuffix - The pSuffix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpression

public String getExpression()
                     throws IOException,
                            AutomationException

The Expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExpression in interface IHatchDefinition

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

public void setExpression(String expression)
                   throws IOException,
                          AutomationException

The Expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExpression in interface IHatchDefinition

Parameters:

expression - The expression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionSimple

public void setExpressionSimple(boolean expressionSimple)
                         throws IOException,
                                AutomationException

Indicates whether the expression is simple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExpressionSimple in interface IHatchDefinition

Parameters:

expressionSimple - The expressionSimple (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpressionSimple

public boolean isExpressionSimple()
                           throws IOException,
                                  AutomationException

Indicates whether the expression is simple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isExpressionSimple in interface IHatchDefinition

Returns:

The expressionSimple

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpressionParserEngine

public int getExpressionParserEngine()
                              throws IOException,
                                     AutomationException

The Expression Parser Engine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExpressionParserEngine in interface IHatchDefinition

Returns:

A com.esri.arcgis.location.esriHatchExpressionEngine constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionParserEngine

public void setExpressionParserEngine(int parserEngine)
                               throws IOException,
                                      AutomationException

The Expression Parser Engine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExpressionParserEngine in interface IHatchDefinition

Parameters:

parserEngine - A com.esri.arcgis.location.esriHatchExpressionEngine constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdjustTextOrientation

public void setAdjustTextOrientation(boolean pAdjustTextOrientation)
                              throws IOException,
                                     AutomationException

Indicates whether to adjust text orientation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAdjustTextOrientation in interface IHatchDefinition

Parameters:

pAdjustTextOrientation - The pAdjustTextOrientation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAdjustTextOrientation

public boolean isAdjustTextOrientation()
                                throws IOException,
                                       AutomationException

Indicates whether to adjust text orientation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAdjustTextOrientation in interface IHatchDefinition

Returns:

The pAdjustTextOrientation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlignment

public int getAlignment()
                 throws IOException,
                        AutomationException

The hatch alignment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAlignment in interface IHatchDefinition

Returns:

A com.esri.arcgis.location.esriHatchAlignmentType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignment

public void setAlignment(int pAlignment)
                  throws IOException,
                         AutomationException

The hatch alignment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAlignment in interface IHatchDefinition

Parameters:

pAlignment - A com.esri.arcgis.location.esriHatchAlignmentType constant (in)

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