com.esri.arcgis.arcmapui
Class IMSPropsPropertyPage

java.lang.Object
  extended by com.esri.arcgis.arcmapui.IMSPropsPropertyPage
All Implemented Interfaces:
IComPropertyPage, IComPropertyPage2, IPropertyPage, IPropertyPageContext, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class IMSPropsPropertyPage
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPropertyPage, IPropertyPageContext, IComPropertyPage, IComPropertyPage2

IMS properties property page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.framework.IComPropertyPage
IID, IID76951cc6_dbb1_11d2_b868_00600802e603, xxDummy
 
Constructor Summary
IMSPropsPropertyPage()
          Constructs a IMSPropsPropertyPage using ArcGIS Engine.
IMSPropsPropertyPage(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
IMSPropsPropertyPage theIMSPropsPropertyPage = (IMSPropsPropertyPage) obj;
 
Method Summary
 void activate(_RemotableHandle hWndParent, tagRECT pRect, int bModal)
          activate
 int activate()
          Occurs on page creation.
 boolean applies(ISet objects)
          Indicates if the page applies to the specified objects.
 boolean applies(Object unkArray)
          Check if property page applies to the specified set of objects.
 void apply()
          apply
 void cancel()
          Property sheet calls this when cancel button is pressed.
 Object createCompatibleObject(Object kind)
          Create a new object using the specified object as a template.
 void deactivate()
          deactivate
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getHeight()
          The height of the page in pixels.
 int getHelpContextID(int controlID)
          The help context ID for the specified control on the page.
 String getHelpFile()
          The help file name for the page.
 String getHelpFile(int controlID)
          Returns the help file name for the specified control.
 int getHelpId(int controlID)
          Returns the help ID for the specified control.
 void getPageInfo(tagPROPPAGEINFO[] pPageInfo)
          getPageInfo
 int getPriority()
          The page's priority relative to other pages that interact with the same object.
 String getTitle()
          The title of the property page.
 int getWidth()
          The width of the page in pixels.
 int hashCode()
          the hashcode for this object
 void help(String pszHelpDir)
          help
 void hide()
          Hides the page.
 boolean IComPropertyPage_isPageDirty()
          Indicates if the page made any changes to the object(s).
 boolean IComPropertyPage2_isPageDirty()
          Indicates if the page made any changes to the object(s).
 void isPageDirty()
          isPageDirty
 void move(tagRECT pRect)
          move
 boolean queryCancel()
          Returns VARIANT_FALSE to prevent the cancel operation or VARIANT_TRUE to allow it.
 void queryObject(Object theObject)
          Apply the property page settings to the specified object.
 void setObjects(int cObjects, Object[] ppUnk)
          setObjects
 void setObjects(ISet objects)
          Supplies the page with the object(s) to be edited.
 void setPageSite(IPropertyPageSite pPageSite)
          setPageSite
 void setPageSiteByRef(IComPropertyPageSite rhs1)
          The sheet that contains the page.
 void setPriority(int priority)
          The page priority.
 void setTitle(String title)
          The title of the property page.
 void show()
          Shows the page.
 void show(int nCmdShow)
          show
 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

IMSPropsPropertyPage

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

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

IMSPropsPropertyPage

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

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

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

setPageSite

public void setPageSite(IPropertyPageSite pPageSite)
                 throws IOException,
                        AutomationException
setPageSite

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setPageSite in interface IPropertyPage
Parameters:
pPageSite - A reference to a com.esri.arcgis.framework.IPropertyPageSite (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

public void activate(_RemotableHandle hWndParent,
                     tagRECT pRect,
                     int bModal)
              throws IOException,
                     AutomationException
activate

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
activate in interface IPropertyPage
Parameters:
hWndParent - A Structure: com.esri.arcgis.framework._RemotableHandle (A com.esri.arcgis.framework._RemotableHandle COM typedef) (in)
pRect - A Structure: com.esri.arcgis.system.tagRECT (in)
bModal - The bModal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException
deactivate

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
deactivate in interface IComPropertyPage
Specified by:
deactivate in interface IComPropertyPage2
Specified by:
deactivate in interface IPropertyPage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageInfo

public void getPageInfo(tagPROPPAGEINFO[] pPageInfo)
                 throws IOException,
                        AutomationException
getPageInfo

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getPageInfo in interface IPropertyPage
Parameters:
pPageInfo - A Structure: com.esri.arcgis.framework.tagPROPPAGEINFO (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjects

public void setObjects(int cObjects,
                       Object[] ppUnk)
                throws IOException,
                       AutomationException
setObjects

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setObjects in interface IPropertyPage
Parameters:
cObjects - The cObjects (in)
ppUnk - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

show

public void show(int nCmdShow)
          throws IOException,
                 AutomationException
show

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
show in interface IPropertyPage
Parameters:
nCmdShow - The nCmdShow (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

move

public void move(tagRECT pRect)
          throws IOException,
                 AutomationException
move

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
move in interface IPropertyPage
Parameters:
pRect - A Structure: com.esri.arcgis.system.tagRECT (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPageDirty

public void isPageDirty()
                 throws IOException,
                        AutomationException
isPageDirty

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isPageDirty in interface IPropertyPage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

public void apply()
           throws IOException,
                  AutomationException
apply

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
apply in interface IComPropertyPage
Specified by:
apply in interface IComPropertyPage2
Specified by:
apply in interface IPropertyPage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

help

public void help(String pszHelpDir)
          throws IOException,
                 AutomationException
help

Description

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
help in interface IPropertyPage
Parameters:
pszHelpDir - A String (in)
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

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

getPriority

public int getPriority()
                throws IOException,
                       AutomationException
The page's priority relative to other pages that interact with the same object. The higher the value, the higher the priority.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getPriority in interface IComPropertyPage
Specified by:
getPriority in interface IComPropertyPage2
Specified by:
getPriority in interface IPropertyPageContext
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object unkArray)
                throws IOException,
                       AutomationException
Check if property page applies to the specified set of objects. Signature corresponds to IPropertyPage::SetObjects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
applies in interface IPropertyPageContext
Parameters:
unkArray - A Variant (in)
Returns:
The applies
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createCompatibleObject

public Object createCompatibleObject(Object kind)
                              throws IOException,
                                     AutomationException
Create a new object using the specified object as a template. The kind argument may be NULL if the page interacts with only a single object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
createCompatibleObject in interface IPropertyPageContext
Parameters:
kind - A Variant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryObject

public void queryObject(Object theObject)
                 throws IOException,
                        AutomationException
Apply the property page settings to the specified object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
queryObject in interface IPropertyPageContext
Parameters:
theObject - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile(int controlID)
                   throws IOException,
                          AutomationException
Returns the help file name for the specified control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getHelpFile in interface IPropertyPageContext
Parameters:
controlID - The controlID (in)
Returns:
The helpFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpId

public int getHelpId(int controlID)
              throws IOException,
                     AutomationException
Returns the help ID for the specified control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getHelpId in interface IPropertyPageContext
Parameters:
controlID - The controlID (in)
Returns:
The helpID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws IOException,
                   AutomationException
Property sheet calls this when cancel button is pressed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
cancel in interface IComPropertyPage
Specified by:
cancel in interface IComPropertyPage2
Specified by:
cancel in interface IPropertyPageContext
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(String title)
              throws IOException,
                     AutomationException
The title of the property page.

Specified by:
setTitle in interface IComPropertyPage
Specified by:
setTitle in interface IComPropertyPage2
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 page.

Specified by:
getTitle in interface IComPropertyPage
Specified by:
getTitle in interface IComPropertyPage2
Returns:
The title
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriority

public void setPriority(int priority)
                 throws IOException,
                        AutomationException
The page priority. The higher the priority, the sooner the page appears in the containing property sheet.

Specified by:
setPriority in interface IComPropertyPage
Specified by:
setPriority in interface IComPropertyPage2
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException
The width of the page in pixels.

Specified by:
getWidth in interface IComPropertyPage
Specified by:
getWidth in interface IComPropertyPage2
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException
The height of the page in pixels.

Specified by:
getHeight in interface IComPropertyPage
Specified by:
getHeight in interface IComPropertyPage2
Returns:
The height
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPageSiteByRef

public void setPageSiteByRef(IComPropertyPageSite rhs1)
                      throws IOException,
                             AutomationException
The sheet that contains the page.

Specified by:
setPageSiteByRef in interface IComPropertyPage
Specified by:
setPageSiteByRef in interface IComPropertyPage2
Parameters:
rhs1 - A reference to a com.esri.arcgis.framework.IComPropertyPageSite (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

IComPropertyPage_isPageDirty

public boolean IComPropertyPage_isPageDirty()
                                     throws IOException,
                                            AutomationException
Indicates if the page made any changes to the object(s).

Specified by:
IComPropertyPage_isPageDirty in interface IComPropertyPage
Returns:
The isDirty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException
The help file name for the page.

Specified by:
getHelpFile in interface IComPropertyPage
Specified by:
getHelpFile in interface IComPropertyPage2
Returns:
The helpFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID(int controlID)
                     throws IOException,
                            AutomationException
The help context ID for the specified control on the page.

Specified by:
getHelpContextID in interface IComPropertyPage
Specified by:
getHelpContextID in interface IComPropertyPage2
Parameters:
controlID - The controlID (in)
Returns:
The helpID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

public int activate()
             throws IOException,
                    AutomationException
Occurs on page creation. Return the hWnd of the page here.

Specified by:
activate in interface IComPropertyPage
Specified by:
activate in interface IComPropertyPage2
Returns:
The hWnd (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(ISet objects)
                throws IOException,
                       AutomationException
Indicates if the page applies to the specified objects.

Specified by:
applies in interface IComPropertyPage
Specified by:
applies in interface IComPropertyPage2
Parameters:
objects - A reference to a com.esri.arcgis.system.ISet (in)
Returns:
The pApplies
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjects

public void setObjects(ISet objects)
                throws IOException,
                       AutomationException
Supplies the page with the object(s) to be edited.

Specified by:
setObjects in interface IComPropertyPage
Specified by:
setObjects in interface IComPropertyPage2
Parameters:
objects - A reference to a com.esri.arcgis.system.ISet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

show

public void show()
          throws IOException,
                 AutomationException
Shows the page.

Specified by:
show in interface IComPropertyPage
Specified by:
show in interface IComPropertyPage2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hide

public void hide()
          throws IOException,
                 AutomationException
Hides the page.

Specified by:
hide in interface IComPropertyPage
Specified by:
hide in interface IComPropertyPage2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

IComPropertyPage2_isPageDirty

public boolean IComPropertyPage2_isPageDirty()
                                      throws IOException,
                                             AutomationException
Indicates if the page made any changes to the object(s).

Product Availability

Available with ArcGIS Desktop.

Specified by:
IComPropertyPage2_isPageDirty in interface IComPropertyPage2
Returns:
The isDirty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryCancel

public boolean queryCancel()
                    throws IOException,
                           AutomationException
Returns VARIANT_FALSE to prevent the cancel operation or VARIANT_TRUE to allow it.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
queryCancel in interface IComPropertyPage2
Returns:
The queryCancel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.