com.esri.arcgis.carto
Class ACRasterShieldSymbol

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

All Implemented Interfaces:

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

public class ACRasterShieldSymbol

extends java.lang.Object

implements IACAxl, IACSymbol, IACRasterShieldSymbol, IPersist, IPersistStream, IClone

ArcIMS Raster Shield Symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACRasterShieldSymbol()
Constructs a ACRasterShieldSymbol using ArcGIS Engine.

ACRasterShieldSymbol(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.
IACRasterShieldSymbol	getAsIACRasterShieldSymbol() 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.
java.lang.String	getFont() The font name.
IColor	getFontColor() The font color.
int	getFontSize() The font size.
int	getFontStyle() The font style.
java.lang.String	getImage() The path to the image.
int	getLabelMode() The label mode.
int	getPrintMode() The print mode.
IColor	getShadowColor() The shadow color.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
IPoint	getTextPosition() The text position on the bitmap.
double	getTransparency() The transparency in percent (0-100).
java.lang.String	getURL() The url to access the image.
int	hashCode() the hashcode for this object
boolean	isAntialiasing() Indicates if the antialias is ON or OFF.
boolean	isBoundary() Indicates if a boundary is drawn.
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	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	setBoundary(boolean flag) Indicates if a boundary is drawn.
void	setElementByRef(java.lang.Object element) The element that represents the XML.
void	setFont(java.lang.String font) The font name.
void	setFontColor(IColor color) The font color.
void	setFontSize(int fontSize) The font size.
void	setFontStyle(int fontStyle) The font style.
void	setImage(java.lang.String path) The path to the image.
void	setLabelMode(int labelMode) The label mode.
void	setPrintMode(int printMode) The print mode.
void	setShadow(boolean flag) Indicates if the shadow is used.
void	setShadowColor(IColor color) The shadow color.
void	setTextPosition(IPoint point) The text position on the bitmap.
void	setTransparency(double trans) The transparency in percent (0-100).
void	setURL(java.lang.String uRL) The url to access the image.

Methods inherited from class java.lang.Object

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

Constructor Detail

ACRasterShieldSymbol

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

Constructs a ACRasterShieldSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACRasterShieldSymbol

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

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

Construct a ACRasterShieldSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ACRasterShieldSymbol.
ACRasterShieldSymbol theACRasterShieldSymbol = (ACRasterShieldSymbol) 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.

getAsIACRasterShieldSymbol

public IACRasterShieldSymbol getAsIACRasterShieldSymbol()

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: IACRasterShieldSymbol

The url to access the image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getURL in interface IACRasterShieldSymbol

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: IACRasterShieldSymbol

The url to access the image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setURL in interface IACRasterShieldSymbol

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: IACRasterShieldSymbol

The path to the image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getImage in interface IACRasterShieldSymbol

Returns:

The path

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setImage

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

Description copied from interface: IACRasterShieldSymbol

The path to the image.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setImage in interface IACRasterShieldSymbol

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFont

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

Description copied from interface: IACRasterShieldSymbol

The font name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFont in interface IACRasterShieldSymbol

Returns:

The font

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFont

public void setFont(java.lang.String font)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IACRasterShieldSymbol

The font name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFont in interface IACRasterShieldSymbol

Parameters:

font - The font (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFontStyle

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

Description copied from interface: IACRasterShieldSymbol

The font style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontStyle in interface IACRasterShieldSymbol

Returns:

A com.esri.arcgis.carto.acFontStyle constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFontStyle

public void setFontStyle(int fontStyle)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACRasterShieldSymbol

The font style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFontStyle in interface IACRasterShieldSymbol

Parameters:

fontStyle - A com.esri.arcgis.carto.acFontStyle constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFontSize

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

Description copied from interface: IACRasterShieldSymbol

The font size.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontSize in interface IACRasterShieldSymbol

Returns:

The fontSize

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFontSize

public void setFontSize(int fontSize)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACRasterShieldSymbol

The font size.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFontSize in interface IACRasterShieldSymbol

Parameters:

fontSize - The fontSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFontColor

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

Description copied from interface: IACRasterShieldSymbol

The font color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontColor in interface IACRasterShieldSymbol

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFontColor

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

Description copied from interface: IACRasterShieldSymbol

The font color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFontColor in interface IACRasterShieldSymbol

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (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: IACRasterShieldSymbol

Indicates if the shadow is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShadow in interface IACRasterShieldSymbol

Returns:

The flag

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setShadow

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

Description copied from interface: IACRasterShieldSymbol

Indicates if the shadow is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadow in interface IACRasterShieldSymbol

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: IACRasterShieldSymbol

The shadow color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShadowColor in interface IACRasterShieldSymbol

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShadowColor

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

Description copied from interface: IACRasterShieldSymbol

The shadow color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadowColor in interface IACRasterShieldSymbol

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrintMode

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

Description copied from interface: IACRasterShieldSymbol

The print mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPrintMode in interface IACRasterShieldSymbol

Returns:

A com.esri.arcgis.carto.acPrintMode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrintMode

public void setPrintMode(int printMode)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACRasterShieldSymbol

The print mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPrintMode in interface IACRasterShieldSymbol

Parameters:

printMode - A com.esri.arcgis.carto.acPrintMode constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTextPosition

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

Description copied from interface: IACRasterShieldSymbol

The text position on the bitmap.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTextPosition in interface IACRasterShieldSymbol

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setTextPosition

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

Description copied from interface: IACRasterShieldSymbol

The text position on the bitmap.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTextPosition in interface IACRasterShieldSymbol

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getLabelMode

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

Description copied from interface: IACRasterShieldSymbol

The label mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelMode in interface IACRasterShieldSymbol

Returns:

A com.esri.arcgis.carto.acLabelMode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelMode

public void setLabelMode(int labelMode)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACRasterShieldSymbol

The label mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelMode in interface IACRasterShieldSymbol

Parameters:

labelMode - A com.esri.arcgis.carto.acLabelMode constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBoundary

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

Description copied from interface: IACRasterShieldSymbol

Indicates if a boundary is drawn.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isBoundary in interface IACRasterShieldSymbol

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBoundary

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

Description copied from interface: IACRasterShieldSymbol

Indicates if a boundary is drawn.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBoundary in interface IACRasterShieldSymbol

Parameters:

flag - The flag (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.