org.eclnt.jsfserver.elements.events

Class BaseActionEventInvoke

java.lang.Object

ActionEvent

org.eclnt.jsfserver.elements.BaseActionEvent

org.eclnt.jsfserver.elements.events.BaseActionEventInvoke

All Implemented Interfaces:

java.io.Serializable, IBaseActionEvent

public class BaseActionEventInvoke
extends BaseActionEvent

Event information that is associated with a simple invoke event on client side. If (and only in this case!) the event was caused by a component that used the attribute INVOKEEVENT (e.g. with the IMAGE component), then x,y,width,heigh information is associated with the event. In all other cases the corresponding methods of this event-class will return "-1".

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.eclnt.jsfserver.elements.IBaseActionEvent

EVTYPE_ACTIVEX_PARAMS, EVTYPE_AREAFOCUSGAINED, EVTYPE_CAMERASNAP, EVTYPE_CCFEDITTRANSFER, EVTYPE_CHARTCLICK, EVTYPE_CHARTDOMAINZOOM, EVTYPE_CHARTJSPOINTSELECTION, EVTYPE_CHARTMOUSECLICK, EVTYPE_CLIENTDATAGRAMRECEIVE, EVTYPE_CLIENTFILEPOLL, EVTYPE_CLIENTFILEREMOVALMESSAGE, EVTYPE_CLIENTFOCUSCHANGE, EVTYPE_CLIENTHTTPRECEIVE, EVTYPE_CLIENTHTTPSEND, EVTYPE_CLIENTJSCALLRESULT, EVTYPE_CLIENTMETHODRECEIVE, EVTYPE_CLIENTSERIALRECEIVE, EVTYPE_CLIENTSOCKETRECEIVE, EVTYPE_CLIENTSUBDEVICE, EVTYPE_CLIENTUSBFILEREADER, EVTYPE_CLIPBOARD_GET, EVTYPE_COMBOBOX_LOADONDEMAND, EVTYPE_COMBOFIELD_VALUEHELP, EVTYPE_DETAILINVOKE, EVTYPE_DRAGSTARTED, EVTYPE_DROP, EVTYPE_DROPCOPY, EVTYPE_FILECREATEDIRECTORY, EVTYPE_FILEDOWNLOAD_FINISHED, EVTYPE_FILEUPLOAD_UPLOAD, EVTYPE_FILEUPLOAD_UPLOADASYNCHRONOUSFINISEHD, EVTYPE_FIXGRID_COLUMNUPDATE, EVTYPE_FIXGRID_FIRSTLINEUP, EVTYPE_FIXGRID_LASTLINEDOWN, EVTYPE_FIXGRID_ROWCONTROLSELECT, EVTYPE_FIXGRID_ROWEXECUTE, EVTYPE_FIXGRID_ROWMOVE, EVTYPE_FIXGRID_ROWSELECT, EVTYPE_FIXGRID_ROWSHIFTSELECT, EVTYPE_FIXGRID_SCROLL, EVTYPE_FIXGRID_SCROLLANDREFOCUS, EVTYPE_FIXGRID_SEARCH, EVTYPE_FIXGRID_SELECTALL, EVTYPE_FIXGRID_SELECTORTITLEICON, EVTYPE_FIXGRID_SORT, EVTYPE_FIXGRID_SYNC, EVTYPE_FLUSH, EVTYPE_FOCUSGAINED, EVTYPE_FOCUSLOST, EVTYPE_FXCHARTSELECTION, EVTYPE_GEOLOCATIONUPDATE, EVTYPE_HELP, EVTYPE_IFRAMEINCLUDECALLBACK, EVTYPE_IMAGEMAPAREASELECTED, EVTYPE_INVOKE, EVTYPE_KEYSEQUENCE, EVTYPE_LINK, EVTYPE_LONGCLICKEND, EVTYPE_MEDIAPLAYER, EVTYPE_MENUITEM_SELECT, EVTYPE_MENULOAD, EVTYPE_MESSAGE, EVTYPE_NAVBUTTONPRESS, EVTYPE_OBJECTHEADERICONINVOKE, EVTYPE_OBJECTHEADERINTROINVOKE, EVTYPE_OBJECTHEADERTITLEINVOKE, EVTYPE_OBJECTHEADERTITLESELECTORINVOKE, EVTYPE_OSMVIEWERSEELCTION, EVTYPE_PDFPRINTERNOTIFICATION, EVTYPE_POPUP_CLOSE, EVTYPE_POPUPMENULOAD, EVTYPE_QRCODESCAN, EVTYPE_RANGESELECTION, EVTYPE_RGRAPHPOINTSELECTION, EVTYPE_ROLLINGCONTAINERICONINVOKE, EVTYPE_SCAN, EVTYPE_SCENEJSCALLBACK, EVTYPE_SCHEDULE_SIZECHANGED, EVTYPE_SEARCH, EVTYPE_SENDIMAGE, EVTYPE_SLIDECONTAINER, EVTYPE_SUBPAGE_CLICK, EVTYPE_SUBPAGE_CLICKRIGHT, EVTYPE_SUGGESTION, EVTYPE_SVGELEMENTSELECTION, EVTYPE_TABCLOSE, EVTYPE_TILEDELETE, EVTYPE_TILEMOVE, EVTYPE_TOKENDELETE, EVTYPE_TOOLTIPENDED, EVTYPE_TOOLTIPSTARTED, EVTYPE_TREENODE_TOGGLE, EVTYPE_TRIPLEPANE, EVTYPE_VALIDATE, EVTYPE_WINDOWSIZECHANGED

Constructor Summary

Constructors

Constructor and Description
BaseActionEventInvoke(UIComponent component, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
int	getClickCount()
int	getClickDuration()
int	getHeight()
int	getMouseButton()
int	getWidth()
int	getX() This information is only present if the invoke was part of a click processing on client side.
int	getY()
boolean	isAltKeyPressed() This information is only present if the invoke was part of a click processing on client side.
boolean	isCtrlKeyPressed() This information is only present if the invoke was part of a click processing on client side.
boolean	isLongClick() Certain components support the attribute WITHLONGCLICK so that the component triggers the action event after the user having presse the component for a certain while as well.
boolean	isShiftKeyPressed() This information is only present if the invoke was part of a click processing on client side.

Methods inherited from class org.eclnt.jsfserver.elements.BaseActionEvent

getCommand, getEventInfo, getInternalReference, getOnlyCallIfObjectIsAvailable, getParams, getSourceComment, getSourceConfiginfo, getSourceReference, isImmediate, isPrior, readParam, setImmediate, setInternalReference, setOnlyCallIfObjectIsAvailable, setPrior

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseActionEventInvoke

public BaseActionEventInvoke(UIComponent component,
                             java.lang.String type)

Method Detail

getX

public int getX()

This information is only present if the invoke was part of a click processing on client side.

Returns:

The x-position of the click, relative to the coordinates of the associated component. "-1" is returned in case no specific coordinates are associated with the event.

getY

public int getY()

Returns:

The y-position of the click, relative to the coordinates of the associated component. "-1" is returned in case no specific coordinates are associated with the event.

getWidth

public int getWidth()

Returns:

The pixel width of the component on which the invoke was invoked. "-1" is returned in case no specific coordinates are associated with the event.

getHeight

public int getHeight()

Returns:

The pixel height of the component on which the invoke was invoked. "-1" is returned in case no specific coordinates are associated with the event.

getClickCount

public int getClickCount()

Returns:

The click count of the operation that caused the invoke event on client side. "1" for single click, "2" for double click. "-1" is returned in case no specific click count was passed from client side.

isAltKeyPressed

public boolean isAltKeyPressed()

This information is only present if the invoke was part of a click processing on client side.

isShiftKeyPressed

public boolean isShiftKeyPressed()

This information is only present if the invoke was part of a click processing on client side.

isCtrlKeyPressed

public boolean isCtrlKeyPressed()

This information is only present if the invoke was part of a click processing on client side.

getMouseButton

public int getMouseButton()

Returns:

0 if mouse button was not part of the event data. 1 for left mouse button (default mouse button), 3 for right mouse button (secondary mouse button)

getClickDuration

public int getClickDuration()

Returns:

Returns duration in milliseconds between the mouse/touch down and the mouse/touch up event. In case of actions initiated e.g. by keyboard the value "-1" is returned.

isLongClick

public boolean isLongClick()

Certain components support the attribute WITHLONGCLICK so that the component triggers the action event after the user having presse the component for a certain while as well. This method indicates if the action was triggered by a normal click or by a long click.