com.esri.arcgis.carto
Class ACRasterShieldSymbol

java.lang.Object
  extended by com.esri.arcgis.carto.ACRasterShieldSymbol
All Implemented Interfaces:
IACAxl, IACRasterShieldSymbol, IACSymbol, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class ACRasterShieldSymbol
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IACAxl, IACSymbol, IACRasterShieldSymbol, IPersist, IPersistStream, IClone, Externalizable

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(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ACRasterShieldSymbol theACRasterShieldSymbol = (ACRasterShieldSymbol) 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.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 Object getElement()
          The element that represents the XML.
 String getFont()
          The font name.
 IColor getFontColor()
          The font color.
 int getFontSize()
          The font size.
 int getFontStyle()
          The font style.
 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)
          getSizeMax
 IPoint getTextPosition()
          The text position on the bitmap.
 double getTransparency()
          The transparency in percent (0-100).
 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()
          isDirty
 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)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setAntialiasing(boolean flag)
          Indicates if the antialias is ON or OFF.
 void setBoundary(boolean flag)
          Indicates if a boundary is drawn.
 void setElementByRef(Object element)
          The element that represents the XML.
 void setFont(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(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(String uRL)
          The url to access the image.
 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

ACRasterShieldSymbol

public ACRasterShieldSymbol()
                     throws IOException,
                            UnknownHostException
Constructs a ACRasterShieldSymbol using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ACRasterShieldSymbol

public ACRasterShieldSymbol(Object obj)
                     throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ACRasterShieldSymbol theACRasterShieldSymbol = (ACRasterShieldSymbol) obj;

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.

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

getElement

public Object getElement()
                  throws IOException,
                         AutomationException
The element that represents the XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getElement in interface IACAxl
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElementByRef

public void setElementByRef(Object element)
                     throws IOException,
                            AutomationException
The element that represents the XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setElementByRef in interface IACAxl
Parameters:
element - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTransparency

public double getTransparency()
                       throws IOException,
                              AutomationException
The transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTransparency in interface IACSymbol
Returns:
The trans
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(double trans)
                     throws IOException,
                            AutomationException
The transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTransparency in interface IACSymbol
Parameters:
trans - The trans (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAntialiasing

public boolean isAntialiasing()
                       throws IOException,
                              AutomationException
Indicates if the antialias is ON or OFF.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAntialiasing in interface IACSymbol
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAntialiasing

public void setAntialiasing(boolean flag)
                     throws IOException,
                            AutomationException
Indicates if the antialias is ON or OFF.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAntialiasing in interface IACSymbol
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getURL

public String getURL()
              throws IOException,
                     AutomationException
The url to access the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getURL in interface IACRasterShieldSymbol
Returns:
The uRL
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setURL

public void setURL(String uRL)
            throws IOException,
                   AutomationException
The url to access the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setURL in interface IACRasterShieldSymbol
Parameters:
uRL - The uRL (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImage

public String getImage()
                throws IOException,
                       AutomationException
The path to the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getImage in interface IACRasterShieldSymbol
Returns:
The path
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImage

public void setImage(String path)
              throws IOException,
                     AutomationException
The path to the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setImage in interface IACRasterShieldSymbol
Parameters:
path - The path (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFont

public String getFont()
               throws IOException,
                      AutomationException
The font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFont in interface IACRasterShieldSymbol
Returns:
The font
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFont

public void setFont(String font)
             throws IOException,
                    AutomationException
The font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFont in interface IACRasterShieldSymbol
Parameters:
font - The font (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontStyle

public int getFontStyle()
                 throws IOException,
                        AutomationException
The font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFontStyle in interface IACRasterShieldSymbol
Returns:
A com.esri.arcgis.carto.acFontStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontStyle

public void setFontStyle(int fontStyle)
                  throws IOException,
                         AutomationException
The font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFontStyle in interface IACRasterShieldSymbol
Parameters:
fontStyle - A com.esri.arcgis.carto.acFontStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontSize

public int getFontSize()
                throws IOException,
                       AutomationException
The font size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFontSize in interface IACRasterShieldSymbol
Returns:
The fontSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontSize

public void setFontSize(int fontSize)
                 throws IOException,
                        AutomationException
The font size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFontSize in interface IACRasterShieldSymbol
Parameters:
fontSize - The fontSize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontColor

public IColor getFontColor()
                    throws IOException,
                           AutomationException
The font color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFontColor in interface IACRasterShieldSymbol
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontColor

public void setFontColor(IColor color)
                  throws IOException,
                         AutomationException
The font color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFontColor in interface IACRasterShieldSymbol
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShadow

public boolean isShadow()
                 throws IOException,
                        AutomationException
Indicates if the shadow is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isShadow in interface IACRasterShieldSymbol
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadow

public void setShadow(boolean flag)
               throws IOException,
                      AutomationException
Indicates if the shadow is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShadow in interface IACRasterShieldSymbol
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShadowColor

public IColor getShadowColor()
                      throws IOException,
                             AutomationException
The shadow color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getShadowColor in interface IACRasterShieldSymbol
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadowColor

public void setShadowColor(IColor color)
                    throws IOException,
                           AutomationException
The shadow color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShadowColor in interface IACRasterShieldSymbol
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrintMode

public int getPrintMode()
                 throws IOException,
                        AutomationException
The print mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPrintMode in interface IACRasterShieldSymbol
Returns:
A com.esri.arcgis.carto.acPrintMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrintMode

public void setPrintMode(int printMode)
                  throws IOException,
                         AutomationException
The print mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPrintMode in interface IACRasterShieldSymbol
Parameters:
printMode - A com.esri.arcgis.carto.acPrintMode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextPosition

public IPoint getTextPosition()
                       throws IOException,
                              AutomationException
The text position on the bitmap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTextPosition in interface IACRasterShieldSymbol
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextPosition

public void setTextPosition(IPoint point)
                     throws IOException,
                            AutomationException
The text position on the bitmap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTextPosition in interface IACRasterShieldSymbol
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelMode

public int getLabelMode()
                 throws IOException,
                        AutomationException
The label mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelMode in interface IACRasterShieldSymbol
Returns:
A com.esri.arcgis.carto.acLabelMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelMode

public void setLabelMode(int labelMode)
                  throws IOException,
                         AutomationException
The label mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelMode in interface IACRasterShieldSymbol
Parameters:
labelMode - A com.esri.arcgis.carto.acLabelMode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBoundary

public boolean isBoundary()
                   throws IOException,
                          AutomationException
Indicates if a boundary is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isBoundary in interface IACRasterShieldSymbol
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBoundary

public void setBoundary(boolean flag)
                 throws IOException,
                        AutomationException
Indicates if a boundary is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBoundary in interface IACRasterShieldSymbol
Parameters:
flag - The flag (in)
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.

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.

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

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