com.esri.arcgis.framework
Class ComPropertySheet

java.lang.Object
  com.esri.arcgis.framework.ComPropertySheet

All Implemented Interfaces:

IConnectionPointContainer, IComPropertyPageSite, IComPropertySheet, IComPropertySheetID, IPropertyPageSite, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ComPropertySheet
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IComPropertySheet, IConnectionPointContainer, IComPropertyPageSite, IPropertyPageSite, IComPropertySheetID

COM Property Sheet Object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.framework.IComPropertyPageSite

IID, IID3b81f6f1_54a0_11d3_b8c3_00600802e603, xxDummy

Constructor Summary

ComPropertySheet()
Constructs a ComPropertySheet using ArcGIS Engine.

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

Method Summary

void	addCategoryID(IUID category) Adds a new Category ID used to look up COM property pages.
void	addIComPropertySheetEventsListener(IComPropertySheetEvents theListener) addIComPropertySheetEventsListener.
void	addPage(Object page) Manually adds a page to the property sheet.
boolean	canEdit(ISet objects) Indicates if this object can edit the given set of objects.
void	clearCategoryIDs() Clears the category IDs used to look up COM property pages.
boolean	editProperties(ISet objects, int hWnd) Displays a property sheet for the given set of objects and returns a flag indicating if the objects changed.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
short	getActivePage() The zero-based index of the page that is active.
static String	getClsid() getClsid.
void	getLocaleID(int[] pLocaleID) getLocaleID
void	getPageContainer(Object[] ppUnk) getPageContainer
String	getRegistryKey() Registry key for sheet settings.
String	getTitle() The title of the property sheet.
int	hashCode() the hashcode for this object
boolean	isDisableCancelButton() Indicates if the Cancel button is disabled on the property sheet.
boolean	isHideApplyButton() Indicates if the Apply button is visible on the property sheet.
boolean	isHideHelpButton() Indicates if the Help button is visible on the property sheet.
void	onStatusChange(int dwFlags) onStatusChange
void	pageChanged() Called by the property page to let the property sheet know that something changed.
void	removeIComPropertySheetEventsListener(IComPropertySheetEvents theListener) removeIComPropertySheetEventsListener.
void	setActivePage(short index) The zero-based index of the page that is active.
void	setDisableCancelButton(boolean disableButton) Indicates if the Cancel button is disabled on the property sheet.
void	setHideApplyButton(boolean hideApplyButton) Indicates if the Apply button is visible on the property sheet.
void	setHideHelpButton(boolean hideHelpButton) Indicates if the Help button is visible on the property sheet.
void	setRegistryKey(String idStr) Registry key for sheet settings.
void	setTitle(String title) The title of the property sheet.
void	translateAccelerator(tagMSG pMsg) translateAccelerator

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

ComPropertySheet

public ComPropertySheet()
                 throws IOException,
                        UnknownHostException

Constructs a ComPropertySheet using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ComPropertySheet

public ComPropertySheet(Object obj)
                 throws IOException

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

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

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

addIComPropertySheetEventsListener

public void addIComPropertySheetEventsListener(IComPropertySheetEvents theListener)
                                        throws IOException

addIComPropertySheetEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.systemUI.IComPropertySheetEvents interface.

Throws:

IOException - If there are communications problems.

removeIComPropertySheetEventsListener

public void removeIComPropertySheetEventsListener(IComPropertySheetEvents theListener)
                                           throws IOException

removeIComPropertySheetEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.systemUI.IComPropertySheetEvents interface.

Throws:

IOException - If there are communications problems.

setTitle

public void setTitle(String title)
              throws IOException,
                     AutomationException

The title of the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setTitle in interface IComPropertySheet

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

public String getTitle()
                throws IOException,
                       AutomationException

The title of the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getTitle in interface IComPropertySheet

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActivePage

public void setActivePage(short index)
                   throws IOException,
                          AutomationException

The zero-based index of the page that is active.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setActivePage in interface IComPropertySheet

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivePage

public short getActivePage()
                    throws IOException,
                           AutomationException

The zero-based index of the page that is active.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getActivePage in interface IComPropertySheet

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisableCancelButton

public void setDisableCancelButton(boolean disableButton)
                            throws IOException,
                                   AutomationException

Indicates if the Cancel button is disabled on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDisableCancelButton in interface IComPropertySheet

Parameters:

disableButton - The disableButton (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisableCancelButton

public boolean isDisableCancelButton()
                              throws IOException,
                                     AutomationException

Indicates if the Cancel button is disabled on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isDisableCancelButton in interface IComPropertySheet

Returns:

The disableButton

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideApplyButton

public void setHideApplyButton(boolean hideApplyButton)
                        throws IOException,
                               AutomationException

Indicates if the Apply button is visible on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setHideApplyButton in interface IComPropertySheet

Parameters:

hideApplyButton - The hideApplyButton (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideApplyButton

public boolean isHideApplyButton()
                          throws IOException,
                                 AutomationException

Indicates if the Apply button is visible on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isHideApplyButton in interface IComPropertySheet

Returns:

The hideApplyButton

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideHelpButton

public void setHideHelpButton(boolean hideHelpButton)
                       throws IOException,
                              AutomationException

Indicates if the Help button is visible on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setHideHelpButton in interface IComPropertySheet

Parameters:

hideHelpButton - The hideHelpButton (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideHelpButton

public boolean isHideHelpButton()
                         throws IOException,
                                AutomationException

Indicates if the Help button is visible on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isHideHelpButton in interface IComPropertySheet

Returns:

The hideHelpButton

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addCategoryID

public void addCategoryID(IUID category)
                   throws IOException,
                          AutomationException

Adds a new Category ID used to look up COM property pages.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addCategoryID in interface IComPropertySheet

Parameters:

category - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearCategoryIDs

public void clearCategoryIDs()
                      throws IOException,
                             AutomationException

Clears the category IDs used to look up COM property pages.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

clearCategoryIDs in interface IComPropertySheet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addPage

public void addPage(Object page)
             throws IOException,
                    AutomationException

Manually adds a page to the property sheet. Page must implement IComPropertyPage or IPropertyPage.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addPage in interface IComPropertySheet

Parameters:

page - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canEdit

public boolean canEdit(ISet objects)
                throws IOException,
                       AutomationException

Indicates if this object can edit the given set of objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canEdit in interface IComPropertySheet

Parameters:

objects - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editProperties

public boolean editProperties(ISet objects,
                              int hWnd)
                       throws IOException,
                              AutomationException

Displays a property sheet for the given set of objects and returns a flag indicating if the objects changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

editProperties in interface IComPropertySheet

Parameters:

objects - A reference to a com.esri.arcgis.system.ISet (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer 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:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer 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:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pageChanged

public void pageChanged()
                 throws IOException,
                        AutomationException

Called by the property page to let the property sheet know that something changed.

Specified by:

pageChanged in interface IComPropertyPageSite

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStatusChange

public void onStatusChange(int dwFlags)
                    throws IOException,
                           AutomationException

onStatusChange

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onStatusChange in interface IPropertyPageSite

Parameters:

dwFlags - The dwFlags (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocaleID

public void getLocaleID(int[] pLocaleID)
                 throws IOException,
                        AutomationException

getLocaleID

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLocaleID in interface IPropertyPageSite

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageContainer

public void getPageContainer(Object[] ppUnk)
                      throws IOException,
                             AutomationException

getPageContainer

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPageContainer in interface IPropertyPageSite

Parameters:

ppUnk - A reference to another Object (IUnknown) (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

translateAccelerator

public void translateAccelerator(tagMSG pMsg)
                          throws IOException,
                                 AutomationException

translateAccelerator

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

translateAccelerator in interface IPropertyPageSite

Parameters:

pMsg - A Structure: com.esri.arcgis.framework.tagMSG (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRegistryKey

public void setRegistryKey(String idStr)
                    throws IOException,
                           AutomationException

Registry key for sheet settings.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setRegistryKey in interface IComPropertySheetID

Parameters:

idStr - The idStr (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRegistryKey

public String getRegistryKey()
                      throws IOException,
                             AutomationException

Registry key for sheet settings.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getRegistryKey in interface IComPropertySheetID

Returns:

The idStr

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.