com.esri.arcgis.carto
Class Jp2PictureElement

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

All Implemented Interfaces:

IBoundsProperties, IElement, IElementProperties, IElementProperties2, IElementProperties3, IFrameDraw, IFrameElement, IFrameProperties, IGraphicElement, IOlePictureElement, IPictureElement, IPictureElement2, IPictureElement3, IPictureElement4, ITransform2D, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable

public class Jp2PictureElement
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IElement, IElementProperties, IElementProperties2, IElementProperties3, IFrameElement, IFrameDraw, IFrameProperties, IPictureElement, IPictureElement2, IPictureElement3, IPictureElement4, IGraphicElement, IBoundsProperties, IOlePictureElement, ITransform2D, IPropertySupport, IPersistStream, IClone, Externalizable

Graphic Element to display JPEG2000 Pictures.

Description

This object is new at ArcGIS 9.3.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

Jp2PictureElement()
Constructs a Jp2PictureElement using ArcGIS Engine.

Jp2PictureElement(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Jp2PictureElement theJp2PictureElement = (Jp2PictureElement) obj;

Method Summary

void	activate(IDisplay display) Prepare to display graphic on screen.
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.
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	deactivate() ActiveView that graphics are displayed on is no longer visible.
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(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 String	getClsid() getClsid.
Object	getCurrent(Object pUnk) The object currently being used.
Object	getCustomProperty() Custom property.
String	getFilter() Filter used in CFileDialog.
IGeometry	getGeometry() Shape of the element as a geometry.
int	getHandle() The picture handle as a HBITMAP for bitmap pictures or an HENHMETAFILE for vector pictures.
String	getName() Name of the element.
Object	getObject() Object framed by this element.
String	getPath() Associated picture file.
double	getPictureAspectRatio() Filter used in CFileDialog.
String	getPictureDescription() Description of the Picture 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.
void	importPicture(Picture pictureDisp) Import Picture from an IPictureDisp interface.
void	importPictureFromFile(String name) File to be imported.
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	isMaintainAspectRatio() Indicates if the resize box will maintain the picture's aspect ratio.
boolean	isSavePictureInDocument() Indicates if the Picture will be stored in the Document.
boolean	isVector() Indicates whether picture is a vector format as opposed to raster.
void	load(IStream pstm) load
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	queryIntrinsicSize(double[] widthPoints, double[] heightPoints) Get the intrinsic size of the picture in points.
void	queryOutline(IDisplay display, IPolygon outline) Bounds of the element taking symbology into consideration.
void	readExternal(ObjectInput in)
void	rotate(IPoint origin, double rotationAngle) Rotates about the specified origin point.
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(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	setMaintainAspectRatio(boolean bRatio) Indicates if the resize box will maintain the picture's aspect ratio.
void	setName(String name) Name of the element.
void	setPath(String path) Associated picture file.
void	setReferenceScale(double referenceScale) Reference scale of the element.
void	setSavePictureInDocument(boolean bSaveInDoc) Indicates if the Picture will be stored in the Document.
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	transform(int direction, ITransformation transformation) Applies an arbitrary transformation.
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

Jp2PictureElement

public Jp2PictureElement()
                  throws IOException,
                         UnknownHostException

Constructs a Jp2PictureElement using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

Jp2PictureElement

public Jp2PictureElement(Object obj)
                  throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getGeometry

public IGeometry getGeometry()
                      throws IOException,
                             AutomationException

Shape of the element as a geometry.

Description

Geometry is the shape assigned to this element.

Remarks

The Geometry property will return the shape associated with the element as an IGeometry. The geometry type of objects implementing IElement varies widely depending on what the element does. The remarks of each object implementing IElement will list the geometry types that are valid for that specific element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGeometry in interface IElement

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometry

public void setGeometry(IGeometry pGeometry)
                 throws IOException,
                        AutomationException

Shape of the element as a geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGeometry in interface IElement

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBounds

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

Bounds of the element taking symbology into consideration.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryOutline

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

Bounds of the element taking symbology into consideration.

Remarks

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionTracker

public ISelectionTracker getSelectionTracker()
                                      throws IOException,
                                             AutomationException

Selection tracker used by this element.

Remarks

SelectionTracker returns the ISelectionTracker used by the element. Elements have associated selection tracker objects which provide reshaping functionality. For example, in ArcMap after adding an element, the element is drawn with a selection tracker around it and users can then drag one of the selection handles on the selection tracker to modify the element's shape.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSelectionTracker in interface IElement

Returns:

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

Throws:

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 IOException,
                       AutomationException

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

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

hitTest in interface IElement

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The hit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

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

Draws the element into the given display object.

Remarks

Draw draws the element to the screen display specified. An ITrackerCancel object can be passed in to enable cancelation of the draw wit the ESC key.

Symbolization of the element during the draw is based on the symbol that is stored with it. For instance, Marker Elements are displayed based on the Symbol property on the IMarkerElement interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IDisplay display)
              throws IOException,
                     AutomationException

Prepare to display graphic on screen.

Remarks

Activate prepares the screen display for output and orients the scale of the element to the specified display. Activate should be executed with the current display before execute the IElement::Draw method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

activate in interface IElement

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException

ActiveView that graphics are displayed on is no longer visible.

Remarks

Deactivate means the screen display associated with element output is no longer visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deactivate in interface IElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLocked

public boolean isLocked()
                 throws IOException,
                        AutomationException

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

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isLocked in interface IElement

Returns:

The pLocked

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocked

public void setLocked(boolean pLocked)
               throws IOException,
                      AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLocked in interface IElement

Parameters:

pLocked - The pLocked (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the element.

Remarks

The Name property is used to store a name associated with the custom property assigned to the element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IElementProperties

Specified by:

getName in interface IElementProperties2

Specified by:

getName in interface IElementProperties3

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IElementProperties

Specified by:

setName in interface IElementProperties2

Specified by:

setName in interface IElementProperties3

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public String getType()
               throws IOException,
                      AutomationException

Type of the element.

Remarks

Type is a string used to specify the type of property that has been assigned to the element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IElementProperties

Specified by:

getType in interface IElementProperties2

Specified by:

getType in interface IElementProperties3

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(String name)
             throws IOException,
                    AutomationException

Type of the element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setType in interface IElementProperties

Specified by:

setType in interface IElementProperties2

Specified by:

setType in interface IElementProperties3

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoTransform

public boolean isAutoTransform()
                        throws IOException,
                               AutomationException

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

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAutoTransform in interface IElementProperties

Specified by:

isAutoTransform in interface IElementProperties2

Specified by:

isAutoTransform in interface IElementProperties3

Returns:

The autoTransform

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoTransform

public void setAutoTransform(boolean autoTransform)
                      throws IOException,
                             AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAutoTransform in interface IElementProperties

Specified by:

setAutoTransform in interface IElementProperties2

Specified by:

setAutoTransform in interface IElementProperties3

Parameters:

autoTransform - The autoTransform (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException

Custom property.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCustomProperty in interface IElementProperties

Specified by:

getCustomProperty in interface IElementProperties2

Specified by:

getCustomProperty in interface IElementProperties3

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object customProperty)
                       throws IOException,
                              AutomationException

Custom property.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCustomProperty in interface IElementProperties

Specified by:

setCustomProperty in interface IElementProperties2

Specified by:

setCustomProperty in interface IElementProperties3

Parameters:

customProperty - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRotate

public boolean canRotate()
                  throws IOException,
                         AutomationException

Indicates if the element can be rotated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

canRotate in interface IElementProperties2

Specified by:

canRotate in interface IElementProperties3

Returns:

The canRotate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws IOException,
                                AutomationException

Reference scale of the element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceScale in interface IElementProperties2

Specified by:

getReferenceScale in interface IElementProperties3

Returns:

The referenceScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double referenceScale)
                       throws IOException,
                              AutomationException

Reference scale of the element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceScale in interface IElementProperties2

Specified by:

setReferenceScale in interface IElementProperties3

Parameters:

referenceScale - The referenceScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IElementProperties3_getAnchorPoint

public int IElementProperties3_getAnchorPoint()
                                       throws IOException,
                                              AutomationException

Anchor point of the element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

IElementProperties3_getAnchorPoint in interface IElementProperties3

Returns:

A com.esri.arcgis.carto.esriAnchorPointEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

public void setAnchorPoint(int anchorPoint)
                    throws IOException,
                           AutomationException

Anchor point of the element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setAnchorPoint in interface IElementProperties3

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

Spatial reference of the container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSpatialReference in interface IElementProperties3

Specified by:

getSpatialReference in interface IGraphicElement

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws IOException,
                                     AutomationException

Spatial reference of the container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSpatialReferenceByRef in interface IElementProperties3

Specified by:

setSpatialReferenceByRef in interface IGraphicElement

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

public Object getObject()
                 throws IOException,
                        AutomationException

Object framed by this element.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getObject in interface IFrameElement

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBorder

public IBorder getBorder()
                  throws IOException,
                         AutomationException

Frame border used by this element.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBorder in interface IFrameElement

Specified by:

getBorder in interface IFrameProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBorder

public void setBorder(IBorder border)
               throws IOException,
                      AutomationException

Frame border used by this element.

Description

Use this to set or return the Border property of an object of type IFrameElement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

public IBackground getBackground()
                          throws IOException,
                                 AutomationException

Frame background used by this element.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackground in interface IFrameElement

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(IBackground background)
                   throws IOException,
                          AutomationException

Frame background used by this element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

public int getThumbnail()
                 throws IOException,
                        AutomationException

Small bitmap representation of this element.

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getThumbnail in interface IFrameElement

Returns:

The bitmapHandle (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDraftMode

public boolean isDraftMode()
                    throws IOException,
                           AutomationException

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

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDraftMode in interface IFrameElement

Returns:

The draftMode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDraftMode

public void setDraftMode(boolean draftMode)
                  throws IOException,
                         AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDraftMode in interface IFrameElement

Parameters:

draftMode - The draftMode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawBackground

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

Draw the frame's shadow and background.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawDraftMode

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

Draw the draft mode representation of the frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawForeground

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

Draw the frame's border.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IFrameProperties_getBackground

public IBackground IFrameProperties_getBackground()
                                           throws IOException,
                                                  AutomationException

Frame background used by this element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

IFrameProperties_getBackground in interface IFrameProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShadow

public IShadow getShadow()
                  throws IOException,
                         AutomationException

Frame shadow used by this element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShadow in interface IFrameProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadow

public void setShadow(IShadow shadow)
               throws IOException,
                      AutomationException

Frame shadow used by this element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadow in interface IFrameProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPictureDescription

public String getPictureDescription()
                             throws IOException,
                                    AutomationException

Description of the Picture Element.

Remarks

PictureDescription will return a description of the picture within the PictureElement. For instance, a bitmap picture might return the description "Windows Bitmap".

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPictureDescription in interface IPictureElement

Specified by:

getPictureDescription in interface IPictureElement2

Specified by:

getPictureDescription in interface IPictureElement3

Specified by:

getPictureDescription in interface IPictureElement4

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public String getFilter()
                 throws IOException,
                        AutomationException

Filter used in CFileDialog.

Remarks

Filter returns the filter used when executing the ImportPictureFromFile method. For instance, if we have an EmfPictureElement, then the filter is "Windows Enhance Metafile (*.emf)|*.emf|". Only files that match the filter can be imported into the object.

The Filter property can be used to determine if the PictureElement is a BmpPictureElement or an EmfPictureElement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilter in interface IPictureElement

Specified by:

getFilter in interface IPictureElement2

Specified by:

getFilter in interface IPictureElement3

Specified by:

getFilter in interface IPictureElement4

Returns:

The filter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPictureAspectRatio

public double getPictureAspectRatio()
                             throws IOException,
                                    AutomationException

Filter used in CFileDialog.

Remarks

PictureAspectRatio returns the ratio of the x and y parameters of the picture. The ratio is calculated by dividing the x length of the picture by the y length.

The PictureAspectRatio can only be manipulated through the user interface and only when the MaintainAspectRatio property is set to False.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPictureAspectRatio in interface IPictureElement

Specified by:

getPictureAspectRatio in interface IPictureElement2

Specified by:

getPictureAspectRatio in interface IPictureElement3

Specified by:

getPictureAspectRatio in interface IPictureElement4

Returns:

The ratio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMaintainAspectRatio

public boolean isMaintainAspectRatio()
                              throws IOException,
                                     AutomationException

Indicates if the resize box will maintain the picture's aspect ratio.

Remarks

MaintainAspectRatio specifies whether the ratio between the x and y lengths (width and height) of the picture need to be maintained when resizing. If the MaintainAspectRatio property is set to False, the width and height of the picture can be adjusted independently. If the property is True, then the width and height can only be manipulated together to maintain the same ratio.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isMaintainAspectRatio in interface IPictureElement

Specified by:

isMaintainAspectRatio in interface IPictureElement2

Specified by:

isMaintainAspectRatio in interface IPictureElement3

Specified by:

isMaintainAspectRatio in interface IPictureElement4

Returns:

The bRatio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaintainAspectRatio

public void setMaintainAspectRatio(boolean bRatio)
                            throws IOException,
                                   AutomationException

Indicates if the resize box will maintain the picture's aspect ratio.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaintainAspectRatio in interface IPictureElement

Specified by:

setMaintainAspectRatio in interface IPictureElement2

Specified by:

setMaintainAspectRatio in interface IPictureElement3

Specified by:

setMaintainAspectRatio in interface IPictureElement4

Parameters:

bRatio - The bRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSavePictureInDocument

public boolean isSavePictureInDocument()
                                throws IOException,
                                       AutomationException

Indicates if the Picture will be stored in the Document.

Remarks

SavePictureInDocument specifies whether the actual picture is saved in the document, or a link to the file on disk. If you want to be sure a picture in your document does not change, then you would set the SavePictureInDocument option to True.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSavePictureInDocument in interface IPictureElement

Specified by:

isSavePictureInDocument in interface IPictureElement2

Specified by:

isSavePictureInDocument in interface IPictureElement3

Specified by:

isSavePictureInDocument in interface IPictureElement4

Returns:

The bSaveInDoc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSavePictureInDocument

public void setSavePictureInDocument(boolean bSaveInDoc)
                              throws IOException,
                                     AutomationException

Indicates if the Picture will be stored in the Document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSavePictureInDocument in interface IPictureElement

Specified by:

setSavePictureInDocument in interface IPictureElement2

Specified by:

setSavePictureInDocument in interface IPictureElement3

Specified by:

setSavePictureInDocument in interface IPictureElement4

Parameters:

bSaveInDoc - The bSaveInDoc (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importPictureFromFile

public void importPictureFromFile(String name)
                           throws IOException,
                                  AutomationException

File to be imported.

Remarks

ImportPictureFromFile allows for updating the PictureElement based on a file of the proper format. The Filter property is used to screen the files being loaded through ImportPictureFromFile to make sure they are of the correct type. The Filter property is based on the picture element object being manipulated (either a BmpPictureElement or an EmfPictureElement).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

importPictureFromFile in interface IPictureElement

Specified by:

importPictureFromFile in interface IPictureElement2

Specified by:

importPictureFromFile in interface IPictureElement3

Specified by:

importPictureFromFile in interface IPictureElement4

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryIntrinsicSize

public void queryIntrinsicSize(double[] widthPoints,
                               double[] heightPoints)
                        throws IOException,
                               AutomationException

Get the intrinsic size of the picture in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

queryIntrinsicSize in interface IPictureElement2

Specified by:

queryIntrinsicSize in interface IPictureElement3

Specified by:

queryIntrinsicSize in interface IPictureElement4

Parameters:

widthPoints - The widthPoints (in/out: use single element array)

heightPoints - The heightPoints (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVector

public boolean isVector()
                 throws IOException,
                        AutomationException

Indicates whether picture is a vector format as opposed to raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isVector in interface IPictureElement2

Specified by:

isVector in interface IPictureElement3

Specified by:

isVector in interface IPictureElement4

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHandle

public int getHandle()
              throws IOException,
                     AutomationException

The picture handle as a HBITMAP for bitmap pictures or an HENHMETAFILE for vector pictures.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getHandle in interface IPictureElement3

Specified by:

getHandle in interface IPictureElement4

Returns:

The handle (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(String path)
             throws IOException,
                    AutomationException

Associated picture file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setPath in interface IPictureElement4

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

Associated picture file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getPath in interface IPictureElement4

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedAspectRatio

public boolean isFixedAspectRatio()
                           throws IOException,
                                  AutomationException

Indicates if the bounds has a fixed aspect ratio.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFixedAspectRatio in interface IBoundsProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFixedAspectRatio

public void setFixedAspectRatio(boolean flag)
                         throws IOException,
                                AutomationException

Indicates if the bounds has a fixed aspect ratio.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFixedAspectRatio in interface IBoundsProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedSize

public boolean isFixedSize()
                    throws IOException,
                           AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFixedSize in interface IBoundsProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importPicture

public void importPicture(Picture pictureDisp)
                   throws IOException,
                          AutomationException

Import Picture from an IPictureDisp interface.

Remarks

ImportPicture is used to load a picture into a BmpPictureElement or a EmfPictureElement through an OLE IPictureDisp. To load a picture from a file, use IPictureElement::ImportPictureFromFile.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

importPicture in interface IOlePictureElement

Parameters:

pictureDisp - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

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

Moves dx units horizontally and dy units vertically.

Description

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.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

move in interface ITransform2D

Parameters:

dx - The dx (in)

dy - The dy (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveVector

public void moveVector(ILine v)
                throws IOException,
                       AutomationException

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

Description

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.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

moveVector in interface ITransform2D

Parameters:

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

Throws:

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

Description

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.

Remarks

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotate

public void rotate(IPoint origin,
                   double rotationAngle)
            throws 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.

Description

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.

Remarks

An Envelope cannot be Rotated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

rotate in interface ITransform2D

Parameters:

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

rotationAngle - The rotationAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform

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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

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

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

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

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

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

Remarks

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

apply in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException