com.ibm.lpex.core
Class LpexViewAdapter

java.lang.Object
  com.ibm.lpex.core.LpexViewAdapter

All Implemented Interfaces:

LpexViewListener

Direct Known Subclasses:

CursorHairline, MouseReselect

public abstract class LpexViewAdapter
extends Object
implements LpexViewListener

Abstract adapter class for receiving document view event notifications. The methods in this class are empty, and do not stop any of the editor actions for which the events are issued.

This is a convenience class for creating view listener objects. Extend this class to create a document view listener, and override only the methods for the events of interest. If you implement the LpexViewListener interface, you have to define all its methods; this abstract class defines null methods for all of them, so you must define methods only for those events you care about. This also eliminates the need for coding updates if new event notifications are defined in LpexViewListener.

Create a listener object using your class, and then register it with a document view using the view's addLpexViewListener() method. When an event occurs, the relevant method in the listener object is invoked. Example:

 
 lpexView.addLpexViewListener(new LpexViewAdapter() {
  // called after the updateProfile command has completed 
  public void updateProfile(LpexView view)
  {
   handleUpdateProfile(view);
  }
 }); 

See Also:

LpexView.addLpexViewListener(com.ibm.lpex.core.LpexViewListener)

Constructor Summary

LpexViewAdapter()

Method Summary

void	disposed(LpexView lpexView) This method is invoked when the document view is disposed.
void	readonly(LpexView lpexView) This method is invoked after an attempt has been made to edit a read-only document.
void	renamed(LpexView lpexView) This method is invoked after the document name, source name, or view id has changed.
boolean	renaming(LpexView lpexView) This method is invoked just before the document or source name is changed.
void	saved(LpexView lpexView) This method is invoked after the document has been saved by the LPEX widget.
boolean	saving(LpexView lpexView) This method is invoked just before the document is saved by the LPEX widget.
void	showing(LpexView lpexView) This method is invoked just before the screen is displayed.
void	shown(LpexView lpexView) This method is invoked after the screen display is complete.
void	updateProfile(LpexView lpexView) This method is invoked after the updateProfile editor command has completed processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

LpexViewAdapter

public LpexViewAdapter()

Method Detail

showing

public void showing(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked just before the screen is displayed. The screen is rebuilt and displayed after every user action. It is also rebuilt and displayed when the screenShow editor command is issued.

Specified by:

showing in interface LpexViewListener

See Also:

LpexViewListener.shown(com.ibm.lpex.core.LpexView)

shown

public void shown(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked after the screen display is complete.

Specified by:

shown in interface LpexViewListener

See Also:

LpexViewListener.showing(com.ibm.lpex.core.LpexView)

saving

public boolean saving(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked just before the document is saved by the LPEX widget. If you return true, then the remaining listeners will not be invoked and the save will be aborted.

This notification is not issued for "save as" operations. Also, an LPEX-based application may do its own save, bypassing the widget's save to the local file system.

Specified by:

saving in interface LpexViewListener

See Also:

LpexViewListener.saved(com.ibm.lpex.core.LpexView)

saved

public void saved(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked after the document has been saved by the LPEX widget.

This notification is not issued for "save as" operations. Also, an LPEX-based application may do its own save, bypassing the widget's save to the local file system.

Specified by:

saved in interface LpexViewListener

See Also:

LpexViewListener.saving(com.ibm.lpex.core.LpexView)

renaming

public boolean renaming(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked just before the document or source name is changed. If you return true, then the remaining listeners will not be invoked and the rename will be aborted.

Specified by:

renaming in interface LpexViewListener

See Also:

LpexViewListener.renamed(com.ibm.lpex.core.LpexView)

renamed

public void renamed(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked after the document name, source name, or view id has changed.

Specified by:

renamed in interface LpexViewListener

See Also:

LpexViewListener.renaming(com.ibm.lpex.core.LpexView)

readonly

public void readonly(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked after an attempt has been made to edit a read-only document.

Specified by:

readonly in interface LpexViewListener

updateProfile

public void updateProfile(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked after the updateProfile editor command has completed processing.

Specified by:

updateProfile in interface LpexViewListener

disposed

public void disposed(LpexView lpexView)

Description copied from interface: LpexViewListener

This method is invoked when the document view is disposed.

Specified by:

disposed in interface LpexViewListener