com.esri.arcgis.carto
Class ACSimplePolygonSymbol

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

All Implemented Interfaces:

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

public class ACSimplePolygonSymbol

extends java.lang.Object

implements IACAxl, IACSimplePolygonSymbol, IACSymbol, IPersist, IPersistStream, IClone

ArcIMS Simple Polygon Symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACSimplePolygonSymbol()
Constructs a ACSimplePolygonSymbol using ArcGIS Engine.

ACSimplePolygonSymbol(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.
IACSimplePolygonSymbol	getAsIACSimplePolygonSymbol() 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.
int	getBoundaryCapType() The outline cap type.
IColor	getBoundaryColor() The outline color.
int	getBoundaryJoinType() The outline join type.
int	getBoundaryLineType() The outline type.
double	getBoundaryTransparency() The transparency transparency coeficient (0.0-1.0).
int	getBoundaryWidth() The outline width in pixels.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
java.lang.Object	getElement() The element that represents the XML.
IColor	getFillColor() The fill color.
int	getFillInterval() The interval of the hatch fill type.
double	getFillTransparency() The fill transparency coeficient (0.0-1.0).
int	getFillType() The fill type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
double	getTransparency() The transparency in percent (0-100).
int	hashCode() the hashcode for this object
boolean	isAntialiasing() Indicates if the antialias is ON or OFF.
boolean	isBoundary() Indicates if the layer display the boundary or outline.
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	setBoundary(boolean flag) Indicates if the layer display the boundary or outline.
void	setBoundaryCapType(int type) The outline cap type.
void	setBoundaryColor(IColor color) The outline color.
void	setBoundaryJoinType(int type) The outline join type.
void	setBoundaryLineType(int type) The outline type.
void	setBoundaryTransparency(double trans) The transparency transparency coeficient (0.0-1.0).
void	setBoundaryWidth(int width) The outline width in pixels.
void	setElementByRef(java.lang.Object element) The element that represents the XML.
void	setFillColor(IColor color) The fill color.
void	setFillInterval(int interval) The interval of the hatch fill type.
void	setFillTransparency(double trans) The fill transparency coeficient (0.0-1.0).
void	setFillType(int type) The fill type.
void	setOverlap(boolean flag) Indicates if labels can overlap this symbol.
void	setTransparency(double trans) The transparency in percent (0-100).

Methods inherited from class java.lang.Object

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

Constructor Detail

ACSimplePolygonSymbol

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

Constructs a ACSimplePolygonSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACSimplePolygonSymbol

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

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

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

getAsIACSimplePolygonSymbol

public IACSimplePolygonSymbol getAsIACSimplePolygonSymbol()

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.

getFillColor

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

Description copied from interface: IACSimplePolygonSymbol

The fill color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFillColor in interface IACSimplePolygonSymbol

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.

setFillColor

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

Description copied from interface: IACSimplePolygonSymbol

The fill color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFillColor in interface IACSimplePolygonSymbol

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.

getFillType

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

Description copied from interface: IACSimplePolygonSymbol

The fill type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFillType in interface IACSimplePolygonSymbol

Returns:

A com.esri.arcgis.carto.acFillType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFillType

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

Description copied from interface: IACSimplePolygonSymbol

The fill type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFillType in interface IACSimplePolygonSymbol

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFillInterval

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

Description copied from interface: IACSimplePolygonSymbol

The interval of the hatch fill type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFillInterval in interface IACSimplePolygonSymbol

Returns:

The interval

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFillInterval

public void setFillInterval(int interval)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACSimplePolygonSymbol

The interval of the hatch fill type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFillInterval in interface IACSimplePolygonSymbol

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFillTransparency

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

Description copied from interface: IACSimplePolygonSymbol

The fill transparency coeficient (0.0-1.0).

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFillTransparency in interface IACSimplePolygonSymbol

Returns:

The trans

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFillTransparency

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

Description copied from interface: IACSimplePolygonSymbol

The fill transparency coeficient (0.0-1.0).

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFillTransparency in interface IACSimplePolygonSymbol

Parameters:

trans - The trans (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBoundaryWidth

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

Description copied from interface: IACSimplePolygonSymbol

The outline width in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBoundaryWidth in interface IACSimplePolygonSymbol

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBoundaryWidth

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

Description copied from interface: IACSimplePolygonSymbol

The outline width in pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBoundaryWidth in interface IACSimplePolygonSymbol

Parameters:

width - The width (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBoundaryColor

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

Description copied from interface: IACSimplePolygonSymbol

The outline color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBoundaryColor in interface IACSimplePolygonSymbol

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.

setBoundaryColor

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

Description copied from interface: IACSimplePolygonSymbol

The outline color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBoundaryColor in interface IACSimplePolygonSymbol

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.

getBoundaryLineType

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

Description copied from interface: IACSimplePolygonSymbol

The outline type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBoundaryLineType in interface IACSimplePolygonSymbol

Returns:

A com.esri.arcgis.carto.acLineType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBoundaryLineType

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

Description copied from interface: IACSimplePolygonSymbol

The outline type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBoundaryLineType in interface IACSimplePolygonSymbol

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBoundaryCapType

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

Description copied from interface: IACSimplePolygonSymbol

The outline cap type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBoundaryCapType in interface IACSimplePolygonSymbol

Returns:

A com.esri.arcgis.carto.acCapType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBoundaryCapType

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

Description copied from interface: IACSimplePolygonSymbol

The outline cap type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBoundaryCapType in interface IACSimplePolygonSymbol

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBoundaryJoinType

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

Description copied from interface: IACSimplePolygonSymbol

The outline join type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBoundaryJoinType in interface IACSimplePolygonSymbol

Returns:

A com.esri.arcgis.carto.acJoinType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBoundaryJoinType

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

Description copied from interface: IACSimplePolygonSymbol

The outline join type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBoundaryJoinType in interface IACSimplePolygonSymbol

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBoundaryTransparency

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

Description copied from interface: IACSimplePolygonSymbol

The transparency transparency coeficient (0.0-1.0).

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBoundaryTransparency in interface IACSimplePolygonSymbol

Returns:

The trans

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBoundaryTransparency

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

Description copied from interface: IACSimplePolygonSymbol

The transparency transparency coeficient (0.0-1.0).

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBoundaryTransparency in interface IACSimplePolygonSymbol

Parameters:

trans - The trans (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: IACSimplePolygonSymbol

Indicates if labels can overlap this symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOverlap in interface IACSimplePolygonSymbol

Returns:

The flag

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setOverlap

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

Description copied from interface: IACSimplePolygonSymbol

Indicates if labels can overlap this symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOverlap in interface IACSimplePolygonSymbol

Parameters:

flag - The flag (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: IACSimplePolygonSymbol

Indicates if the layer display the boundary or outline.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isBoundary in interface IACSimplePolygonSymbol

Returns:

The flag

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBoundary

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

Description copied from interface: IACSimplePolygonSymbol

Indicates if the layer display the boundary or outline.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBoundary in interface IACSimplePolygonSymbol

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

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.