com.cc.framework.ui.model
Class ClientEvent

java.lang.Object
  com.cc.framework.ui.model.ClientEvent

All Implemented Interfaces:

java.io.Serializable, SimpleEnumType

public final class ClientEvent

extends java.lang.Object

implements SimpleEnumType, java.io.Serializable

Enumeration of client events

Since:

1.0

Version:

$Revision: 1.13 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private java.lang.String	eventName The name of the event
static ClientEvent	EXT_ONAJAXERROR A function reference assigned will be called after onComplete, if the statusCode !
static ClientEvent	EXT_ONAJAXSUCCESS A function reference assigned will be called after onComplete, if the statusCode=200
static ClientEvent	EXT_ONAJAXTIMEOUT If a timeout period is set, and it is reached before a response is received, a function reference assigned to onTimeout will be called
static ClientEvent	EXT_ONCHECK Fires when a checkbox is checked
static ClientEvent	EXT_ONCHECKALL Fires when all rows are checked
static ClientEvent	EXT_ONCOLLAPSE Fires when a tree node is collapsed
static ClientEvent	EXT_ONEXPAND Fires when a tree node is expanded
static ClientEvent	EXT_ONEXPANDEX Fires when a tree node with unknown child count is expanded
static ClientEvent	EXT_ONSPINDOWN Fires when a spin-down button is clicked
static ClientEvent	EXT_ONSPINUP Fires when a spin-up button is clicked
static ClientEvent	EXT_ONUNCHECK Fires when a checkbox is unchecked
static ClientEvent	EXT_ONUNCHECKALL Fires when all rows are unchecked
private boolean	extended This flag indicates an extended eventhandler which is not part of the HTML-Specification
static ClientEvent	ONABORT Fires when the user aborts the download of an image.
static ClientEvent	ONACTIVATE Fires when the object is set as the active element.
static ClientEvent	ONAFTERPRINT Fires on the object immediately after its associated document prints or previews for printing.
static ClientEvent	ONAFTERUPDATE Fires on a databound object after successfully updating the associated data in the data source object.
static ClientEvent	ONBEFOREACTIVATE Fires immediately before the object is set as the active element.
static ClientEvent	ONBEFORECOPY Fires on the source object before the selection is copied to the system clipboard.
static ClientEvent	ONBEFORECUT Fires on the source object before the selection is deleted from the document.
static ClientEvent	ONBEFOREDEACTIVATE Fires immediately before the activeElement is changed from the current object to another object in the parent document.
static ClientEvent	ONBEFOREEDITFOCUS Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected.
static ClientEvent	ONBEFOREPASTE Fires on the target object before the selection is pasted from the system clipboard to the document.
static ClientEvent	ONBEFOREPRINT Fires on the object before its associated document prints or previews for printing.
static ClientEvent	ONBEFOREUNLOAD Fires prior to a page being unloaded.
static ClientEvent	ONBEFOREUPDATE Fires on a databound object before updating the associated data in the data source object.
static ClientEvent	ONBLUR Fires when the object loses the input focus.
static ClientEvent	ONBOUNCE Fires when the behavior property of the marquee object is set to "alternate" and the contents of the marquee reach one side of the window.
static ClientEvent	ONCELLCHANGE Fires when data changes in the data provider.
static ClientEvent	ONCHANGE Fires when the contents of the object or selection have changed.
static ClientEvent	ONCLICK Fires when the user clicks the left mouse button on the object.
static ClientEvent	ONCONTEXTMENU Fires when the user clicks the right mouse button in the client area, opening the context menu.
static ClientEvent	ONCONTROLSELECT Fires when the user is about to make a control selection of the object.
static ClientEvent	ONCOPY Fires on the source element when the user copies the object or selection, adding it to the system clipboard.
static ClientEvent	ONCUT Fires on the source element when the object or selection is removed from the document and added to the system clipboard.
static ClientEvent	ONDATAAVAILABLE Fires periodically as data arrives from data source objects that asynchronously transmit their data.
static ClientEvent	ONDATASETCHANGED Fires when the data set exposed by a data source object changes.
static ClientEvent	ONDATASETCOMPLETE Fires to indicate that all data is available from the data source object.
static ClientEvent	ONDBLCLICK Fires when the user double-clicks the object.
static ClientEvent	ONDEACTIVATE Fires when the activeElement is changed from the current object to another object in the parent document.
static ClientEvent	ONDRAG Fires on the source object continuously during a drag operation.
static ClientEvent	ONDRAGEND Fires on the source object when the user releases the mouse at the close of a drag operation.
static ClientEvent	ONDRAGENTER Fires on the target element when the user drags the object to a valid drop target.
static ClientEvent	ONDRAGLEAVE Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
static ClientEvent	ONDRAGOVER Fires on the target element continuously while the user drags the object over a valid drop target.
static ClientEvent	ONDRAGSTART Fires on the source object when the user starts to drag a text selection or selected object.
static ClientEvent	ONDROP Fires on the target object when the mouse button is released during a drag-and-drop operation.
static ClientEvent	ONERROR Fires when an error occurs during object loading.
static ClientEvent	ONERRORUPDATE Fires on a databound object when an error occurs while updating the associated data in the data source object.
static ClientEvent	ONFILTERCHANGE Fires when a visual filter changes state or completes a transition.
static ClientEvent	ONFINISH Fires when marquee looping is complete.
static ClientEvent	ONFOCUS Fires when the object receives focus.
static ClientEvent	ONFOCUSIN Fires for an element just prior to setting focus on that element.
static ClientEvent	ONFOCUSOUT Fires for the current element with focus immediately after moving focus to another element.
static ClientEvent	ONHELP Fires when the user presses the F1 key while the browser is the active window.
static ClientEvent	ONKEYDOWN Fires when the user presses a key.
static ClientEvent	ONKEYPRESS Fires when the user presses an alphanumeric key.
static ClientEvent	ONKEYUP Fires when the user releases a key.
static ClientEvent	ONLAYOUTCOMPLETE Fires when the print or print preview layout process finishes filling the current LayoutRect object with content from the source document.
static ClientEvent	ONLOAD Fires immediately after the browser loads the object.
static ClientEvent	ONLOSECAPTURE Fires when the object loses the mouse capture.
static ClientEvent	ONMOUSEDOWN Fires when the user clicks the object with either mouse button.
static ClientEvent	ONMOUSEENTER Fires when the user moves the mouse pointer into the object.
static ClientEvent	ONMOUSELEAVE Fires when the user moves the mouse pointer outside the boundaries of the object.
static ClientEvent	ONMOUSEMOVE Fires when the user moves the mouse over the object.
static ClientEvent	ONMOUSEOUT Fires when the user moves the mouse pointer outside the boundaries of the object.
static ClientEvent	ONMOUSEOVER Fires when the user moves the mouse pointer into the object.
static ClientEvent	ONMOUSEUP Fires when the user releases a mouse button while the mouse is over the object.
static ClientEvent	ONMOUSEWHEEL Fires when the wheel button is rotated.
static ClientEvent	ONMOVE Fires when the object moves.
static ClientEvent	ONMOVEEND Fires when the object stops moving.
static ClientEvent	ONMOVESTART Fires when the object starts to move.
static ClientEvent	ONPASTE Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.
static ClientEvent	ONPROPERTYCHANGE Fires when a property changes on the object.
static ClientEvent	ONREADYSTATECHANGE Fires when the state of the object has changed.
static ClientEvent	ONRESET Fires when the user resets a form.
static ClientEvent	ONRESIZE Fires when the size of the object is about to change.
static ClientEvent	ONRESIZEEND Fires when the user finishes changing the dimensions of the object in a control selection.
static ClientEvent	ONRESIZESTART Fires when the user begins to change the dimensions of the object in a control selection.
static ClientEvent	ONROWENTER Fires to indicate that the current row has changed in the data source and new data values are available on the object.
static ClientEvent	ONROWEXIT Fires just before the data source control changes the current row in the object.
static ClientEvent	ONROWSDELETE Fires when rows are about to be deleted from the recordset.
static ClientEvent	ONROWSINSERTED Fires just after new rows are inserted in the current recordset.
static ClientEvent	ONSCROLL Fires when the user repositions the scroll box in the scroll bar on the object.
static ClientEvent	ONSELECT Fires when the current selection changes.
static ClientEvent	ONSELECTIONCHANGE Fires when the selection state of a document changes.
static ClientEvent	ONSELECTSTART Fires when the object is being selected.
static ClientEvent	ONSTART Fires at the beginning of every loop of the marquee object.
static ClientEvent	ONSTOP Fires when the user clicks the Stop button or leaves the Web page.
static ClientEvent	ONSUBMIT Fires when a FORM is about to be submitted.
static ClientEvent	ONUNLOAD Fires immediately before the object is unloaded.
private static long	serialVersionUID Serial Version UID

Constructor Summary

private	ClientEvent(java.lang.String eventName) Constructor for ClientEvent
private	ClientEvent(java.lang.String eventName, boolean extended) Constructor for ClientEvent

Method Summary

boolean	equals(java.lang.Object obj) Compares this type to the specified object.
java.lang.String	getScriptName() Returns the name for the JavaScript event handler
int	hashCode()
boolean	isExtended() Indicates if this is an extended eventhandler which is not part of the HTML-Specification
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

ONABORT

public static final ClientEvent ONABORT

Fires when the user aborts the download of an image.

ONACTIVATE

public static final ClientEvent ONACTIVATE

Fires when the object is set as the active element.

ONAFTERPRINT

public static final ClientEvent ONAFTERPRINT

Fires on the object immediately after its associated document prints or previews for printing.

ONAFTERUPDATE

public static final ClientEvent ONAFTERUPDATE

Fires on a databound object after successfully updating the associated data in the data source object.

ONBEFOREACTIVATE

public static final ClientEvent ONBEFOREACTIVATE

Fires immediately before the object is set as the active element.

ONBEFORECOPY

public static final ClientEvent ONBEFORECOPY

Fires on the source object before the selection is copied to the system clipboard.

ONBEFORECUT

public static final ClientEvent ONBEFORECUT

Fires on the source object before the selection is deleted from the document.

ONBEFOREDEACTIVATE

public static final ClientEvent ONBEFOREDEACTIVATE

Fires immediately before the activeElement is changed from the current object to another object in the parent document.

ONBEFOREEDITFOCUS

public static final ClientEvent ONBEFOREEDITFOCUS

Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected.

ONBEFOREPASTE

public static final ClientEvent ONBEFOREPASTE

Fires on the target object before the selection is pasted from the system clipboard to the document.

ONBEFOREPRINT

public static final ClientEvent ONBEFOREPRINT

Fires on the object before its associated document prints or previews for printing.

ONBEFOREUNLOAD

public static final ClientEvent ONBEFOREUNLOAD

Fires prior to a page being unloaded.

ONBEFOREUPDATE

public static final ClientEvent ONBEFOREUPDATE

Fires on a databound object before updating the associated data in the data source object.

ONBLUR

public static final ClientEvent ONBLUR

Fires when the object loses the input focus.

ONBOUNCE

public static final ClientEvent ONBOUNCE

Fires when the behavior property of the marquee object is set to "alternate" and the contents of the marquee reach one side of the window.

ONCELLCHANGE

public static final ClientEvent ONCELLCHANGE

Fires when data changes in the data provider.

ONCHANGE

public static final ClientEvent ONCHANGE

Fires when the contents of the object or selection have changed.

ONCLICK

public static final ClientEvent ONCLICK

Fires when the user clicks the left mouse button on the object.

ONCONTEXTMENU

public static final ClientEvent ONCONTEXTMENU

Fires when the user clicks the right mouse button in the client area, opening the context menu.

ONCONTROLSELECT

public static final ClientEvent ONCONTROLSELECT

Fires when the user is about to make a control selection of the object.

ONCOPY

public static final ClientEvent ONCOPY

Fires on the source element when the user copies the object or selection, adding it to the system clipboard.

ONCUT

public static final ClientEvent ONCUT

Fires on the source element when the object or selection is removed from the document and added to the system clipboard.

ONDATAAVAILABLE

public static final ClientEvent ONDATAAVAILABLE

Fires periodically as data arrives from data source objects that asynchronously transmit their data.

ONDATASETCHANGED

public static final ClientEvent ONDATASETCHANGED

Fires when the data set exposed by a data source object changes.

ONDATASETCOMPLETE

public static final ClientEvent ONDATASETCOMPLETE

Fires to indicate that all data is available from the data source object.

ONDBLCLICK

public static final ClientEvent ONDBLCLICK

Fires when the user double-clicks the object.

ONDEACTIVATE

public static final ClientEvent ONDEACTIVATE

Fires when the activeElement is changed from the current object to another object in the parent document.

ONDRAG

public static final ClientEvent ONDRAG

Fires on the source object continuously during a drag operation.

ONDRAGEND

public static final ClientEvent ONDRAGEND

Fires on the source object when the user releases the mouse at the close of a drag operation.

ONDRAGENTER

public static final ClientEvent ONDRAGENTER

Fires on the target element when the user drags the object to a valid drop target.

ONDRAGLEAVE

public static final ClientEvent ONDRAGLEAVE

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

ONDRAGOVER

public static final ClientEvent ONDRAGOVER

Fires on the target element continuously while the user drags the object over a valid drop target.

ONDRAGSTART

public static final ClientEvent ONDRAGSTART

Fires on the source object when the user starts to drag a text selection or selected object.

ONDROP

public static final ClientEvent ONDROP

Fires on the target object when the mouse button is released during a drag-and-drop operation.

ONERROR

public static final ClientEvent ONERROR

Fires when an error occurs during object loading.

ONERRORUPDATE

public static final ClientEvent ONERRORUPDATE

Fires on a databound object when an error occurs while updating the associated data in the data source object.

ONFILTERCHANGE

public static final ClientEvent ONFILTERCHANGE

Fires when a visual filter changes state or completes a transition.

ONFINISH

public static final ClientEvent ONFINISH

Fires when marquee looping is complete.

ONFOCUS

public static final ClientEvent ONFOCUS

Fires when the object receives focus.

ONFOCUSIN

public static final ClientEvent ONFOCUSIN

Fires for an element just prior to setting focus on that element.

ONFOCUSOUT

public static final ClientEvent ONFOCUSOUT

Fires for the current element with focus immediately after moving focus to another element.

ONHELP

public static final ClientEvent ONHELP

Fires when the user presses the F1 key while the browser is the active window.

ONKEYDOWN

public static final ClientEvent ONKEYDOWN

Fires when the user presses a key.

ONKEYPRESS

public static final ClientEvent ONKEYPRESS

Fires when the user presses an alphanumeric key.

ONKEYUP

public static final ClientEvent ONKEYUP

Fires when the user releases a key.

ONLAYOUTCOMPLETE

public static final ClientEvent ONLAYOUTCOMPLETE

Fires when the print or print preview layout process finishes filling the current LayoutRect object with content from the source document.

ONLOAD

public static final ClientEvent ONLOAD

Fires immediately after the browser loads the object.

ONLOSECAPTURE

public static final ClientEvent ONLOSECAPTURE

Fires when the object loses the mouse capture.

ONMOUSEDOWN

public static final ClientEvent ONMOUSEDOWN

Fires when the user clicks the object with either mouse button.

ONMOUSEENTER

public static final ClientEvent ONMOUSEENTER

Fires when the user moves the mouse pointer into the object.

ONMOUSELEAVE

public static final ClientEvent ONMOUSELEAVE

Fires when the user moves the mouse pointer outside the boundaries of the object.

ONMOUSEMOVE

public static final ClientEvent ONMOUSEMOVE

Fires when the user moves the mouse over the object.

ONMOUSEOUT

public static final ClientEvent ONMOUSEOUT

Fires when the user moves the mouse pointer outside the boundaries of the object.

ONMOUSEOVER

public static final ClientEvent ONMOUSEOVER

Fires when the user moves the mouse pointer into the object.

ONMOUSEUP

public static final ClientEvent ONMOUSEUP

Fires when the user releases a mouse button while the mouse is over the object.

ONMOUSEWHEEL

public static final ClientEvent ONMOUSEWHEEL

Fires when the wheel button is rotated.

ONMOVE

public static final ClientEvent ONMOVE

Fires when the object moves.

ONMOVEEND

public static final ClientEvent ONMOVEEND

Fires when the object stops moving.

ONMOVESTART

public static final ClientEvent ONMOVESTART

Fires when the object starts to move.

ONPASTE

public static final ClientEvent ONPASTE

Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.

ONPROPERTYCHANGE

public static final ClientEvent ONPROPERTYCHANGE

Fires when a property changes on the object.

ONREADYSTATECHANGE

public static final ClientEvent ONREADYSTATECHANGE

Fires when the state of the object has changed.

ONRESET

public static final ClientEvent ONRESET

Fires when the user resets a form.

ONRESIZE

public static final ClientEvent ONRESIZE

Fires when the size of the object is about to change.

ONRESIZEEND

public static final ClientEvent ONRESIZEEND

Fires when the user finishes changing the dimensions of the object in a control selection.

ONRESIZESTART

public static final ClientEvent ONRESIZESTART

Fires when the user begins to change the dimensions of the object in a control selection.

ONROWENTER

public static final ClientEvent ONROWENTER

Fires to indicate that the current row has changed in the data source and new data values are available on the object.

ONROWEXIT

public static final ClientEvent ONROWEXIT

Fires just before the data source control changes the current row in the object.

ONROWSDELETE

public static final ClientEvent ONROWSDELETE

Fires when rows are about to be deleted from the recordset.

ONROWSINSERTED

public static final ClientEvent ONROWSINSERTED

Fires just after new rows are inserted in the current recordset.

ONSCROLL

public static final ClientEvent ONSCROLL

Fires when the user repositions the scroll box in the scroll bar on the object.

ONSELECT

public static final ClientEvent ONSELECT

Fires when the current selection changes.

ONSELECTIONCHANGE

public static final ClientEvent ONSELECTIONCHANGE

Fires when the selection state of a document changes.

ONSELECTSTART

public static final ClientEvent ONSELECTSTART

Fires when the object is being selected.

ONSTART

public static final ClientEvent ONSTART

Fires at the beginning of every loop of the marquee object.

ONSTOP

public static final ClientEvent ONSTOP

Fires when the user clicks the Stop button or leaves the Web page.

ONSUBMIT

public static final ClientEvent ONSUBMIT

Fires when a FORM is about to be submitted.

ONUNLOAD

public static final ClientEvent ONUNLOAD

Fires immediately before the object is unloaded.

EXT_ONEXPAND

public static final ClientEvent EXT_ONEXPAND

Fires when a tree node is expanded

EXT_ONEXPANDEX

public static final ClientEvent EXT_ONEXPANDEX

Fires when a tree node with unknown child count is expanded

EXT_ONCOLLAPSE

public static final ClientEvent EXT_ONCOLLAPSE

Fires when a tree node is collapsed

EXT_ONSPINUP

public static final ClientEvent EXT_ONSPINUP

Fires when a spin-up button is clicked

EXT_ONSPINDOWN

public static final ClientEvent EXT_ONSPINDOWN

Fires when a spin-down button is clicked

EXT_ONCHECK

public static final ClientEvent EXT_ONCHECK

Fires when a checkbox is checked

EXT_ONUNCHECK

public static final ClientEvent EXT_ONUNCHECK

Fires when a checkbox is unchecked

EXT_ONCHECKALL

public static final ClientEvent EXT_ONCHECKALL

Fires when all rows are checked

EXT_ONUNCHECKALL

public static final ClientEvent EXT_ONUNCHECKALL

Fires when all rows are unchecked

EXT_ONAJAXTIMEOUT

public static final ClientEvent EXT_ONAJAXTIMEOUT

If a timeout period is set, and it is reached before a response is received, a function reference assigned to onTimeout will be called

EXT_ONAJAXSUCCESS

public static final ClientEvent EXT_ONAJAXSUCCESS

A function reference assigned will be called after onComplete, if the statusCode=200

EXT_ONAJAXERROR

public static final ClientEvent EXT_ONAJAXERROR

A function reference assigned will be called after onComplete, if the statusCode != 200

eventName

private java.lang.String eventName

The name of the event

extended

private boolean extended

This flag indicates an extended eventhandler which is not part of the HTML-Specification

Constructor Detail

ClientEvent

private ClientEvent(java.lang.String eventName)

Constructor for ClientEvent

Parameters:

eventName - The name of the event

ClientEvent

private ClientEvent(java.lang.String eventName,
                    boolean extended)

Constructor for ClientEvent

Parameters:

eventName - The name of the event

extended - Indicates an extended eventhandler

Method Detail

isExtended

public boolean isExtended()

Indicates if this is an extended eventhandler which is not part of the HTML-Specification

Returns:

retrunstrue if this is an extended handler

getScriptName

public java.lang.String getScriptName()

Returns the name for the JavaScript event handler

Returns:

String Name of the event handler

equals

public boolean equals(java.lang.Object obj)

Compares this type to the specified object.

Parameters:

obj - The object to compare this ClientEvent object against.

Returns:

true if the internal types are equal; false otherwise.

hashCode

public int hashCode()

See Also:

Object.hashCode()

toString

public java.lang.String toString()

See Also:

Object.toString()