Eclipse Platform
Release 3.3

org.eclipse.jface.dialogs
Class PageChangingEvent

java.lang.Object
  extended byjava.util.EventObject
      extended byorg.eclipse.jface.dialogs.PageChangingEvent
All Implemented Interfaces:
Serializable

public class PageChangingEvent
extends EventObject

Event object describing an IDialogPage in the midst of changing.

Since:
3.3
See Also:
IPageChangingListener, Serialized Form

Field Summary
 boolean doit
          Public field that dictates if the page change will successfully change.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
PageChangingEvent(Object source, Object currentPage, Object targetPage)
          Creates a new event for the given source, selected (current) page and direction.
 
Method Summary
 Object getCurrentPage()
          Returns the current page from which the page change originates.
 Object getTargetPage()
          Returns the target page to change to.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

doit

public boolean doit
Public field that dictates if the page change will successfully change. Set this field to false to prevent the page from changing. Default value is true.

Constructor Detail

PageChangingEvent

public PageChangingEvent(Object source,
                         Object currentPage,
                         Object targetPage)
Creates a new event for the given source, selected (current) page and direction.

Parameters:
source - the page changing provider (the source of this event)
currentPage - the current page. In the JFace provided dialogs this will be an IDialogPage.
targetPage - the target page. In the JFace provided dialogs this will be an IDialogPage.
Method Detail

getCurrentPage

public Object getCurrentPage()
Returns the current page from which the page change originates.

Returns:
the current page. In dialogs implemented by JFace, this will be an IDialogPage.

getTargetPage

public Object getTargetPage()
Returns the target page to change to.

Returns:
the target page. In dialogs implemented by JFace, this will be an IDialogPage.

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.