com.esri.arcgis.carto
Interface IBackground

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ISymbolBackground

All Known Implementing Classes:

IBackgroundProxy, ISymbolBackgroundProxy, SymbolBackground

public interface IBackground
extends java.io.Serializable

COM Interface 'IBackground'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control frame backgrounds.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDe4240309_dd41_11d2_b868_00600802e603
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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(java.lang.String name) Name of the frame background.

Field Detail

IIDe4240309_dd41_11d2_b868_00600802e603

static final int IIDe4240309_dd41_11d2_b868_00600802e603

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

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

Name of the frame background.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Name of the frame background.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGap

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

Gap between the frame background and the subject in points.

Returns:

The gap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGap

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

Gap between the frame background and the subject in points.

Parameters:

gap - The gap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBounds

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

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

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

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

Geometry used to draw the frame background.

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

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

Draws the background into the given display object.

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.