com.esri.arcgis.cartoUI
Class CFDataSourcePageExtension

java.lang.Object
  extended by com.esri.arcgis.cartoUI.CFDataSourcePageExtension
All Implemented Interfaces:
ICFDataSourcePageExtension, IFeatureLayerSourcePageExtension, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class CFDataSourcePageExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureLayerSourcePageExtension, ICFDataSourcePageExtension, IPersist, IPersistStream, Externalizable

.

Product Availability

Available with ArcGIS Desktop.

See Also:
Serialized Form

Constructor Summary
CFDataSourcePageExtension()
          Constructs a CFDataSourcePageExtension using ArcGIS Engine.
CFDataSourcePageExtension(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CFDataSourcePageExtension theCFDataSourcePageExtension = (CFDataSourcePageExtension) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 String getDescription(IFeatureLayer pLayer)
          The default description text.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 boolean isDataSourceReadOnly()
          Indicates if the data source can be changed.
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setDataSourceReadOnly(boolean flag)
          Indicates if the data source can be changed.
 void setDescription(IFeatureLayer pLayer, String text)
          The default description text.
 void showDialog(IFeatureLayer pLayer, int parentHWnd)
          Shows a custom dialog to change the data source.
 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

CFDataSourcePageExtension

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

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

CFDataSourcePageExtension

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

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

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

setDescription

public void setDescription(IFeatureLayer pLayer,
                           String text)
                    throws IOException,
                           AutomationException
The default description text.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setDescription in interface IFeatureLayerSourcePageExtension
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
text - The text (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription(IFeatureLayer pLayer)
                      throws IOException,
                             AutomationException
The default description text.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getDescription in interface IFeatureLayerSourcePageExtension
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showDialog

public void showDialog(IFeatureLayer pLayer,
                       int parentHWnd)
                throws IOException,
                       AutomationException
Shows a custom dialog to change the data source.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
showDialog in interface IFeatureLayerSourcePageExtension
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
parentHWnd - The parentHWnd (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDataSourceReadOnly

public boolean isDataSourceReadOnly()
                             throws IOException,
                                    AutomationException
Indicates if the data source can be changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isDataSourceReadOnly in interface ICFDataSourcePageExtension
Specified by:
isDataSourceReadOnly in interface IFeatureLayerSourcePageExtension
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSourceReadOnly

public void setDataSourceReadOnly(boolean flag)
                           throws IOException,
                                  AutomationException
Indicates if the data source can be changed.

Product Availability

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

Specified by:
setDataSourceReadOnly in interface ICFDataSourcePageExtension
Parameters:
flag - The flag (in)
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.

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.

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