com.esri.arcgis.carto
Class SymbolBackground

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

All Implemented Interfaces:

IBackground, IFrameDecoration, IGraphicsComposite, ISymbolBackground, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class SymbolBackground
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IBackground, ISymbolBackground, IFrameDecoration, IClone, IGraphicsComposite, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable

COM Class 'SymbolBackground'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Background drawn using a symbol.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.ISymbolBackground

IID, IID4fd8cbb7_e13b_11d2_b868_00600802e603, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IBackground

IIDe4240309_dd41_11d2_b868_00600802e603

Fields inherited from interface com.esri.arcgis.carto.IFrameDecoration

IID, IID6a75a961_36fc_44a9_8baf_30195de20c58, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicsComposite

IID, IID969cde4a_82d4_11d2_87dd_0000f8751720, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

SymbolBackground()
Constructs a SymbolBackground using ArcGIS Engine.

SymbolBackground(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SymbolBackground theSymbolBackground = (SymbolBackground) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	draw(IDisplay display, IGeometry geometry) Draws the background into the given display object.
boolean	equals(java.lang.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 java.lang.String	getClsid() getClsid.
IColor	getColor() Color of the frame decoration.
short	getCornerRounding() Amount of corner rounding.
IFillSymbol	getFillSymbol() Symbol used to draw the background.
double	getGap() Gap between the frame background and the subject in points.
IGeometry	getGeometry(IDisplay display, IGeometry shape) Geometry used to draw the frame background.
IEnumElement	getGraphics(IDisplay display, java.lang.Object data) Graphic elements that are used to render this object.
double	getHorizontalSpacing() Horizontal offset or gap between the decoration and the subject in points.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() Name of the frame background.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getVerticalSpacing() Vertical offset or gap between the decoration and the subject in points.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	queryBounds(IDisplay display, IGeometry geometry, IEnvelope bounds) Bounding rectangle of the geometry including area covered by the border.
void	readExternal(java.io.ObjectInput in)
void	release() Release a SymbolBackground.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setColor(IColor color) Color of the frame decoration.
void	setCornerRounding(short rounding) Amount of corner rounding.
void	setFillSymbol(IFillSymbol symbol) Symbol used to draw the background.
void	setGap(double gap) Gap between the frame background and the subject in points.
void	setHorizontalSpacing(double points) Horizontal offset or gap between the decoration and the subject in points.
void	setName(java.lang.String name) Name of the frame background.
void	setVerticalSpacing(double points) Vertical offset or gap between the decoration and the subject in points.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SymbolBackground

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

Constructs a SymbolBackground using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SymbolBackground

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SymbolBackground theSymbolBackground = (SymbolBackground) obj;

Construct a SymbolBackground using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SymbolBackground.

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a SymbolBackground.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

Name of the frame background.

Specified by:

getName in interface IBackground

Specified by:

getName in interface IFrameDecoration

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Name of the frame background.

Specified by:

setName in interface IBackground

Specified by:

setName in interface IFrameDecoration

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGap

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

Gap between the frame background and the subject in points.

Specified by:

getGap in interface IBackground

Returns:

The gap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGap

public void setGap(double gap)
            throws java.io.IOException,
                   AutomationException

Gap between the frame background and the subject in points.

Specified by:

setGap in interface IBackground

Parameters:

gap - The gap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBounds

public void queryBounds(IDisplay display,
                        IGeometry geometry,
                        IEnvelope bounds)
                 throws java.io.IOException,
                        AutomationException

Bounding rectangle of the geometry including area covered by the border.

Specified by:

queryBounds in interface IBackground

Specified by:

queryBounds in interface IFrameDecoration

Parameters:

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

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

bounds - 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.

getGeometry

public IGeometry getGeometry(IDisplay display,
                             IGeometry shape)
                      throws java.io.IOException,
                             AutomationException

Geometry used to draw the frame background.

Specified by:

getGeometry in interface IBackground

Specified by:

getGeometry in interface IFrameDecoration

Parameters:

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

shape - A reference to a com.esri.arcgis.geometry.IGeometry (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.

draw

public void draw(IDisplay display,
                 IGeometry geometry)
          throws java.io.IOException,
                 AutomationException

Draws the background into the given display object.

Specified by:

draw in interface IBackground

Specified by:

draw in interface IFrameDecoration

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol()
                          throws java.io.IOException,
                                 AutomationException

Symbol used to draw the background.

Specified by:

getFillSymbol in interface ISymbolBackground

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFillSymbol

public void setFillSymbol(IFillSymbol symbol)
                   throws java.io.IOException,
                          AutomationException

Symbol used to draw the background.

Specified by:

setFillSymbol in interface ISymbolBackground

Parameters:

symbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCornerRounding

public short getCornerRounding()
                        throws java.io.IOException,
                               AutomationException

Amount of corner rounding. 0 = fully square. 100 = fully round.

Specified by:

getCornerRounding in interface IFrameDecoration

Specified by:

getCornerRounding in interface ISymbolBackground

Returns:

The rounding

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCornerRounding

public void setCornerRounding(short rounding)
                       throws java.io.IOException,
                              AutomationException

Amount of corner rounding. 0 = fully square. 100 = fully round.

Specified by:

setCornerRounding in interface IFrameDecoration

Specified by:

setCornerRounding in interface ISymbolBackground

Parameters:

rounding - The rounding (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColor

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

Color of the frame decoration.

Specified by:

getColor in interface IFrameDecoration

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.

setColor

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

Color of the frame decoration.

Specified by:

setColor in interface IFrameDecoration

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHorizontalSpacing

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

Horizontal offset or gap between the decoration and the subject in points.

Specified by:

getHorizontalSpacing in interface IFrameDecoration

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHorizontalSpacing

public void setHorizontalSpacing(double points)
                          throws java.io.IOException,
                                 AutomationException

Horizontal offset or gap between the decoration and the subject in points.

Specified by:

setHorizontalSpacing in interface IFrameDecoration

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVerticalSpacing

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

Vertical offset or gap between the decoration and the subject in points.

Specified by:

getVerticalSpacing in interface IFrameDecoration

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVerticalSpacing

public void setVerticalSpacing(double points)
                        throws java.io.IOException,
                               AutomationException

Vertical offset or gap between the decoration and the subject in points.

Specified by:

setVerticalSpacing in interface IFrameDecoration

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

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

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if 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:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if 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:

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

AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics(IDisplay display,
                                java.lang.Object data)
                         throws java.io.IOException,
                                AutomationException

Graphic elements that are used to render this object. The data argument is defined by the coclass that implements this interface.

Specified by:

getGraphics in interface IGraphicsComposite

Parameters:

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

data - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumElement

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException