com.novell.application.console.snapin
Interface PropertyBook

public interface PropertyBook

Provides services for page snap-ins.

This interface is implemented by the ConsoleOne Property Book to service page snap-ins. A reference to the Property Book is passed at the time the page snap-in is initialized.

See Also:

PageSnapin

Method Summary

void	abort() Tells the PropertyBook to abort the startup sequence and return false from initPages().
java.awt.Component	getComponent() Returns the PropertyBook Component
java.util.Enumeration	getPages() Returns the set of propertyPages in this PropertyBook
int	getPressedButton() Returns the pressed button
void	mandatoryCanSave(PageSnapin p) Indicates a snapin whos canSave() must be called even if not dirty.
void	setComplainingPage(PageSnapin p) Set the page to be shown after canSave returns false
void	setModified(boolean isDirty, PageSnapin theSnapin) Indicates to the Property Book that your snap-in data has changed.
void	setTitle(java.lang.String title) Sets the title of the current property page.
void	showThisPage(PageSnapin thePage) Tells the PropertyBook to change the current page to thePage.

Method Detail

setModified

public void setModified(boolean isDirty,
                        PageSnapin theSnapin)

Indicates to the Property Book that your snap-in data has changed.

Call setModified() when you want the OK and Apply Now buttons to be enabled. You should not call setModified() until after successfully returning true from initSnapin().

Parameters:

isDirty - Boolean set to true when data needs to be saved, or false when data has already been saved.

theSnapin - Reference to the page snap-in. The this value references the current page that has focus.

setTitle

public void setTitle(java.lang.String title)

Sets the title of the current property page.

The setTitle() method allows you to update the title of the property page.

Parameters:

title - The title of the property page.

getPages

public java.util.Enumeration getPages()

Returns the set of propertyPages in this PropertyBook

showThisPage

public void showThisPage(PageSnapin thePage)

Tells the PropertyBook to change the current page to thePage.

abort

public void abort()

Tells the PropertyBook to abort the startup sequence and return false from initPages().

getComponent

public java.awt.Component getComponent()

Returns the PropertyBook Component

getPressedButton

public int getPressedButton()

Returns the pressed button

setComplainingPage

public void setComplainingPage(PageSnapin p)

Set the page to be shown after canSave returns false

mandatoryCanSave

public void mandatoryCanSave(PageSnapin p)

Indicates a snapin whos canSave() must be called even if not dirty.