IMapClipOptions (ArcObjects Java API 10.4)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface IMapClipOptions

All Superinterfaces:: java.io.Serializable

All Known Implementing Classes:: IMapClipOptionsProxy, Map

public interface IMapClipOptions
extends java.io.Serializable
extends java.io.Serializable

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

Description: 'Provides access to the Map's clipping options.' 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`	`IID49522374_ec8e_4c1a_ba3b_2a4cc963652c`
`static int`	`xxDummy` Deprecated. Internal use only

Method Summary
`IBorder`	`getClipBorder()` An optional border drawn around ClipGeometry.
`java.lang.Object`	`getClipData()` Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.
`ISet`	`getClipFilter()` Sets or returns the set of layers that will be excluded from clipping.
`IGeometry`	`getClipGeometry()` A shape that layers in the map are clipped to.
`int`	`getClipType()` Method used to clip layers in map.
`boolean`	`isClipGridAndGraticules()` Clip grids and grticules to data extent
`void`	`setClipBorder(IBorder border)` An optional border drawn around ClipGeometry.
`void`	`setClipData(java.lang.Object data)` Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.
`void`	`setClipFilter(ISet layers)` Sets or returns the set of layers that will be excluded from clipping.
`void`	`setClipGeometry(IGeometry clipGeometry)` A shape that layers in the map are clipped to.
`void`	`setClipGridAndGraticules(boolean pClipGridAndGraticules)` Clip grids and grticules to data extent
`void`	`setClipType(int type)` Method used to clip layers in map.

Field Detail

IID49522374_ec8e_4c1a_ba3b_2a4cc963652c

static final int IID49522374_ec8e_4c1a_ba3b_2a4cc963652c

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

getClipType

int getClipType()
                throws java.io.IOException,
                       AutomationException

Method used to clip layers in map.

Returns:: A com.esri.arcgis.carto.esriMapClipType constant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setClipType

void setClipType(int type)
                 throws java.io.IOException,
                        AutomationException

Method used to clip layers in map.

Parameters:: type - A com.esri.arcgis.carto.esriMapClipType constant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClipData

java.lang.Object getClipData()
                             throws java.io.IOException,
                                    AutomationException

Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.

Returns:: A reference to another Object (IUnknown)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setClipData

void setClipData(java.lang.Object data)
                 throws java.io.IOException,
                        AutomationException