Package org.eclnt.jsfserver.elements.events

Class BaseActionEventFlush

java.lang.Object

java.util.EventObject

javax.faces.event.FacesEvent

javax.faces.event.ActionEvent

org.eclnt.jsfserver.elements.BaseActionEvent

org.eclnt.jsfserver.elements.events.BaseActionEventFlush

All Implemented Interfaces:

Serializable, IBaseActionEvent

public class BaseActionEventFlush
extends BaseActionEvent

Event that is sent with a flush event of a client side component.

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

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

EVTYPE_ACTIVEX_PARAMS, EVTYPE_AREAFOCUSGAINED, EVTYPE_BROWSEREVENTMESSAGE, 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_FINISHEDRENDERING, 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_LAZYLOADING, EVTYPE_LINK, EVTYPE_LONGCLICKEND, EVTYPE_MEDIAPLAYER, EVTYPE_MENUITEM_SELECT, EVTYPE_MENULOAD, EVTYPE_MESSAGE, EVTYPE_MOUSEOUT, EVTYPE_MOUSEOVER, EVTYPE_NAVBUTTONPRESS, EVTYPE_OBJECTHEADERICONINVOKE, EVTYPE_OBJECTHEADERINTROINVOKE, EVTYPE_OBJECTHEADERTITLEINVOKE, EVTYPE_OBJECTHEADERTITLESELECTORINVOKE, EVTYPE_OSMVIEWERSEELCTION, EVTYPE_PDFPRINTERNOTIFICATION, EVTYPE_POPUP_CLOSE, EVTYPE_POPUPMENULOAD, EVTYPE_QRCODESCAN, EVTYPE_RANGESELECTION, EVTYPE_REARRANGE, EVTYPE_RGRAPHPOINTSELECTION, EVTYPE_ROLLINGCONTAINERICONINVOKE, EVTYPE_SCAN, EVTYPE_SCENEJSCALLBACK, EVTYPE_SCHEDULE_SIZECHANGED, EVTYPE_SCROLL, 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	Description
BaseActionEventFlush(javax.faces.component.UIComponent component, String type)

Method Summary

Modifier and Type	Method	Description
String	getFlushAttributeInfo()	By default a components updates one value - e.g. a FIELD updates the property behind its attribute TEXT.
int	getFlushComponentHeight()	Returns the height of the component that triggered the flush event.
int	getFlushComponentWidth()	Returns the width of the component that triggered the flush event.
boolean	getFlushWasTriggeredByTimer()	A flush can be triggered by two user activities: (1) the user may leave the component ("focus lost") or (2) the flush may be cause by user input which is monitored by a flush timer.

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

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

Methods inherited from class javax.faces.event.ActionEvent

isAppropriateListener, processListener

Methods inherited from class javax.faces.event.FacesEvent

getComponent, getFacesContext, getPhaseId, queue, setPhaseId

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

Constructor Details

BaseActionEventFlush

public BaseActionEventFlush(javax.faces.component.UIComponent component,
 String type)

Method Details

getFlushWasTriggeredByTimer

public boolean getFlushWasTriggeredByTimer()

A flush can be triggered by two user activities: (1) the user may leave the component ("focus lost") or (2) the flush may be cause by user input which is monitored by a flush timer.

getFlushComponentWidth

public int getFlushComponentWidth()

Returns the width of the component that triggered the flush event. May return "-1" if the data is not available.

getFlushComponentHeight

public int getFlushComponentHeight()

Returns the height of the component that triggered the flush event. May return "-1" if the data is not available.

getFlushAttributeInfo

public String getFlushAttributeInfo()

By default a components updates one value - e.g. a FIELD updates the property behind its attribute TEXT. Some components update multiple values, e.g. a PAINTAREAITEM updates its BOUNDS and SELECTED attribute. In this case the information behind this method helps to separate.

Returns:

null is returned for the default attribute, a String value is returned for additional attributes that are updated.