com.esri.arcgis.arcmapui
Class LayersClipboardFormat

java.lang.Object
  extended by com.esri.arcgis.arcmapui.LayersClipboardFormat
All Implemented Interfaces:
IClipboardFormat, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class LayersClipboardFormat
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClipboardFormat

ESRI Layers Clipboard format.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
LayersClipboardFormat()
          Constructs a LayersClipboardFormat using ArcGIS Engine.
LayersClipboardFormat(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LayersClipboardFormat theLayersClipboardFormat = (LayersClipboardFormat) obj;
 
Method Summary
 void copy(IMxDocument mxDocument)
          Copy selection to the Clipboard.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 void getDescription(String[] description)
          Description of the Clipboard format.
 void getFormat(int[] format)
          The Clipboard Format.
 void getPriority(short[] priority)
          Priority of the Clipboard format for Paste (1 to 100, 100 highest priority).
 void getStorageMedium(int[] tymed)
          StorageMedium for Paste.
 int hashCode()
          the hashcode for this object
 void paste(IMxDocument mxDocument)
          Paste the Element in the GraphicsContainer to the Clipboard.
 
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

LayersClipboardFormat

public LayersClipboardFormat()
                      throws IOException,
                             UnknownHostException
Constructs a LayersClipboardFormat using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

LayersClipboardFormat

public LayersClipboardFormat(Object obj)
                      throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LayersClipboardFormat theLayersClipboardFormat = (LayersClipboardFormat) obj;

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

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

getFormat

public void getFormat(int[] format)
               throws IOException,
                      AutomationException
The Clipboard Format.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getFormat in interface IClipboardFormat
Parameters:
format - The format (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

public void getPriority(short[] priority)
                 throws IOException,
                        AutomationException
Priority of the Clipboard format for Paste (1 to 100, 100 highest priority).

Product Availability

Available with ArcGIS Desktop.

Specified by:
getPriority in interface IClipboardFormat
Parameters:
priority - The priority (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public void getDescription(String[] description)
                    throws IOException,
                           AutomationException
Description of the Clipboard format.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getDescription in interface IClipboardFormat
Parameters:
description - The description (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStorageMedium

public void getStorageMedium(int[] tymed)
                      throws IOException,
                             AutomationException
StorageMedium for Paste. (Look up the C++ TYMED enumeration on MSDN for details).

Product Availability

Available with ArcGIS Desktop.

Specified by:
getStorageMedium in interface IClipboardFormat
Parameters:
tymed - The tymed (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IMxDocument mxDocument)
          throws IOException,
                 AutomationException
Copy selection to the Clipboard.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
copy in interface IClipboardFormat
Parameters:
mxDocument - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

paste

public void paste(IMxDocument mxDocument)
           throws IOException,
                  AutomationException
Paste the Element in the GraphicsContainer to the Clipboard.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
paste in interface IClipboardFormat
Parameters:
mxDocument - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.