com.esri.arcgis.carto
Class ACGradientFillSymbol

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

All Implemented Interfaces:

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

public class ACGradientFillSymbol

extends java.lang.Object

implements IACAxl, IACGradientFillSymbol, IACSymbol, IPersist, IPersistStream, IClone

ArcIMS Gradient Fill Symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACGradientFillSymbol()
Constructs a ACGradientFillSymbol using ArcGIS Engine.

ACGradientFillSymbol(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.
IACGradientFillSymbol	getAsIACGradientFillSymbol() 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.
IColor	getFinishColor() The end color.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
IColor	getStartColor() The start color.
double	getTransparency() The transparency in percent (0-100).
int	getType() The fill type.
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.
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	setFinishColor(IColor color) The end color.
void	setOverlap(boolean flag) Indicates if labels can overlap this symbol.
void	setStartColor(IColor color) The start color.
void	setTransparency(double trans) The transparency in percent (0-100).
void	setType(int type) The fill type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ACGradientFillSymbol

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

Constructs a ACGradientFillSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACGradientFillSymbol

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

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

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

getAsIACGradientFillSymbol

public IACGradientFillSymbol getAsIACGradientFillSymbol()

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.

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.

getType

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

Description copied from interface: IACGradientFillSymbol

The fill type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IACGradientFillSymbol

Returns:

A com.esri.arcgis.carto.acGradientFillType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int type)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IACGradientFillSymbol

The fill type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setType in interface IACGradientFillSymbol

Parameters:

type - A com.esri.arcgis.carto.acGradientFillType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStartColor

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

Description copied from interface: IACGradientFillSymbol

The start color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStartColor in interface IACGradientFillSymbol

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.

setStartColor

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

Description copied from interface: IACGradientFillSymbol

The start color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStartColor in interface IACGradientFillSymbol

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.

getFinishColor

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

Description copied from interface: IACGradientFillSymbol

The end color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFinishColor in interface IACGradientFillSymbol

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.

setFinishColor

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

Description copied from interface: IACGradientFillSymbol

The end color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFinishColor in interface IACGradientFillSymbol

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.

isOverlap

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

Description copied from interface: IACGradientFillSymbol

Indicates if labels can overlap this symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOverlap in interface IACGradientFillSymbol

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

Indicates if labels can overlap this symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOverlap in interface IACGradientFillSymbol

Parameters:

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

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.