|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.MapFrame
public class MapFrame
A graphic element for displaying maps.
The primary interface for a MapFrame object is IMapFrame, which inherits from IFrameElement. The object also implements the IMapGrids and IMapFrameEvents interfaces (the MapFrame object is an event source). A MapFrame object holds a a reference to a Map .
This object can be used to obtain the map within, or to manipulate the locator rectangles found within the frame.
Geometry: MapFrame accepts geometry of type esriGeometryEnvelope or esriGeometryPolygon. If an envelope is passed it, it is converted to a Polygon internally. The geometry represents the geometry of the frame that is drawn and it is typically a rectangle.
IOleFrame
,
IFrameElement
,
com.esri.arcgis.carto.OleFrame
,
Serialized FormConstructor Summary | |
---|---|
MapFrame()
Constructs a MapFrame using ArcGIS Engine. |
|
MapFrame(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. MapFrame theMapFrame = (MapFrame) obj; |
Method Summary | |
---|---|
void |
activate(IDisplay display)
Prepare to display graphic on screen. |
void |
addIMapFrameEventsListener(IMapFrameEvents theListener)
addIMapFrameEventsListener. |
void |
addLocatorRectangle(ILocatorRectangle locator)
Add a new locator rectangle to the data frame. |
void |
addMapGrid(IMapGrid mapGrid)
Adds a map grid to the map frame. |
void |
afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
Fired after the specified phase is drawn. |
void |
afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
Fired after an individual view item is drawn. |
boolean |
applies(Object pUnk)
Indicates if the receiver can apply the given object at any given time. |
Object |
apply(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 |
boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
Notifies clients when the bounds is updated. |
boolean |
canApply(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 |
clearMapGrids()
Clears all map grids from the map frame. |
void |
contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
Fired when the contents of the view changes. |
void |
contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
Fired when the contents of the view is cleared. |
IMapSurroundFrame |
createSurroundFrame(IUID clsid,
IMapSurround optionalStyle)
Returns the map surround frame element of the type given in clsid. |
void |
deactivate()
ActiveView that graphics are displayed on is no longer visible. |
void |
deleteMapGrid(IMapGrid mapGrid)
Deletes a map grid from the map frame. |
void |
deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
Notifies clients when the device frame is updated. |
void |
displayFinished(IDisplayEventsDisplayFinishedEvent theEvent)
Notifies clients when drawing completes. |
void |
displayInvalidated(IDisplayEventsDisplayInvalidatedEvent theEvent)
Notifies clients when display is invalidated. |
void |
displayScrolled(IDisplayEventsDisplayScrolledEvent theEvent)
Notifies clients when display is scrolled. |
void |
displayStarted(IDisplayEventsDisplayStartedEvent theEvent)
Notifies clients when drawing starts. |
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. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
void |
focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
Fired when a new map is made active. |
IBackground |
getBackground()
Frame background used by this element. |
IBorder |
getBorder()
Frame border used by this element. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
IGraphicsContainer |
getContainer()
The frame's container. |
Object |
getCurrent(Object pUnk)
The object currently being used. |
Object |
getCustomProperty()
Custom property. |
int |
getExtentType()
The way in which the map extent of the frame is specified. |
IGeometry |
getGeometry()
Shape of the element as a geometry. |
IEnumElement |
getGraphics(IDisplay display,
Object data)
Graphic elements that are used to render this object. |
IGraphicsContainer |
getGraphicsContainer()
Element's graphics container. |
int |
getLocatorRectangleCount()
The number of locator rectangles. |
IMap |
getMap()
The associated map. |
IEnvelope |
getMapBounds()
The bounds of the map displayed by the frame. |
IMapGrid |
getMapGrid(int index)
The map grid at the specified index. |
int |
getMapGridCount()
The number of map grids associated with the map frame. |
double |
getMapScale()
The scale at which the map should be displayed. |
String |
getName()
Name of the element. |
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. |
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. |
boolean |
isUsesFilter()
Indicates if the current object draws using a filter. |
void |
itemAdded(IActiveViewEventsItemAddedEvent theEvent)
Fired when an item is added to the view. |
void |
itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
Fired when an item is deleted from the view. |
void |
itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
Fired when a view item is reordered. |
void |
load(IStream pstm)
load |
ILocatorRectangle |
locatorRectangle(int index)
Returns the locator rectangle at the specified index. |
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(ObjectInput in)
|
void |
removeAllLocatorRectangles()
Remove all the locator rectangles from the data frame. |
void |
removeIMapFrameEventsListener(IMapFrameEvents theListener)
removeIMapFrameEventsListener. |
void |
removeLocatorRectangle(ILocatorRectangle locator)
Remove a locator rectangle from the data frame. |
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 |
selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
Call this function to fire the selection changed event. |
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 |
setContainerByRef(IGraphicsContainer container)
The frame's container. |
void |
setCustomProperty(Object customProperty)
Custom property. |
void |
setDraftMode(boolean draftMode)
Indicates if this element is in draft mode, i.e., draws fast. |
void |
setExtentType(int type)
The way in which the map extent of the frame is specified. |
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 |
setGraphicsContainerByRef(IGraphicsContainer container)
Element's graphics container. |
void |
setLocked(boolean pLocked)
Indicates if the element is in a read-only state. |
void |
setMapBounds(IEnvelope bounds)
The bounds of the map displayed by the frame. |
void |
setMapByRef(IMap map)
The associated map. |
void |
setMapGrid(int index,
IMapGrid mapGrid)
The map grid at the specified index. |
void |
setMapScale(double scale)
The scale at which the map should be displayed. |
void |
setName(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(String name)
Type of the element. |
void |
spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
Fired when the spatial reference is changed. |
void |
transform(int direction,
ITransformation transformation)
Applies an arbitrary transformation. |
void |
unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
Notifies clients when the units are updated. |
void |
viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
Fired when view is refreshed before draw happens. |
void |
visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
Notifies clients when the visible bounds is updated. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public MapFrame() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic MapFrame(Object obj) throws IOException
MapFrame theMapFrame = (MapFrame) obj;
obj
to MapFrame
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void addIMapFrameEventsListener(IMapFrameEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.carto.IMapFrameEvents interface.
IOException
- If there are communications problems.public void removeIMapFrameEventsListener(IMapFrameEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.carto.IMapFrameEvents interface.
IOException
- If there are communications problems.public IGeometry getGeometry() throws IOException, AutomationException
getGeometry
in interface IElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setGeometry(IGeometry pGeometry) throws IOException, AutomationException
setGeometry
in interface IElement
pGeometry
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryBounds(IDisplay display, IEnvelope bounds) throws IOException, AutomationException
QueryBounds returns an envelope representing the boundary of the element. A valid envelope object must be passed in to the method along with the current display. The method then updates the envelope object based on the minimum bounding rectangle of the element.
queryBounds
in interface IElement
display
- A reference to a com.esri.arcgis.display.IDisplay (in)bounds
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryOutline(IDisplay display, IPolygon outline) throws IOException, AutomationException
QueryOutline returns a polygon representing the outline of the element. A valid polygon object must be passed in to the method along with the current display. The method then updates the polygon object. The results for point and line elements will be similar to the minimum bounding envelope returned by QueryBounds, while the results for polygon elements while be the actual outline of the element (not the bounding envelope).
queryOutline
in interface IElement
display
- A reference to a com.esri.arcgis.display.IDisplay (in)outline
- A reference to a com.esri.arcgis.geometry.IPolygon (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionTracker getSelectionTracker() throws IOException, AutomationException
getSelectionTracker
in interface IElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean hitTest(double x, double y, double tolerance) throws IOException, AutomationException
HitTest returns a boolean value indicating whether or not the current element is intersected by the specified coordinate pair and tolerance distance. For instance, if we have a line element selected, the HitTest is determining whether that line element is within the specified tolerance from the given X and Y. A value of TRUE is returned if the element is within the tolerance, while FALSE is returned if it is not.
The X,Y, and tolerance values should be specified in map units.
hitTest
in interface IElement
x
- The x (in)y
- The y (in)tolerance
- The tolerance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(IDisplay display, ITrackCancel trackCancel) throws IOException, AutomationException
draw
in interface IElement
display
- A reference to a com.esri.arcgis.display.IDisplay (in)trackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void activate(IDisplay display) throws IOException, AutomationException
activate
in interface IElement
display
- A reference to a com.esri.arcgis.display.IDisplay (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deactivate() throws IOException, AutomationException
deactivate
in interface IElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isLocked() throws IOException, AutomationException
The Locked property indicates whether the specified element can be updated. This property can be set to TRUE to stop users from modifying a particular element.
isLocked
in interface IElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLocked(boolean pLocked) throws IOException, AutomationException
setLocked
in interface IElement
pLocked
- The pLocked (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
The Name property is used to store a name associated with the custom property assigned to the element.
getName
in interface IElementProperties
getName
in interface IElementProperties2
getName
in interface IElementProperties3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface IElementProperties
setName
in interface IElementProperties2
setName
in interface IElementProperties3
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getType() throws IOException, AutomationException
Type is a string used to specify the type of property that has been assigned to the element.
getType
in interface IElementProperties
getType
in interface IElementProperties2
getType
in interface IElementProperties3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setType(String name) throws IOException, AutomationException
setType
in interface IElementProperties
setType
in interface IElementProperties2
setType
in interface IElementProperties3
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAutoTransform() throws IOException, AutomationException
AutoTransform is a boolean values that indicates whether internal setings should be transformed along with the elements's geometry, when a transform is applied via ITransform2D. For instance, if I have a point element and I rotate it around a central location (the anchor point of the rotation being different from the point element iself), then the AutoTransform property is used to determine whether the orientation of the symbol associated to the element should also be rotated by the same amount.
isAutoTransform
in interface IElementProperties
isAutoTransform
in interface IElementProperties2
isAutoTransform
in interface IElementProperties3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAutoTransform(boolean autoTransform) throws IOException, AutomationException
setAutoTransform
in interface IElementProperties
setAutoTransform
in interface IElementProperties2
setAutoTransform
in interface IElementProperties3
autoTransform
- The autoTransform (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getCustomProperty() throws IOException, AutomationException
CustomProperty is a place for developers to attach custom objects to an element. Previous versions of the software required that the specified variant be of type VT_UNKNOWN, i.e. a reference to an object, but that requirement has since been removed. Now, the CustomProperty can also be a simple type like an integer, double, boolean (VARIANT_BOOL) or a string (BSTR).
When this property is an object reference, the object must implement a persistence interface, so if you write a custom object it must implement IPersistStream or IPersistVariant. As an alternative to writing a custom object, you can use a PropertySet or XMLPropertySet, since they both already implement IPersistStream.
CustomProperty is never used by the core ArcObjects for its own elements, but the core software will expect to find an IPersistStream or IPersistVariant interface when the this property is an object reference, and it is part of an element being retrieved from or stored in an .mxd file.
getCustomProperty
in interface IElementProperties
getCustomProperty
in interface IElementProperties2
getCustomProperty
in interface IElementProperties3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCustomProperty(Object customProperty) throws IOException, AutomationException
CustomProperty is a place for developers to attach custom objects to an element. Previous versions of the software required that the specified variant be of type VT_UNKNOWN, i.e. a reference to an object, but that requirement has since been removed. Now, the CustomProperty can also be a simple type like an integer, double, boolean (VARIANT_BOOL) or a string (BSTR).
When this property is an object reference, the object must implement a persistence interface, so if you write a custom object it must implement IPersistStream or IPersistVariant. As an alternative to writing a custom object, you can use a PropertySet or XMLPropertySet, since they both already implement IPersistStream.
CustomProperty is never used by the core ArcObjects for its own elements, but the core software will expect to find an IPersistStream or IPersistVariant interface when the this property is an object reference, and it is part of an element being retrieved from or stored in an .mxd file.
setCustomProperty
in interface IElementProperties
setCustomProperty
in interface IElementProperties2
setCustomProperty
in interface IElementProperties3
customProperty
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canRotate() throws IOException, AutomationException
canRotate
in interface IElementProperties2
canRotate
in interface IElementProperties3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getReferenceScale() throws IOException, AutomationException
getReferenceScale
in interface IElementProperties2
getReferenceScale
in interface IElementProperties3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setReferenceScale(double referenceScale) throws IOException, AutomationException
setReferenceScale
in interface IElementProperties2
setReferenceScale
in interface IElementProperties3
referenceScale
- The referenceScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int IElementProperties3_getAnchorPoint() throws IOException, AutomationException
IElementProperties3_getAnchorPoint
in interface IElementProperties3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAnchorPoint(int anchorPoint) throws IOException, AutomationException
setAnchorPoint
in interface IElementProperties3
anchorPoint
- A com.esri.arcgis.carto.esriAnchorPointEnum constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws IOException, AutomationException
getSpatialReference
in interface IElementProperties3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference spatialRef) throws IOException, AutomationException
setSpatialReferenceByRef
in interface IElementProperties3
spatialRef
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMap getMap() throws IOException, AutomationException
The Map property will return the map object contained within the frame. Use this interface when you want to get the map.
getMap
in interface IMapFrame
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
public void setMapByRef(IMap map) throws IOException, AutomationException
setMapByRef
in interface IMapFrame
map
- A reference to a com.esri.arcgis.carto.IMap (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public IGraphicsContainer getContainer() throws IOException, AutomationException
The Container property provides access to the PageLayout object that the MapFrame object resides within. The back pointer to the PageLayout is needed so that the container can be refreshed when the MapFrame is updated via a connection point (i.e., not through the PageLayout itself).
getContainer
in interface IMapFrame
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public void setContainerByRef(IGraphicsContainer container) throws IOException, AutomationException
setContainerByRef
in interface IMapFrame
container
- A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public int getExtentType() throws IOException, AutomationException
The ExtentType property is used to set or retrieve the method used to specify the extent of the map within the frame. There are three valid extent types that can be used:
getExtentType
in interface IMapFrame
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public void setExtentType(int type) throws IOException, AutomationException
setExtentType
in interface IMapFrame
type
- A com.esri.arcgis.carto.esriExtentTypeEnum constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public double getMapScale() throws IOException, AutomationException
The MapScale property returns or sets the current scale for the map. Use this property to obtain or update the scale. If updating the scale, be sure the ExtentType is set to esriExtentScale.
getMapScale
in interface IMapFrame
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public void setMapScale(double scale) throws IOException, AutomationException
setMapScale
in interface IMapFrame
scale
- The scale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public IEnvelope getMapBounds() throws IOException, AutomationException
The MapBounds property returns or sets the boundary (extent) of the map being shown in the frame. Use this property when you want to explicitly specify the coordinates of the data shown within the frame.
getMapBounds
in interface IMapFrame
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public void setMapBounds(IEnvelope bounds) throws IOException, AutomationException
setMapBounds
in interface IMapFrame
bounds
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public IMapSurroundFrame createSurroundFrame(IUID clsid, IMapSurround optionalStyle) throws IOException, AutomationException
CreateSurroundFrame is used to create a new map surround element (north arrow, scale bar, etc.) based on the current map frame. For instance, if I create a new scale bar with CreateSurroundFrame, the scale bar will be related to the map frame and updates to the map within the frame will be reflected in the scale bar.
Use this method when you want to create a new map surround object related to the current map frame.
THE CLSID paramter refers to the Class ID of the object that will be created and housed in the frame. Common Class IDs used in this paramter are:
{6589F147-F7F7-11d2-B872-00600802E603} AlternatingScaleBar
{6589F148-F7F7-11d2-B872-00600802E603} DoubleAlternatingScaleBar
{6589F143-F7F7-11d2-B872-00600802E603} HollowScaleBar
{7A3F91E4-B9E3-11d1-8756-0000F8751720} Legend
{7A3F91E3-B9E3-11d1-8756-0000F8751720} MapInset
{7A3F91DF-B9E3-11d1-8756-0000F8751720} MapTitle
{7A3F91DD-B9E3-11d1-8756-0000F8751720} MarkerNorthArrow
{7A3F91DE-B9E3-11d1-8756-0000F8751720} Overview
{6589F140-F7F7-11d2-B872-00600802E603} ScaleLine
{7A3F91DC-B9E3-11d1-8756-0000F8751720} ScaleText
{6589F146-F7F7-11d2-B872-00600802E603} SingleDivisionScaleBar
{6589F141-F7F7-11d2-B872-00600802E603} SteppedScaleLine
createSurroundFrame
in interface IMapFrame
clsid
- A reference to a com.esri.arcgis.system.IUID (in)optionalStyle
- A reference to a com.esri.arcgis.carto.IMapSurround (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addLocatorRectangle(ILocatorRectangle locator) throws IOException, AutomationException
AddLocatorRectangle is used to add a new locator rectangle to the current MapFrame. A locator rectangle represents the extent of another map frame in the page layout. Use this method to add a reference locator to the map frame.
addLocatorRectangle
in interface IMapFrame
locator
- A reference to a com.esri.arcgis.carto.ILocatorRectangle (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public void removeLocatorRectangle(ILocatorRectangle locator) throws IOException, AutomationException
RemoveLocatorRectangle is used to remove the specified locator from the MapFrame. Use this method when you have several locators in the frame and you only want to remove a specific one.
removeLocatorRectangle
in interface IMapFrame
locator
- A reference to a com.esri.arcgis.carto.ILocatorRectangle (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public void removeAllLocatorRectangles() throws IOException, AutomationException
RemoveAllLocatorRectangles is used to remove all of the locator rectangles within the MapFrame. Use this method when you have one or more locator rectangles and you want them deleted from the frame.
removeAllLocatorRectangles
in interface IMapFrame
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public int getLocatorRectangleCount() throws IOException, AutomationException
LocatorRectangleCount is used to return a count of all the locator rectangles within the MapFrame. Use this property to determine how many locator rectangles are in the frame.
getLocatorRectangleCount
in interface IMapFrame
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public ILocatorRectangle locatorRectangle(int index) throws IOException, AutomationException
LocatorRectangle can be used to retrieve the specified locator from the MapFrame. Use this method when you need to obtain a specific locator rectangle and you know the index number of that object within the frame.
locatorRectangle
in interface IMapFrame
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.MapFrame
,
IMapFrame.getMap()
,
IMapFrame
public Object getObject() throws IOException, AutomationException
Object returns the object contained within the frame. Once the object is returned, it is up to the developer to figure out what type of object it is. Use this property when you wish to perform an operation on the object within the frame.
getObject
in interface IFrameElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBorder getBorder() throws IOException, AutomationException
Border returns or sets the border property of the frame. Use this property when you want to change how the border around the frame is displayed.
getBorder
in interface IFrameElement
getBorder
in interface IFrameProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBorder(IBorder border) throws IOException, AutomationException
setBorder
in interface IFrameElement
setBorder
in interface IFrameProperties
border
- A reference to a com.esri.arcgis.carto.IBorder (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBackground getBackground() throws IOException, AutomationException
Background returns or sets the background displayed with the frame. Use this property when you want to change how the background is displayed, or you want to retrieve the current background.
getBackground
in interface IFrameElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBackground(IBackground background) throws IOException, AutomationException
setBackground
in interface IFrameElement
setBackground
in interface IFrameProperties
background
- A reference to a com.esri.arcgis.carto.IBackground (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getThumbnail() throws IOException, AutomationException
Thumbnail returns a small bitmap representation of the contents of the frame. Use this property when you want to obtain a bitmap of the frame for display in another control.
getThumbnail
in interface IFrameElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDraftMode() throws IOException, AutomationException
DraftMode set or returns a property that controls the speed and detail of the drawing of the frame. When DraftMode is set to TRUE, the contents of the frame will draw quicker but without as much detail. When the property is set to FALSE, the contents take longer to draw but include all the details.
isDraftMode
in interface IFrameElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDraftMode(boolean draftMode) throws IOException, AutomationException
setDraftMode
in interface IFrameElement
draftMode
- The draftMode (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGraphicsContainer getGraphicsContainer() throws IOException, AutomationException
getGraphicsContainer
in interface IGraphicsContainerProperty
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setGraphicsContainerByRef(IGraphicsContainer container) throws IOException, AutomationException
setGraphicsContainerByRef
in interface IGraphicsContainerProperty
container
- A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void drawBackground(IDisplay display, ITrackCancel cancelTracker) throws IOException, AutomationException
drawBackground
in interface IFrameDraw
display
- A reference to a com.esri.arcgis.display.IDisplay (in)cancelTracker
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void drawDraftMode(IDisplay display, ITrackCancel cancelTracker) throws IOException, AutomationException
drawDraftMode
in interface IFrameDraw
display
- A reference to a com.esri.arcgis.display.IDisplay (in)cancelTracker
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void drawForeground(IDisplay display, ITrackCancel cancelTracker) throws IOException, AutomationException
drawForeground
in interface IFrameDraw
display
- A reference to a com.esri.arcgis.display.IDisplay (in)cancelTracker
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumElement getGraphics(IDisplay display, Object data) throws IOException, AutomationException
getGraphics
in interface IGraphicsComposite
display
- A reference to a com.esri.arcgis.display.IDisplay (in)data
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) throws IOException, AutomationException
The Map object fires this event when a new document is loaded. Adding a new layer to a Map does not trigger this event.
The PageLayout object fires the event when IGraphicsContainer::DeleteAllElements in called and when a new document is loaded.
contentsChanged
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IActiveView.contentsChanged()
public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) throws IOException, AutomationException
contentsCleared
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void itemAdded(IActiveViewEventsItemAddedEvent theEvent) throws IOException, AutomationException
The Map fires the event every time a new layer is added.
The PageLayout fires this event whenever a new element is added to the layout. Elements include not only graphics but data frames as well.
itemAdded
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) throws IOException, AutomationException
The PageLayout object fires this event whenever elements are deleted from the layout.
The Map object fires this event when a layer is removed.
itemDeleted
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent) throws IOException, AutomationException
The Map objects only fire this event whenever IMap::MoveLayer is called. In the ArcMap application, this occurs when you reorder layers in the table of contents. The Map will also fire this event when new layers are added.
The PageLayout object fires this event when changing the order of graphics. For example, IGraphicsContainer::BringToFront, PutElementOrder, SendToBack, SendBackward, and BringForward all fire this event. These functions are on ArcMap's Drawing menu under the Order pull right menu. Although the Map object is also a graphics container, it does not fire this event when its graphics are reordered.
itemReordered
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) throws IOException, AutomationException
selectionChanged
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) throws IOException, AutomationException
Method that gets fired in response to IActiveView::Refresh and IActiveView::PartialRefresh.
This event is useful in the case where you're watching for something to change in the view and there aren't any specific events for that change (e.g. ContentsChanged, ItemAdded). You can always listen for this method as a last resort. Care must be taken however to be very efficient in your implementation of this event because it will be called quite often.
The event parameters directly coincide with the arguments to IActiveView::PartialRefresh. For additional information about the arguments, see the help for that method.
If the event object connects to both the layout and a map, then the view parameter tells you which object initiated the event.
In an implementation of this method you typically want to check the phase and respond to only one. Otherwise, your code will execute multiple times per drawing sequence.
viewRefreshed
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent) throws IOException, AutomationException
afterDraw
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) throws IOException, AutomationException
AfterItemDraw can be used to execute after each individual item has drawn. Event firing can be an expensive operation (time consuming) when there are many layers in a map, however. As a result, the AfterItemDraw event is only fired when the IViewManger::VerboseEvents property is set to True. By default this property is False.
afterItemDraw
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) throws IOException, AutomationException
focusMapChanged
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) throws IOException, AutomationException
spatialReferenceChanged
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void displayStarted(IDisplayEventsDisplayStartedEvent theEvent) throws IOException, AutomationException
IDisplay::StartDrawing fires this event to notify clients that drawing has started. The display where drawing was initiated is returned.
displayStarted
in interface IDisplayEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void displayFinished(IDisplayEventsDisplayFinishedEvent theEvent) throws IOException, AutomationException
IDisplay::FinishDrawing fires this event to notify clients that drawing has completed. The display where drawing has completed is returned to the client.
displayFinished
in interface IDisplayEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void displayInvalidated(IDisplayEventsDisplayInvalidatedEvent theEvent) throws IOException, AutomationException
IScreenDisplay::Invalidate fires this event to notify all clients a display has been invalidated. The display, the area invalidated, the erase setting, and the cacheID are all returned to clients listening to this event.
The Map object is one client that listens for this event and it may in turn fire the IActiveViewEvenets::ViewRefreshed event.
displayInvalidated
in interface IDisplayEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void displayScrolled(IDisplayEventsDisplayScrolledEvent theEvent) throws IOException, AutomationException
IScreenDisplay::DoScroll fires this event to notify all clients that the display has scrolled. For example, the Map object listens for this event because it needs to perform some drawing operations whenever its display is scrolled.
displayScrolled
in interface IDisplayEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent) throws IOException, AutomationException
boundsUpdated
in interface ITransformEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent) throws IOException, AutomationException
visibleBoundsUpdated
in interface ITransformEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent) throws IOException, AutomationException
deviceFrameUpdated
in interface ITransformEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent) throws IOException, AutomationException
resolutionUpdated
in interface ITransformEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent) throws IOException, AutomationException
rotationUpdated
in interface ITransformEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent) throws IOException, AutomationException
unitsUpdated
in interface ITransformEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUsesFilter() throws IOException, AutomationException
The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.
isUsesFilter
in interface IDisplayAdmin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMapGridCount() throws IOException, AutomationException
MapGridCount will return then number of grids (graticules) attached to the MapFrame.
getMapGridCount
in interface IMapGrids
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMapGrid getMapGrid(int index) throws IOException, AutomationException
getMapGrid
in interface IMapGrids
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapGrid(int index, IMapGrid mapGrid) throws IOException, AutomationException
setMapGrid
in interface IMapGrids
index
- The index (in)mapGrid
- A reference to a com.esri.arcgis.carto.IMapGrid (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addMapGrid(IMapGrid mapGrid) throws IOException, AutomationException
AddMapGrid will add a new MapGrid to the MapFrame. Use this interface when you have a valid IMapGrid object that you want to associate a MapFrame object.
addMapGrid
in interface IMapGrids
mapGrid
- A reference to a com.esri.arcgis.carto.IMapGrid (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteMapGrid(IMapGrid mapGrid) throws IOException, AutomationException
DeleteMapGrid is used to remove the specified IMapGrid from the MapFrame. After executing the method, you still have a valid IMapGrid that could then be added to a different MapFrame.
deleteMapGrid
in interface IMapGrids
mapGrid
- A reference to a com.esri.arcgis.carto.IMapGrid (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clearMapGrids() throws IOException, AutomationException
ClearMapGrids will remove all associated grids (graticules) from the MapFrame. Use this method when you want to programmatically remove all associated MapGrids from the MapFrame.
clearMapGrids
in interface IMapGrids
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean applies(Object pUnk) throws IOException, AutomationException
Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.
CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.
applies
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canApply(Object pUnk) throws IOException, AutomationException
CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.
CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.
canApply
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getCurrent(Object pUnk) throws IOException, AutomationException
getCurrent
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object apply(Object newObject) throws IOException, AutomationException
Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.
Use the Applies and CanApply methods to determine if an Apply can be used on an object.
apply
in interface IPropertySupport
newObject
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws IOException, AutomationException
esri_clone
in interface IClone
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws IOException, AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws IOException, AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void move(double dx, double dy) throws IOException, AutomationException
Moves the Geometry dX units along the X-Axis and dY units along the Y-Axis. Only changes the position of the Geometry without altering any of the other characteristics. Move is a spatial offset.
move
in interface ITransform2D
dx
- The dx (in)dy
- The dy (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void moveVector(ILine v) throws IOException, AutomationException
Moves the Geometry dX units along the X-Axis and dY units along the Y-Axis, where dX and dY are calculated from the input vector Line. Only the Length and Angle of the vector affect the transformation. The location of the vector does not change the transformation. Only changes the position of the Geometry without altering any of the other characteristics. Move is a spatial offset.
moveVector
in interface ITransform2D
v
- A reference to a com.esri.arcgis.geometry.ILine (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void scale(IPoint origin, double sx, double sy) throws IOException, AutomationException
Stretches the Geometry a factor of sX along the X-Axis and a factor of sY along the Y-Axis (where sX is the ratio of Old Width to New Width, and sY is the ratio of Old Height to New Height). The Origin point is the reference Point from which the transformation is performed (Regardless of the location of the Origin point, the Geometry resulting from the transformation is the same, except for a positional offset). The Origin is the only point in the transformation guaranted to remain in the same location after the transformation is complete.
Note: Caution must be taken when scaling a CircularArc or a geometry containing CircularArc segments. Unless Abs(ScaleX) = Abs(ScaleY), the resulting CircularArcs will not retain the characteristics of the original geometry (since they remain CircularArcs).
scale
in interface ITransform2D
origin
- A reference to a com.esri.arcgis.geometry.IPoint (in)sx
- The sx (in)sy
- The sy (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void rotate(IPoint origin, double rotationAngle) throws IOException, AutomationException
Rotate performs an angular transform (rotation) on the Geometry. The Origin is the only point in the transformation guaranteed to remain in the same location after the transformation is performed. Regardless of the Origin, the transformed Geometry is the same, except for a positional offset. The RotationAngle is measured in radians.
An Envelope cannot be Rotated.
rotate
in interface ITransform2D
origin
- A reference to a com.esri.arcgis.geometry.IPoint (in)rotationAngle
- The rotationAngle (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void transform(int direction, ITransformation transformation) throws IOException, AutomationException
transform
in interface ITransform2D
direction
- A com.esri.arcgis.geometry.esriTransformDirection constant (in)transformation
- A reference to a com.esri.arcgis.geometry.ITransformation (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isFixedAspectRatio() throws IOException, AutomationException
isFixedAspectRatio
in interface IBoundsProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFixedAspectRatio(boolean flag) throws IOException, AutomationException
setFixedAspectRatio
in interface IBoundsProperties
flag
- The flag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isFixedSize() throws IOException, AutomationException
isFixedSize
in interface IBoundsProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum) throws IOException, AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints
in interface IConnectionPointContainer
ppEnum
- A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) throws IOException, AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint
in interface IConnectionPointContainer
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)ppCP
- A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBackground IFrameProperties_getBackground() throws IOException, AutomationException
IFrameProperties_getBackground
in interface IFrameProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IShadow getShadow() throws IOException, AutomationException
getShadow
in interface IFrameProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShadow(IShadow shadow) throws IOException, AutomationException
setShadow
in interface IFrameProperties
shadow
- A reference to a com.esri.arcgis.carto.IShadow (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |