com.esri.arcgis.carto
Class IBackgroundProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IBackgroundProxy

All Implemented Interfaces:

IBackground, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

ISymbolBackgroundProxy

Deprecated. Internal use only. Proxy for 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 =

public class IBackgroundProxy
extends com.esri.arcgis.interop.Dispatch
implements IBackground, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

IID, IIDe4240309_dd41_11d2_b868_00600802e603

Constructor Summary

	IBackgroundProxy() Deprecated. For internal use only
	IBackgroundProxy(java.lang.Object obj) Deprecated.
protected	IBackgroundProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IBackgroundProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IBackgroundProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
void	draw(IDisplay display, IGeometry geometry) Deprecated. Draws the background into the given display object.
double	getGap() Deprecated. Gap between the frame background and the subject in points.
IGeometry	getGeometry(IDisplay display, IGeometry shape) Deprecated. Geometry used to draw the frame background.
java.lang.String	getName() Deprecated. Name of the frame background.
void	queryBounds(IDisplay display, IGeometry geometry, IEnvelope bounds) Deprecated. Bounding rectangle of the geometry including area covered by the border.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	setGap(double gap) Deprecated. Gap between the frame background and the subject in points.
void	setName(java.lang.String name) Deprecated. Name of the frame background.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IBackgroundProxy

public IBackgroundProxy(java.lang.String CLSID,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.net.UnknownHostException,
                        java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IBackgroundProxy

public IBackgroundProxy()

Deprecated.

For internal use only

IBackgroundProxy

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

Deprecated.

Throws:

java.io.IOException

IBackgroundProxy

protected IBackgroundProxy(java.lang.Object obj,
                           java.lang.String iid)
                    throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IBackgroundProxy

protected IBackgroundProxy(java.lang.String CLSID,
                           java.lang.String iid,
                           java.lang.String host,
                           com.esri.arcgis.interop.AuthInfo authInfo)
                    throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getName

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

Deprecated.

Name of the frame background.

Specified by:

getName in interface IBackground

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

Deprecated.

Name of the frame background.

Specified by:

setName in interface IBackground

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Specified by:

queryBounds in interface IBackground

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

Deprecated.

Geometry used to draw the frame background.

Specified by:

getGeometry in interface IBackground

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

Deprecated.

Draws the background into the given display object.

Specified by:

draw in interface IBackground

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.