com.esri.arcgis.arcmapui
Class LayersClipboardFormat

java.lang.Object
  com.esri.arcgis.arcmapui.LayersClipboardFormat

All Implemented Interfaces:

IClipboardFormat, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'LayersClipboardFormat'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description 'Esri Layers Clipboard format.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.arcmapui.IClipboardFormat

IID, IID52bb5361_947e_11d2_acff_0000f87808ee, xxDummy

Constructor Summary

LayersClipboardFormat()
Constructs a LayersClipboardFormat using ArcGIS Engine.

LayersClipboardFormat(java.lang.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(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
void	getDescription(java.lang.String[] description) Description of the Clipboard format.
void	getFormat(int[] format) The Clipboard Format.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
void	release() Release a LayersClipboardFormat.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayersClipboardFormat

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

Constructs a LayersClipboardFormat using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LayersClipboardFormat

public LayersClipboardFormat(java.lang.Object obj)
                      throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a LayersClipboardFormat.

Specified by:

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

getFormat

public void getFormat(int[] format)
               throws java.io.IOException,
                      AutomationException

The Clipboard Format.

Specified by:

getFormat in interface IClipboardFormat

Parameters:

format - The format (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPriority

public void getPriority(short[] priority)
                 throws java.io.IOException,
                        AutomationException

Priority of the Clipboard format for Paste (1 to 100, 100 highest priority).

Specified by:

getPriority in interface IClipboardFormat

Parameters:

priority - The priority (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

public void getDescription(java.lang.String[] description)
                    throws java.io.IOException,
                           AutomationException

Description of the Clipboard format.

Specified by:

getDescription in interface IClipboardFormat

Parameters:

description - The description (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStorageMedium

public void getStorageMedium(int[] tymed)
                      throws java.io.IOException,
                             AutomationException

StorageMedium for Paste. (Look up the C++ TYMED enumeration on MSDN for details).

Specified by:

getStorageMedium in interface IClipboardFormat

Parameters:

tymed - The tymed (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IMxDocument mxDocument)
          throws java.io.IOException,
                 AutomationException

Copy selection to the Clipboard.

Specified by:

copy in interface IClipboardFormat

Parameters:

mxDocument - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

paste

public void paste(IMxDocument mxDocument)
           throws java.io.IOException,
                  AutomationException

Paste the Element in the GraphicsContainer to the Clipboard.

Specified by:

paste in interface IClipboardFormat

Parameters:

mxDocument - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.