|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.PortalEvent
public class PortalEvent
Events which may be arguments to the IChannel receiveEvent() method.
Field Summary | |
---|---|
static PortalEvent |
ABOUT_BUTTON
The layout-generated event that is sent to a channel when the user actuates its about control. |
static int |
ABOUT_BUTTON_EVENT
|
static PortalEvent |
DETACH_BUTTON
The layout-generated event that is sent to a channel when the user actuates its detach control. |
static int |
DETACH_BUTTON_EVENT
|
static PortalEvent |
EDIT_BUTTON
The layout-generated event that is sent to a channel when the user actuates its edit control. |
static int |
EDIT_BUTTON_EVENT
|
private java.lang.String |
eventName
String representation of the event. |
private int |
eventNumber
Integer representation of an event. |
static PortalEvent |
HELP_BUTTON
The layout-generated event that is sent to a channel when the user actuates its help control. |
static int |
HELP_BUTTON_EVENT
|
static PortalEvent |
MAXIMIZE
The layout-generated event that is sent to a channel when the user actuates its maximize control. |
static int |
MAXIMIZE_EVENT
|
static PortalEvent |
MINIMIZE
The layout-generated event that is sent to a channel when the user actuates its minimize control. |
static int |
MINIMIZE_EVENT
|
static int |
SESSION_DONE
|
static PortalEvent |
SESSION_DONE_EVENT
The framework-generated event that is broadcast to channels that were used for a user session which is now ending. |
private PortalEventSource |
source
Source of the event -- curently either FRAMEWORK or LAYOUT. |
static int |
UNSUBSCRIBE
|
static PortalEvent |
UNSUBSCRIBE_EVENT
The framework-generated event that is sent to a channel when the user unsubscribes from that channel. |
Constructor Summary | |
---|---|
|
PortalEvent(int ev)
Deprecated. instead reference one of the static singleton events. |
private |
PortalEvent(int eventNumber,
java.lang.String eventName,
PortalEventSource source)
Construct a PortalEvent instance from parameters. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object other)
Two PortalEvents are equal if they have the same eventNumber. |
java.lang.String |
getEventName()
Get a String representing this event. |
int |
getEventNumber()
Get an integer representing this event. |
PortalEventSource |
getSource()
Get the source type of this event. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int SESSION_DONE
public static final int UNSUBSCRIBE
public static final int EDIT_BUTTON_EVENT
public static final int HELP_BUTTON_EVENT
public static final int ABOUT_BUTTON_EVENT
public static final int DETACH_BUTTON_EVENT
public static final int MINIMIZE_EVENT
public static final int MAXIMIZE_EVENT
public static final PortalEvent SESSION_DONE_EVENT
public static final PortalEvent UNSUBSCRIBE_EVENT
public static final PortalEvent EDIT_BUTTON
public static final PortalEvent HELP_BUTTON
public static final PortalEvent ABOUT_BUTTON
public static final PortalEvent DETACH_BUTTON
public static final PortalEvent MINIMIZE
public static final PortalEvent MAXIMIZE
private final int eventNumber
private final java.lang.String eventName
private final PortalEventSource source
Constructor Detail |
---|
public PortalEvent(int ev)
ev
- integer representing the eventprivate PortalEvent(int eventNumber, java.lang.String eventName, PortalEventSource source)
eventNumber
- - integer representation of event typeeventName
- - String name of eventsource
- - source type of eventMethod Detail |
---|
public java.lang.String getEventName()
public int getEventNumber()
public PortalEventSource getSource()
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- - another object
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |