com.esri.arcgis.carto
Class MapSurroundFrame

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

All Implemented Interfaces:

IBoundsProperties, IElement, IElementProperties, IElementProperties2, IElementProperties3, IFrameDraw, IFrameElement, IFrameProperties, IGraphicsComposite, IMapFrameEvents, IMapSurroundEvents, IMapSurroundFrame, ITransformEvents, ITransform2D, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class MapSurroundFrame
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IElement, IElementProperties, IElementProperties2, IElementProperties3, IMapSurroundFrame, IGraphicsComposite, IFrameElement, IFrameDraw, IFrameProperties, IMapFrameEvents, ITransformEvents, IPropertySupport, IPersistStream, IClone, ITransform2D, IBoundsProperties, IMapSurroundEvents, java.io.Externalizable

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

Description 'A graphic element for displaying map surrounds.' 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.IElement

IID, IID9b001319_9ed7_11d0_859e_0800091a2a72, xxDummy

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

IID, IID86f32b61_7667_11d2_a2d3_080009b6f22b, xxDummy

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

IID, IID7d019a0d_f450_48fe_8a78_a2f0cb8ef3a4, xxDummy

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

IID, IID7d019a0e_f450_48fe_8a78_a2f0cb8ef3a4, xxDummy

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

IID, IID9b00131c_9ed7_11d0_859e_0800091a2a72, xxDummy

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

IID9b00131a_9ed7_11d0_859e_0800091a2a72

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

IID, IID969cde4a_82d4_11d2_87dd_0000f8751720, xxDummy

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

IID, IIDcf387183_1698_4463_b5f5_67925465812e, xxDummy

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

IID, IIDd1b1b855_5885_4d7f_a444_a02e3e1078c3, xxDummy

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

IID, IIDfe3115eb_ed6c_11d0_8683_0000f8751720, xxDummy

Fields inherited from interface com.esri.arcgis.display.ITransformEvents

IID, IIDe6bdb001_4d35_11d0_98be_00805f7ced21, xxDummy

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

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, 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.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ITransform2D

IID, IID3be78ad0_886e_11d1_bc78_0000f875bcce, xxDummy

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

IID, IID7ad72c5d_eb8a_11d3_9314_00600802e603, xxDummy

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

IID, IID0dca8f87_afa7_11d2_87fb_0000f8751720, xxDummy

Constructor Summary

MapSurroundFrame()
Constructs a MapSurroundFrame using ArcGIS Engine.

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

Method Summary

void	activate(IDisplay display) Prepare to display graphic on screen.
void	afterDraw(IMapSurroundEventsAfterDrawEvent theEvent) Fired after drawing completes.
boolean	applies(java.lang.Object pUnk) Indicates if the receiver can apply the given object at any given time.
java.lang.Object	apply(java.lang.Object newObject) Applies the given property to the receiver and returns the old object.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	beforeDraw(IMapSurroundEventsBeforeDrawEvent theEvent) Fired before drawing starts.
void	boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent) Notifies clients when the bounds is updated.
boolean	canApply(java.lang.Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
boolean	canRotate() Indicates if the element can be rotated.
void	contentsChanged(IMapSurroundEventsContentsChangedEvent theEvent) Fired when the contents of the map surround changes.
void	deactivate() ActiveView that graphics are displayed on is no longer visible.
void	deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent) Notifies clients when the device frame is updated.
void	draw(IDisplay display, ITrackCancel trackCancel) Draws the element into the given display object.
void	drawBackground(IDisplay display, ITrackCancel cancelTracker) Draw the frame's shadow and background.
void	drawDraftMode(IDisplay display, ITrackCancel cancelTracker) Draw the draft mode representation of the frame.
void	drawForeground(IDisplay display, ITrackCancel cancelTracker) Draw the frame's border.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IBackground	getBackground() Frame background used by this element.
IBorder	getBorder() Frame border used by this element.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
java.lang.Object	getCustomProperty() Custom property.
IGeometry	getGeometry() Shape of the element as a geometry.
IEnumElement	getGraphics(IDisplay display, java.lang.Object data) Graphic elements that are used to render this object.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IMapFrame	getMapFrame() The frame element of the map associated with this object's map surround.
IMapSurround	getMapSurround() The map surround displayed by this frame element.
java.lang.String	getName() Name of the element.
java.lang.Object	getObject() Object framed by this element.
double	getReferenceScale() Reference scale of the element.
ISelectionTracker	getSelectionTracker() Selection tracker used by this element.
IShadow	getShadow() Frame shadow used by this element.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() Spatial reference of the container.
int	getThumbnail() Small bitmap representation of this element.
java.lang.String	getType() Type of the element.
int	hashCode() the hashcode for this object
boolean	hitTest(double x, double y, double tolerance) Indicates if the given x and y coordinates are contained by the element.
int	IElementProperties3_getAnchorPoint() Anchor point of the element.
IBackground	IFrameProperties_getBackground() Frame background used by this element.
boolean	isAutoTransform() Indicates if transform is applied to symbols and other parts of element.
void	isDirty() isDirty
boolean	isDraftMode() Indicates if this element is in draft mode, i.e., draws fast.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFixedAspectRatio() Indicates if the bounds has a fixed aspect ratio.
boolean	isFixedSize() Indicates if size is determined by some other property like the symbol.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isLocked() Indicates if the element is in a read-only state.
void	load(IStream pstm) load
void	mapFrameResized(IMapFrameEventsMapFrameResizedEvent theEvent) Occurs when a map frame is resized.
void	move(double dx, double dy) Moves dx units horizontally and dy units vertically.
void	moveVector(ILine v) Moves a direction and distance v.
void	queryBounds(IDisplay display, IEnvelope bounds) Bounds of the element taking symbology into consideration.
void	queryOutline(IDisplay display, IPolygon outline) Bounds of the element taking symbology into consideration.
void	readExternal(java.io.ObjectInput in)
void	release() Release a MapSurroundFrame.
void	resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent) Notifies clients when the resolution is updated.
void	rotate(IPoint origin, double rotationAngle) Rotates about the specified origin point.
void	rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent) Notifies clients when the rotation angle is updated.
void	save(IStream pstm, int fClearDirty) save
void	scale(IPoint origin, double sx, double sy) Scales about the specified origin using seperate horizonal and vertical scales.
void	setAnchorPoint(int anchorPoint) Anchor point of the element.
void	setAutoTransform(boolean autoTransform) Indicates if transform is applied to symbols and other parts of element.
void	setBackground(IBackground background) Frame background used by this element.
void	setBorder(IBorder border) Frame border used by this element.
void	setCustomProperty(java.lang.Object customProperty) Custom property.
void	setDraftMode(boolean draftMode) Indicates if this element is in draft mode, i.e., draws fast.
void	setFixedAspectRatio(boolean flag) Indicates if the bounds has a fixed aspect ratio.
void	setGeometry(IGeometry pGeometry) Shape of the element as a geometry.
void	setLocked(boolean pLocked) Indicates if the element is in a read-only state.
void	setMapFrameByRef(IMapFrame mapFrame) The frame element of the map associated with this object's map surround.
void	setMapSurroundByRef(IMapSurround mapSurround) The map surround displayed by this frame element.
void	setName(java.lang.String name) Name of the element.
void	setReferenceScale(double referenceScale) Reference scale of the element.
void	setShadow(IShadow shadow) Frame shadow used by this element.
void	setSpatialReferenceByRef(ISpatialReference spatialRef) Spatial reference of the container.
void	setType(java.lang.String name) Type of the element.
void	transform(int direction, ITransformation transformation) Applies an arbitrary transformation.
void	unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent) Notifies clients when the units are updated.
void	visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent) Notifies clients when the visible bounds is updated.
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

MapSurroundFrame

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

Constructs a MapSurroundFrame using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MapSurroundFrame

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

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

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

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

Specified by:

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

getGeometry

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

Shape of the element as a geometry.

Specified by:

getGeometry in interface IElement

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.

setGeometry

public void setGeometry(IGeometry pGeometry)
                 throws java.io.IOException,
                        AutomationException

Shape of the element as a geometry.

Specified by:

setGeometry in interface IElement

Parameters:

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

queryBounds

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

Bounds of the element taking symbology into consideration.

Specified by:

queryBounds in interface IElement

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (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.

queryOutline

public void queryOutline(IDisplay display,
                         IPolygon outline)
                  throws java.io.IOException,
                         AutomationException

Bounds of the element taking symbology into consideration.

Specified by:

queryOutline in interface IElement

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionTracker

public ISelectionTracker getSelectionTracker()
                                      throws java.io.IOException,
                                             AutomationException

Selection tracker used by this element.

Specified by:

getSelectionTracker in interface IElement

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hitTest

public boolean hitTest(double x,
                       double y,
                       double tolerance)
                throws java.io.IOException,
                       AutomationException

Indicates if the given x and y coordinates are contained by the element.

Specified by:

hitTest in interface IElement

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The hit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the element into the given display object.

Specified by:

draw in interface IElement

Parameters:

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IDisplay display)
              throws java.io.IOException,
                     AutomationException

Prepare to display graphic on screen.

Specified by:

activate in interface IElement

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deactivate

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

ActiveView that graphics are displayed on is no longer visible.

Specified by:

deactivate in interface IElement

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLocked

public boolean isLocked()
                 throws java.io.IOException,
                        AutomationException

Indicates if the element is in a read-only state.

Specified by:

isLocked in interface IElement

Returns:

The pLocked

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLocked

public void setLocked(boolean pLocked)
               throws java.io.IOException,
                      AutomationException

Indicates if the element is in a read-only state.

Specified by:

setLocked in interface IElement

Parameters:

pLocked - The pLocked (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of the element.

Specified by:

getName in interface IElementProperties

Specified by:

getName in interface IElementProperties2

Specified by:

getName in interface IElementProperties3

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

Specified by:

setName in interface IElementProperties

Specified by:

setName in interface IElementProperties2

Specified by:

setName in interface IElementProperties3

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

Type of the element.

Specified by:

getType in interface IElementProperties

Specified by:

getType in interface IElementProperties2

Specified by:

getType in interface IElementProperties3

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setType

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

Type of the element.

Specified by:

setType in interface IElementProperties

Specified by:

setType in interface IElementProperties2

Specified by:

setType in interface IElementProperties3

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoTransform

public boolean isAutoTransform()
                        throws java.io.IOException,
                               AutomationException

Indicates if transform is applied to symbols and other parts of element. False = only apply transform to geometry.

Specified by:

isAutoTransform in interface IElementProperties

Specified by:

isAutoTransform in interface IElementProperties2

Specified by:

isAutoTransform in interface IElementProperties3

Returns:

The autoTransform

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoTransform

public void setAutoTransform(boolean autoTransform)
                      throws java.io.IOException,
                             AutomationException

Indicates if transform is applied to symbols and other parts of element. False = only apply transform to geometry.

Specified by:

setAutoTransform in interface IElementProperties

Specified by:

setAutoTransform in interface IElementProperties2

Specified by:

setAutoTransform in interface IElementProperties3

Parameters:

autoTransform - The autoTransform (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

Custom property.

Specified by:

getCustomProperty in interface IElementProperties

Specified by:

getCustomProperty in interface IElementProperties2

Specified by:

getCustomProperty in interface IElementProperties3

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object customProperty)
                       throws java.io.IOException,
                              AutomationException

Custom property.

Specified by:

setCustomProperty in interface IElementProperties

Specified by:

setCustomProperty in interface IElementProperties2

Specified by:

setCustomProperty in interface IElementProperties3

Parameters:

customProperty - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRotate

public boolean canRotate()
                  throws java.io.IOException,
                         AutomationException

Indicates if the element can be rotated.

Specified by:

canRotate in interface IElementProperties2

Specified by:

canRotate in interface IElementProperties3

Returns:

The canRotate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

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

Reference scale of the element.

Specified by:

getReferenceScale in interface IElementProperties2

Specified by:

getReferenceScale in interface IElementProperties3

Returns:

The referenceScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double referenceScale)
                       throws java.io.IOException,
                              AutomationException

Reference scale of the element.

Specified by:

setReferenceScale in interface IElementProperties2

Specified by:

setReferenceScale in interface IElementProperties3

Parameters:

referenceScale - The referenceScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IElementProperties3_getAnchorPoint

public int IElementProperties3_getAnchorPoint()
                                       throws java.io.IOException,
                                              AutomationException

Anchor point of the element.

Specified by:

IElementProperties3_getAnchorPoint in interface IElementProperties3

Returns:

A com.esri.arcgis.carto.esriAnchorPointEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

public void setAnchorPoint(int anchorPoint)
                    throws java.io.IOException,
                           AutomationException

Anchor point of the element.

Specified by:

setAnchorPoint in interface IElementProperties3

Parameters:

anchorPoint - A com.esri.arcgis.carto.esriAnchorPointEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

Spatial reference of the container.

Specified by:

getSpatialReference in interface IElementProperties3

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws java.io.IOException,
                                     AutomationException

Spatial reference of the container.

Specified by:

setSpatialReferenceByRef in interface IElementProperties3

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapSurround

public IMapSurround getMapSurround()
                            throws java.io.IOException,
                                   AutomationException

The map surround displayed by this frame element.

Specified by:

getMapSurround in interface IMapSurroundFrame

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapSurroundByRef

public void setMapSurroundByRef(IMapSurround mapSurround)
                         throws java.io.IOException,
                                AutomationException

The map surround displayed by this frame element.

Specified by:

setMapSurroundByRef in interface IMapSurroundFrame

Parameters:

mapSurround - A reference to a com.esri.arcgis.carto.IMapSurround (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapFrame

public IMapFrame getMapFrame()
                      throws java.io.IOException,
                             AutomationException

The frame element of the map associated with this object's map surround.

Specified by:

getMapFrame in interface IMapSurroundFrame

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapFrameByRef

public void setMapFrameByRef(IMapFrame mapFrame)
                      throws java.io.IOException,
                             AutomationException

The frame element of the map associated with this object's map surround.

Specified by:

setMapFrameByRef in interface IMapSurroundFrame

Parameters:

mapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException

Object framed by this element.

Specified by:

getObject in interface IFrameElement

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBorder

public IBorder getBorder()
                  throws java.io.IOException,
                         AutomationException

Frame border used by this element.

Specified by:

getBorder in interface IFrameElement

Specified by:

getBorder in interface IFrameProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorder

public void setBorder(IBorder border)
               throws java.io.IOException,
                      AutomationException

Frame border used by this element.

Specified by:

setBorder in interface IFrameElement

Specified by:

setBorder in interface IFrameProperties

Parameters:

border - A reference to a com.esri.arcgis.carto.IBorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackground

public IBackground getBackground()
                          throws java.io.IOException,
                                 AutomationException

Frame background used by this element.

Specified by:

getBackground in interface IFrameElement

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(IBackground background)
                   throws java.io.IOException,
                          AutomationException

Frame background used by this element.

Specified by:

setBackground in interface IFrameElement

Specified by:

setBackground in interface IFrameProperties

Parameters:

background - A reference to a com.esri.arcgis.carto.IBackground (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThumbnail

public int getThumbnail()
                 throws java.io.IOException,
                        AutomationException

Small bitmap representation of this element.

Specified by:

getThumbnail in interface IFrameElement

Returns:

The bitmapHandle (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDraftMode

public boolean isDraftMode()
                    throws java.io.IOException,
                           AutomationException

Indicates if this element is in draft mode, i.e., draws fast.

Specified by:

isDraftMode in interface IFrameElement

Returns:

The draftMode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDraftMode

public void setDraftMode(boolean draftMode)
                  throws java.io.IOException,
                         AutomationException

Indicates if this element is in draft mode, i.e., draws fast.

Specified by:

setDraftMode in interface IFrameElement

Parameters:

draftMode - The draftMode (in)

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.

drawBackground

public void drawBackground(IDisplay display,
                           ITrackCancel cancelTracker)
                    throws java.io.IOException,
                           AutomationException

Draw the frame's shadow and background.

Specified by:

drawBackground in interface IFrameDraw

Parameters:

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

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawDraftMode

public void drawDraftMode(IDisplay display,
                          ITrackCancel cancelTracker)
                   throws java.io.IOException,
                          AutomationException

Draw the draft mode representation of the frame.

Specified by:

drawDraftMode in interface IFrameDraw

Parameters:

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

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawForeground

public void drawForeground(IDisplay display,
                           ITrackCancel cancelTracker)
                    throws java.io.IOException,
                           AutomationException

Draw the frame's border.

Specified by:

drawForeground in interface IFrameDraw

Parameters:

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

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IFrameProperties_getBackground

public IBackground IFrameProperties_getBackground()
                                           throws java.io.IOException,
                                                  AutomationException

Frame background used by this element.

Specified by:

IFrameProperties_getBackground in interface IFrameProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShadow

public IShadow getShadow()
                  throws java.io.IOException,
                         AutomationException

Frame shadow used by this element.

Specified by:

getShadow in interface IFrameProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShadow

public void setShadow(IShadow shadow)
               throws java.io.IOException,
                      AutomationException

Frame shadow used by this element.

Specified by:

setShadow in interface IFrameProperties

Parameters:

shadow - A reference to a com.esri.arcgis.carto.IShadow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

mapFrameResized

public void mapFrameResized(IMapFrameEventsMapFrameResizedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Occurs when a map frame is resized.

Specified by:

mapFrameResized in interface IMapFrameEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

boundsUpdated

public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Notifies clients when the bounds is updated.

Specified by:

boundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

visibleBoundsUpdated

public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException

Notifies clients when the visible bounds is updated.

Specified by:

visibleBoundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deviceFrameUpdated

public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Notifies clients when the device frame is updated.

Specified by:

deviceFrameUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resolutionUpdated

public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Notifies clients when the resolution is updated.

Specified by:

resolutionUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rotationUpdated

public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Notifies clients when the rotation angle is updated.

Specified by:

rotationUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unitsUpdated

public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Notifies clients when the units are updated.

Specified by:

unitsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException

The object currently being used.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException

Applies the given property to the receiver and returns the old object.

Specified by:

apply in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

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.

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.

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.

move

public void move(double dx,
                 double dy)
          throws java.io.IOException,
                 AutomationException

Moves dx units horizontally and dy units vertically.

Specified by:

move in interface ITransform2D

Parameters:

dx - The dx (in)

dy - The dy (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveVector

public void moveVector(ILine v)
                throws java.io.IOException,
                       AutomationException

Moves a direction and distance v. v can be in a different spatial reference than the geometry being moved.

Specified by:

moveVector in interface ITransform2D

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

scale

public void scale(IPoint origin,
                  double sx,
                  double sy)
           throws java.io.IOException,
                  AutomationException

Scales about the specified origin using seperate horizonal and vertical scales. The origin point can be in a different spatial reference than the geometry being scaled.

Specified by:

scale in interface ITransform2D

Parameters:

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

sx - The sx (in)

sy - The sy (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rotate

public void rotate(IPoint origin,
                   double rotationAngle)
            throws java.io.IOException,
                   AutomationException

Rotates about the specified origin point. The angle is in radians. The origin can be in a different spatial reference than the geometry being rotated.

Specified by:

rotate in interface ITransform2D

Parameters:

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

rotationAngle - The rotationAngle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

transform

public void transform(int direction,
                      ITransformation transformation)
               throws java.io.IOException,
                      AutomationException

Applies an arbitrary transformation. In particular, the transformation parameter can be either an affine transformation or a geographic transformation (datum shift).

Specified by:

transform in interface ITransform2D

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedAspectRatio

public boolean isFixedAspectRatio()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the bounds has a fixed aspect ratio.

Specified by:

isFixedAspectRatio in interface IBoundsProperties

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFixedAspectRatio

public void setFixedAspectRatio(boolean flag)
                         throws java.io.IOException,
                                AutomationException

Indicates if the bounds has a fixed aspect ratio.

Specified by:

setFixedAspectRatio in interface IBoundsProperties

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedSize

public boolean isFixedSize()
                    throws java.io.IOException,
                           AutomationException

Indicates if size is determined by some other property like the symbol.

Specified by:

isFixedSize in interface IBoundsProperties

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged(IMapSurroundEventsContentsChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the map surround changes.

Specified by:

contentsChanged in interface IMapSurroundEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beforeDraw

public void beforeDraw(IMapSurroundEventsBeforeDrawEvent theEvent)
                throws java.io.IOException,
                       AutomationException

Fired before drawing starts.

Specified by:

beforeDraw in interface IMapSurroundEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IMapSurroundEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired after drawing completes.

Specified by:

afterDraw in interface IMapSurroundEvents

Parameters:

theEvent - The event

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