Package com.jidesoft.dialog
Class PageEvent
- java.lang.Object
-
- java.util.EventObject
-
- com.jidesoft.dialog.PageEvent
-
- All Implemented Interfaces:
java.io.Serializable
public class PageEvent extends java.util.EventObject
AnEventObject
that adds support forAbstractPage
objects as the event source.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static int
PAGE_CLOSED
This event is delivered when the page is closed.static int
PAGE_CLOSING
This event is delivered when the page is about to close.static int
PAGE_EVENT_FIRST
The first number in the range of IDs used forAbstractPage
events.static int
PAGE_EVENT_LAST
The last number in the range of IDs used forAbstractPage
events.static int
PAGE_OPENED
This event is delivered when the the data becomes invalid.
-
Constructor Summary
Constructors Constructor Description PageEvent(java.lang.Object source, int id)
Constructs anAbstractPageEvent
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getID()
Returns the event type.java.lang.String
paramString()
Returns a parameter string identifying this event.void
setID(int id)
Sets the event type.java.lang.String
toString()
-
-
-
Field Detail
-
PAGE_EVENT_FIRST
public static final int PAGE_EVENT_FIRST
The first number in the range of IDs used forAbstractPage
events.- See Also:
- Constant Field Values
-
PAGE_EVENT_LAST
public static final int PAGE_EVENT_LAST
The last number in the range of IDs used forAbstractPage
events.- See Also:
- Constant Field Values
-
PAGE_OPENED
public static final int PAGE_OPENED
This event is delivered when the the data becomes invalid.- See Also:
- Constant Field Values
-
PAGE_CLOSING
public static final int PAGE_CLOSING
This event is delivered when the page is about to close. This event can be listened if you want to do some validation on the page before it is closed. If it fails the validation, you can callAbstractPage#setAllowClosing(false)
to stop the closing process. The source of the event will tell you which button originated the page closing event. For example, in the Wizard, the next button, the previous button, the cancel button or the finish button all can trigger page closing event. The event's source will be the actual button. You can call button.getName() and compare it with the predefined button names defined inButtonNames
to find out which button it is.- See Also:
- Constant Field Values
-
PAGE_CLOSED
public static final int PAGE_CLOSED
This event is delivered when the page is closed.- See Also:
- Constant Field Values
-
-
Method Detail
-
getID
public int getID()
Returns the event type.- Returns:
- event id.
-
setID
public void setID(int id)
Sets the event type.- Parameters:
id
- the new event type.
-
paramString
public java.lang.String paramString()
Returns a parameter string identifying this event. This method is useful for event logging and for debugging.- Returns:
- a string identifying the event and its attributes
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.util.EventObject
-
-