com.esri.arcgis.framework
Class BasePropertyPage

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

All Implemented Interfaces:

IComPropertyPage, Serializable

Direct Known Subclasses:

BaseCustomLayerPropertyPage, BaseCustomRendererPropertyPage, BaseSOEPropertyPage

public abstract class BasePropertyPage
extends Object
implements IComPropertyPage

See Also:

Serialized Form

Field Summary

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

IID, IID76951cc6_dbb1_11d2_b868_00600802e603, xxDummy

Constructor Summary

BasePropertyPage()

Method Summary

int	activate() Occurs on page creation.
abstract boolean	applies(ISet objects) Indicates if the page applies to the specified objects.
abstract void	apply() Applies any changes to the object(s).
void	cancel() Cancels the changes to the object(s).
void	deactivate() Destroys the page.
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.
abstract int	getPriority() The page priority.
abstract String	getTitle() The title of the property page.
int	getWidth() The width of the page in pixels.
void	hide() Hides the page.
boolean	IComPropertyPage_isPageDirty() Indicates if the page made any changes to the object(s).
abstract JFrame	initGUI()
void	pageChanged() Informs ArcGIS that the state of a Java property page has changed and that the "Apply" button on the property sheet should be enabled.
void	repaintJFrame()
abstract void	setObjects(ISet objects) Supplies the page with the object(s) to be edited.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePropertyPage

public BasePropertyPage()

Method Detail

repaintJFrame

public final void repaintJFrame()

initGUI

public abstract JFrame initGUI()

activate

public final int activate()
                   throws IOException,
                          AutomationException

Occurs on page creation. Return the hWnd of the page here.

Specified by:

activate in interface IComPropertyPage

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public abstract boolean applies(ISet objects)
                         throws IOException,
                                AutomationException

Indicates if the page applies to the specified objects.

Specified by:

applies in interface IComPropertyPage

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.

apply

public abstract void apply()
                    throws IOException,
                           AutomationException

Applies any changes to the object(s).

Specified by:

apply in interface IComPropertyPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

public abstract String getTitle()
                         throws IOException,
                                AutomationException

The title of the property page.

Specified by:

getTitle in interface IComPropertyPage

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

public final void cancel()
                  throws IOException,
                         AutomationException

Cancels the changes to the object(s).

Specified by:

cancel in interface IComPropertyPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public final void deactivate()
                      throws IOException,
                             AutomationException

Destroys the page.

Specified by:

deactivate in interface IComPropertyPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public final int getHeight()
                    throws IOException,
                           AutomationException

The height of the page in pixels.

Specified by:

getHeight in interface IComPropertyPage

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public final int getHelpContextID(int controlID)
                           throws IOException,
                                  AutomationException

The help context ID for the specified control on the page.

Specified by:

getHelpContextID in interface IComPropertyPage

Parameters:

controlID - The controlID (in)

Returns:

The helpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public final String getHelpFile()
                         throws IOException,
                                AutomationException

The help file name for the page.

Specified by:

getHelpFile in interface IComPropertyPage

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

public abstract int getPriority()
                         throws IOException,
                                AutomationException

The page priority. The higher the priority, the sooner the page appears in the containing property sheet.

Specified by:

getPriority in interface IComPropertyPage

Returns:

The priority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public final int getWidth()
                   throws IOException,
                          AutomationException

The width of the page in pixels.

Specified by:

getWidth in interface IComPropertyPage

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

public final void hide()
                throws IOException,
                       AutomationException

Hides the page.

Specified by:

hide in interface IComPropertyPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public final void show()
                throws IOException,
                       AutomationException

Shows the page.

Specified by:

show in interface IComPropertyPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IComPropertyPage_isPageDirty

public final 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.

setObjects

public abstract void setObjects(ISet objects)
                         throws IOException,
                                AutomationException

Supplies the page with the object(s) to be edited.

Specified by:

setObjects in interface IComPropertyPage

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.

setPageSiteByRef

public final void setPageSiteByRef(IComPropertyPageSite rhs1)
                            throws IOException,
                                   AutomationException

The sheet that contains the page.

Specified by:

setPageSiteByRef in interface IComPropertyPage

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.

pageChanged

public final void pageChanged()
                       throws IOException,
                              AutomationException

Informs ArcGIS that the state of a Java property page has changed and that the "Apply" button on the property sheet should be enabled.

Throws:

IOException

AutomationException

setPriority

public final 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

Parameters:

priority - The priority (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

public final void setTitle(String title)
                    throws IOException,
                           AutomationException

The title of the property page.

Specified by:

setTitle in interface IComPropertyPage

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.