com.esri.arcgis.carto
Interface IBackground

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISymbolBackground

All Known Implementing Classes:

SymbolBackground

public interface IBackground
extends Serializable

Provides access to members that control frame backgrounds.

Remarks

The SymbolBackground object is used to draw the background of frame elements.

IBackground is used to manage backgrounds properties such as the Gap between the background and the frame. The Name property defines the name of the Symbolbackground as listed in the background selector. GetGeometry will return the geometry of the border. The QueryBounds and Draw methods are equivalent to the similar methods of IElement.

See ISymbolBackground for additional control of the background.

See also IFrameDecoration.

Product Availability

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

Method Summary

void	draw(IDisplay display, IGeometry geometry) Draws the background into the given display object.
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.
String	getName() Name of the frame background.
void	queryBounds(IDisplay display, IGeometry geometry, IEnvelope bounds) Bounding rectangle of the geometry including area covered by the border.
void	setGap(double gap) Gap between the frame background and the subject in points.
void	setName(String name) Name of the frame background.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the frame background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Name of the frame background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGap

double getGap()
              throws IOException,
                     AutomationException

Gap between the frame background and the subject in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The gap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGap

void setGap(double gap)
            throws IOException,
                   AutomationException

Gap between the frame background and the subject in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

gap - The gap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBounds

void queryBounds(IDisplay display,
                 IGeometry geometry,
                 IEnvelope bounds)
                 throws IOException,
                        AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry(IDisplay display,
                      IGeometry shape)
                      throws IOException,
                             AutomationException

Geometry used to draw the frame background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IGeometry geometry)
          throws IOException,
                 AutomationException

Draws the background into the given display object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.