Side of Software
Wizard Library 1.6

sos.wizard
Interface PageEditor

All Known Implementing Classes:
AbstractPageEditor

public interface PageEditor

An object that controls the editing of a page. When the client invokes getEditorComponent, the editing implicitly starts and continues until cancelEditing or stopEditing is called.

Since:
1.0
See Also:
Page

Method Summary
 void cancelEditing()
          Cancels the editing.
 java.awt.Component getEditorComponent(javax.swing.JComponent c, Page page)
          Starts editing the specified component's page and returns the component that will do the rendering.
 boolean stopEditing()
          Stops and validates the editing.
 

Method Detail

cancelEditing

public void cancelEditing()
Cancels the editing.

See Also:
stopEditing()

getEditorComponent

public java.awt.Component getEditorComponent(javax.swing.JComponent c,
                                             Page page)
Starts editing the specified component's page and returns the component that will do the rendering.

Parameters:
c - component containing page
page - page to be edited
Returns:
the component that will do the rendering

stopEditing

public boolean stopEditing()
Stops and validates the editing. Returns true if the editing is successfully stopped.

Returns:
true if the editing is successfully stopped
See Also:
cancelEditing()

Side of Software
Wizard Library 1.6

Copyright 2004-07 Side of Software (SOS). All rights reserved.