com.esri.arcgis.display
Class BasicFillSymbol

java.lang.Object
  extended bycom.esri.arcgis.display.BasicFillSymbol
All Implemented Interfaces:
IBasicFillSymbol, IBasicSymbol, IDocumentVersionSupportGEN, IDrawingOutline, IGeometricEffect, IGeometricEffects, IMapLevel, IPersist, IPersistStream, ISupportErrorInfo, java.io.Serializable

public class BasicFillSymbol
extends java.lang.Object
implements IBasicSymbol, IBasicFillSymbol, IMapLevel, IGeometricEffects, IGeometricEffect, IDrawingOutline, IPersist, IPersistStream, ISupportErrorInfo, IDocumentVersionSupportGEN

Basic fill symbol object.

Product Availability

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

Description

The BasicFillSymbol is used to create a basic fill symbol comprised of a FillPattern.

Remarks

Use IFillPattern interface along with IGraphicAttributes interface to define a new fill pattern and assign it a basic fill symbol.

There are 3 different types of Fill Patterns available for defining a basic fill symbol: GradientPattern, LinePattern and SolidColorPattern.

See Also:
Serialized Form

Constructor Summary
BasicFillSymbol()
          Constructs a BasicFillSymbol using ArcGIS Engine.
BasicFillSymbol(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 void add(IGeometricEffect geomEffect)
          Adds a new geometric effect.
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void draw(IOutputContext context, IGeometry geometry, IEnvelope envelope)
          Draws the basic symbol.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IGeometry getAllOutlineParts(IGeometry geometry, int type, int option, double buffer, IEnvelope clipEnvelope)
          Returns the entire drawing outline of a drawing rule.
 IBasicFillSymbol getAsIBasicFillSymbol()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IBasicSymbol getAsIBasicSymbol()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDocumentVersionSupportGEN getAsIDocumentVersionSupportGEN()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IDrawingOutline getAsIDrawingOutline()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGeometricEffect getAsIGeometricEffect()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGeometricEffects getAsIGeometricEffects()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMapLevel getAsIMapLevel()
          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.
 ISupportErrorInfo getAsISupportErrorInfo()
          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()
           
 int getCount()
          Number of geometric effects.
 IGeometricEffect getElement(int index)
          The geometric effect at the specified position.
 IFillPattern getFillPattern()
          Fill pattern.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 int getOutputType(int inputType)
          The output type of the geometric effect.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          Supported Platforms
 int hashCode()
          the hashcode for this object
 boolean hitTest(IGeometry geometry, IPoint point, double tolerance)
          Tests if a point is located on the drawing outline.
 void insert(int index, IGeometricEffect geomEffect)
          Inserts a new geometric effect.
 void interfaceSupportsErrorInfo(GUID riid)
          Supported Platforms
 void isDirty()
          Supported Platforms
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 void load(IStream pstm)
          Supported Platforms
 IGeometry nextGeometry()
          Accesses the next geometry generated by th effect.
 IGeometry nextOutlinePart()
          Retrieves the next part of the outline.
 void remove(int index)
          Removes a geometric effect.
 void removeAll()
          Removes all geometric effects.
 void reset(IGeometry geometry)
          Resets the collection of generated geometries.
 void reset(IGeometry geometry, int type, int option, double buffer, IEnvelope clipEnvelope)
          Resets the outline part enumeration.
 void save(IStream pstm, int fClearDirty)
          Supported Platforms
 void setFillPatternByRef(IFillPattern pattern)
          Fill pattern.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicFillSymbol

public BasicFillSymbol()
                throws java.io.IOException,
                       java.net.UnknownHostException
Constructs a BasicFillSymbol using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

BasicFillSymbol

public BasicFillSymbol(java.lang.Object obj)
                throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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

getAsIBasicSymbol

public IBasicSymbol getAsIBasicSymbol()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIBasicFillSymbol

public IBasicFillSymbol getAsIBasicFillSymbol()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIMapLevel

public IMapLevel getAsIMapLevel()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIGeometricEffects

public IGeometricEffects getAsIGeometricEffects()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIGeometricEffect

public IGeometricEffect getAsIGeometricEffect()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDrawingOutline

public IDrawingOutline getAsIDrawingOutline()
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.


getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIDocumentVersionSupportGEN

public IDocumentVersionSupportGEN getAsIDocumentVersionSupportGEN()
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


draw

public void draw(IOutputContext context,
                 IGeometry geometry,
                 IEnvelope envelope)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IBasicSymbol
Draws the basic symbol.

Specified by:
draw in interface IBasicSymbol
Parameters:
context - A reference to a com.esri.arcgis.display.IOutputContext (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getFillPattern

public IFillPattern getFillPattern()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IBasicFillSymbol
Fill pattern.

Specified by:
getFillPattern in interface IBasicFillSymbol
Returns:
A reference to a com.esri.arcgis.display.IFillPattern
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setFillPatternByRef

public void setFillPatternByRef(IFillPattern pattern)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IBasicFillSymbol
Fill pattern.

Specified by:
setFillPatternByRef in interface IBasicFillSymbol
Parameters:
pattern - A reference to a com.esri.arcgis.display.IFillPattern (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapLevel

public int getMapLevel()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMapLevel
Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMapLevel
Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMapLevel in interface IMapLevel
Parameters:
mapLevel - The mapLevel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IGeometricEffects
Number of geometric effects.

Specified by:
getCount in interface IGeometricEffects
Returns:
The count
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getElement

public IGeometricEffect getElement(int index)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGeometricEffects
The geometric effect at the specified position.

Specified by:
getElement in interface IGeometricEffects
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IGeometricEffect
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   IGeometricEffect geomEffect)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IGeometricEffects
Inserts a new geometric effect.

Specified by:
insert in interface IGeometricEffects
Parameters:
index - The index (in)
geomEffect - A reference to a com.esri.arcgis.display.IGeometricEffect (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

add

public void add(IGeometricEffect geomEffect)
         throws java.io.IOException,
                AutomationException
Description copied from interface: IGeometricEffects
Adds a new geometric effect.

Specified by:
add in interface IGeometricEffects
Parameters:
geomEffect - A reference to a com.esri.arcgis.display.IGeometricEffect (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

remove

public void remove(int index)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IGeometricEffects
Removes a geometric effect.

Specified by:
remove in interface IGeometricEffects
Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IGeometricEffects
Removes all geometric effects.

Specified by:
removeAll in interface IGeometricEffects
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getOutputType

public int getOutputType(int inputType)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IGeometricEffect
The output type of the geometric effect.

Specified by:
getOutputType in interface IGeometricEffect
Parameters:
inputType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

reset

public void reset(IGeometry geometry)
           throws java.io.IOException,
                  AutomationException
Description copied from interface: IGeometricEffect
Resets the collection of generated geometries. Must be called before using NextGeometry.

Specified by:
reset in interface IGeometricEffect
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

nextGeometry

public IGeometry nextGeometry()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IGeometricEffect
Accesses the next geometry generated by th effect.

Specified by:
nextGeometry in interface IGeometricEffect
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

hitTest

public boolean hitTest(IGeometry geometry,
                       IPoint point,
                       double tolerance)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IDrawingOutline
Tests if a point is located on the drawing outline.

Specified by:
hitTest in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
tolerance - The tolerance (in)
Returns:
The hit
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getAllOutlineParts

public IGeometry getAllOutlineParts(IGeometry geometry,
                                    int type,
                                    int option,
                                    double buffer,
                                    IEnvelope clipEnvelope)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IDrawingOutline
Returns the entire drawing outline of a drawing rule.

Specified by:
getAllOutlineParts in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
type - A com.esri.arcgis.display.esriOutlineType constant (in)
option - A com.esri.arcgis.display.esriOutlineOption constant (in)
buffer - The buffer (in)
clipEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset(IGeometry geometry,
                  int type,
                  int option,
                  double buffer,
                  IEnvelope clipEnvelope)
           throws java.io.IOException,
                  AutomationException
Description copied from interface: IDrawingOutline
Resets the outline part enumeration.

Specified by:
reset in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
type - A com.esri.arcgis.display.esriOutlineType constant (in)
option - A com.esri.arcgis.display.esriOutlineOption constant (in)
buffer - The buffer (in)
clipEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextOutlinePart

public IGeometry nextOutlinePart()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IDrawingOutline
Retrieves the next part of the outline.

Specified by:
nextOutlinePart in interface IDrawingOutline
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IDocumentVersionSupportGEN
Is this object valid at the given document version.

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException
Description copied from interface: IDocumentVersionSupportGEN
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE.  Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version.  Not all objects will return a supported object; in these cases a null pointer will be returned.

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.