com.esri.arcgis.carto
Class ACRasterMarkerSymbol

java.lang.Object
  com.esri.arcgis.carto.ACRasterMarkerSymbol

All Implemented Interfaces:

IACAxl, IACRasterMarkerSymbol, IACSymbol, IClone, IPersist, IPersistStream, java.io.Serializable

public class ACRasterMarkerSymbol

extends java.lang.Object

implements IACAxl, IACSymbol, IACRasterMarkerSymbol, IPersist, IPersistStream, IClone

ArcIMS Raster Marker Symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACRasterMarkerSymbol()
Constructs a ACRasterMarkerSymbol using ArcGIS Engine.

ACRasterMarkerSymbol(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IACAxl	getAsIACAxl() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACRasterMarkerSymbol	getAsIACRasterMarkerSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACSymbol	getAsIACSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
java.lang.Object	getElement() The element that represents the XML.
int	getHeight() The height of the bitmap in pixels.
IPoint	getHotSpot() The hotspot of the bitmap.
java.lang.String	getImage() The path to the image.
IColor	getShadowColor() The shadow color.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
double	getTransparency() The transparency in percent (0-100).
java.lang.String	getURL() The url to access the image.
int	getWidth() The width of the bitmap in pixels.
int	hashCode() the hashcode for this object
boolean	isAntialiasing() Indicates if the antialias is ON or OFF.
void	isDirty() Supported Platforms
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isIdentical(IClone other) Returns TRUE when the receiver and other are the same object.
boolean	isOverlap() Indicates if labels can overlap this symbol.
boolean	isShadow() Indicates if the shadow is used.
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setAntialiasing(boolean flag) Indicates if the antialias is ON or OFF.
void	setElementByRef(java.lang.Object element) The element that represents the XML.
void	setHeight(int height) The height of the bitmap in pixels.
void	setHotSpot(IPoint point) The hotspot of the bitmap.
void	setImage(java.lang.String path) The path to the image.
void	setOverlap(boolean flag) Indicates if labels can overlap this symbol.
void	setShadow(boolean flag) Indicates if the shadow is used.
void	setShadowColor(IColor color) The shadow color.
void	setTransparency(double trans) The transparency in percent (0-100).
void	setURL(java.lang.String uRL) The url to access the image.
void	setWidth(int width) The width of the bitmap in pixels.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ACRasterMarkerSymbol

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

Constructs a ACRasterMarkerSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACRasterMarkerSymbol

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a ACRasterMarkerSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ACRasterMarkerSymbol.
ACRasterMarkerSymbol theACRasterMarkerSymbol = (ACRasterMarkerSymbol) obj;

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()

getAsIACAxl

public IACAxl getAsIACAxl()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACSymbol

public IACSymbol getAsIACSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACRasterMarkerSymbol

public IACRasterMarkerSymbol getAsIACRasterMarkerSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getElement

public java.lang.Object getElement()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IACAxl

The element that represents the XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getElement in interface IACAxl

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElementByRef

public void setElementByRef(java.lang.Object element)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACAxl

The element that represents the XML.

Specified by:

setElementByRef in interface IACAxl

Parameters:

element - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparency

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

Description copied from interface: IACSymbol

The transparency in percent (0-100).

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransparency in interface IACSymbol

Returns:

The trans

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setTransparency

public void setTransparency(double trans)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACSymbol

The transparency in percent (0-100).

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparency in interface IACSymbol

Parameters:

trans - The trans (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isAntialiasing

public boolean isAntialiasing()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IACSymbol

Indicates if the antialias is ON or OFF.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAntialiasing in interface IACSymbol

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAntialiasing

public void setAntialiasing(boolean flag)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACSymbol

Indicates if the antialias is ON or OFF.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAntialiasing in interface IACSymbol

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getURL

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

Description copied from interface: IACRasterMarkerSymbol

The url to access the image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getURL in interface IACRasterMarkerSymbol

Returns:

The uRL

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setURL

public void setURL(java.lang.String uRL)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IACRasterMarkerSymbol

The url to access the image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setURL in interface IACRasterMarkerSymbol

Parameters:

uRL - The uRL (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImage

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

Description copied from interface: IACRasterMarkerSymbol

The path to the image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getImage in interface IACRasterMarkerSymbol

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setImage

public void setImage(java.lang.String path)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IACRasterMarkerSymbol

The path to the image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setImage in interface IACRasterMarkerSymbol

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOverlap

public boolean isOverlap()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACRasterMarkerSymbol

Indicates if labels can overlap this symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOverlap in interface IACRasterMarkerSymbol

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverlap

public void setOverlap(boolean flag)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IACRasterMarkerSymbol

Indicates if labels can overlap this symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOverlap in interface IACRasterMarkerSymbol

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWidth

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

Description copied from interface: IACRasterMarkerSymbol

The width of the bitmap in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface IACRasterMarkerSymbol

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int width)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IACRasterMarkerSymbol

The width of the bitmap in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWidth in interface IACRasterMarkerSymbol

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

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

Description copied from interface: IACRasterMarkerSymbol

The height of the bitmap in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHeight in interface IACRasterMarkerSymbol

Returns:

The height

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setHeight

public void setHeight(int height)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IACRasterMarkerSymbol

The height of the bitmap in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHeight in interface IACRasterMarkerSymbol

Parameters:

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHotSpot

public IPoint getHotSpot()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACRasterMarkerSymbol

The hotspot of the bitmap.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHotSpot in interface IACRasterMarkerSymbol

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHotSpot

public void setHotSpot(IPoint point)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IACRasterMarkerSymbol

The hotspot of the bitmap.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHotSpot in interface IACRasterMarkerSymbol

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShadow

public boolean isShadow()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACRasterMarkerSymbol

Indicates if the shadow is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShadow in interface IACRasterMarkerSymbol

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShadow

public void setShadow(boolean flag)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IACRasterMarkerSymbol

Indicates if the shadow is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadow in interface IACRasterMarkerSymbol

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getShadowColor

public IColor getShadowColor()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IACRasterMarkerSymbol

The shadow color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShadowColor in interface IACRasterMarkerSymbol

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setShadowColor

public void setShadowColor(IColor color)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACRasterMarkerSymbol

The shadow color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadowColor in interface IACRasterMarkerSymbol

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

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

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when 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:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when 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:

AutomationException - If the ArcObject component throws an exception.

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