Package org.eclnt.jsfserver.elements

Class BaseActionEvent

java.lang.Object
java.util.EventObject
javax.faces.event.FacesEvent
javax.faces.event.ActionEvent
org.eclnt.jsfserver.elements.BaseActionEvent
All Implemented Interfaces:
Serializable, IBaseActionEvent
Direct Known Subclasses:
BaseActionEventActiveX, BaseActionEventAreaFocusGained, BaseActionEventBrowserEventMessage, BaseActionEventCameraSnap, BaseActionEventCcfeditTransfer, BaseActionEventChartClick, BaseActionEventChartDomainZoom, BaseActionEventChartJsPointSelection, BaseActionEventChartMouseClick, BaseActionEventClientDatagramReceive, BaseActionEventClientFilePoll, BaseActionEventClientFileRemovalMessage, BaseActionEventClientFocusChange, BaseActionEventClientHttpReceive, BaseActionEventClientHttpSend, BaseActionEventClientMethodReceive, BaseActionEventClientSerialReceive, BaseActionEventClientSocketReceive, BaseActionEventClientSubDevice, BaseActionEventClientUsbFileReader, BaseActionEventClipboardGet, BaseActionEventDetailInvoke, BaseActionEventDownloadFinished, BaseActionEventDragStarted, BaseActionEventDrop, BaseActionEventFileCreateDirectory, BaseActionEventFinishedRendering, BaseActionEventFlush, BaseActionEventFocusGained, BaseActionEventFocusLost, BaseActionEventFXChartSelection, BaseActionEventGeoLocationUpdate, BaseActionEventGrid, BaseActionEventGridFirstLineUp, BaseActionEventGridLastLineDown, BaseActionEventGridSelectorTitleIcon, BaseActionEventHelp, BaseActionEventIframeIncludeCallback, BaseActionEventImageMapAreaSelected, BaseActionEventInvoke, BaseActionEventJsCallResult, BaseActionEventKeySelected, BaseActionEventKeySequence, BaseActionEventLazyLoading, BaseActionEventLink, BaseActionEventLoadOnDemand, BaseActionEventLongClickEnd, BaseActionEventMediaPlayer, BaseActionEventMenuLoad, BaseActionEventMessage, BaseActionEventMouseOut, BaseActionEventMouseOver, BaseActionEventNavButtonPress, BaseActionEventObjectHeaderIconInvoke, BaseActionEventObjectHeaderIntroInvoke, BaseActionEventObjectHeaderTitleInvoke, BaseActionEventObjectHeaderTitleSelectorInvoke, BaseActionEventOsmviewerSelection, BaseActionEventPdfprinterNotification, BaseActionEventPopupClose, BaseActionEventPopupMenuItem, BaseActionEventPopupMenuLoad, BaseActionEventQRCodeScan, BaseActionEventRangeSelection, BaseActionEventRearrange, BaseActionEventRGraphPointSelection, BaseActionEventRollingContainerIconInvoke, BaseActionEventScan, BaseActionEventScenejsCallback, BaseActionEventScheduleSizeChanged, BaseActionEventScroll, BaseActionEventSearch, BaseActionEventSelect, BaseActionEventSendImage, BaseActionEventSlideContainer, BaseActionEventSubpageClick, BaseActionEventSuggestion, BaseActionEventSvgElementSelection, BaseActionEventTabClose, BaseActionEventTileDelete, BaseActionEventTileMove, BaseActionEventToggle, BaseActionEventTokenDelete, BaseActionEventTooltipEnded, BaseActionEventTooltipStarted, BaseActionEventTriplePane, BaseActionEventUpload, BaseActionEventUploadAsynchronousFinished, BaseActionEventValidate, BaseActionEventValueHelp, BaseActionEventWindowSizeChanged
public class BaseActionEvent extends javax.faces.event.ActionEvent implements IBaseActionEvent, Serializable
Event class for all actionListener calls that are executed by Enterprise Client components.

Important: in general do not use the id of the source component for any kind of evaluation which component was the one to throw the event. Because the component id needs to be strictly unique it is generated internally by default ("g_###"-ids). Better use the common attributes "reference" or "comment" for placing information about a certain component.

There are quite a lot of event classes inheriting from this class - each one for a specific event situation. These classes provide specific extra methods for getting data about the event.
See Also:

  • Constructor Details

    • BaseActionEvent

      public BaseActionEvent(javax.faces.component.UIComponent component, String type)
      Constructor to be used in "real" JSF environemnt.
      Parameters:
      component -
      type -

  • Method Details

    • getCommand

      public String getCommand()
      Returns the command that caused the event on client side. Each event in the client corresponds to a certain command that allows to identify the event on server side. There may be several commands that are valid for one and the same component. E.g. a field component can on the one hand trigger the "flush" command, and on the other hand can trigger popup menu commmands or drop commands.

    • getParams

      public String[] getParams()
      Each command can be associated with a set of string parameters. The order and meaning of parameters is up to the command.

    • getParam

      public String getParam(int index)
      Reads one parameter from parameters. Returns null if the parameter is not available.

    • getEventInfo

      public String getEventInfo()
      The event string as it is passed from the client side. This method is for information/debugging purpose only. The information returned must be accessed by using getCommand() and getParams().

    • setInternalReference

      public void setInternalReference(Object o)
      Internal use only.

    • getInternalReference

      public Object getInternalReference()
      Internal use only.

    • getSourceReference

      public String getSourceReference()
      Each event is related to a component (the source of the event). This method returns the REFERENCE attribute value of the source component.

    • getSourceComment

      public String getSourceComment()
      Each event is related to a component (the source of the event). This method returns the COMMENT attribute value of the source component.

    • getSourceConfiginfo

      public String getSourceConfiginfo()
      Each event is related to a component (the source of the event). This method returns the CONFIGINFO attribute value of the source component.

    • setImmediate

      public void setImmediate(boolean immediate)
      Internal usage.

    • isImmediate

      public boolean isImmediate()
      Internal usage.

    • getOnlyCallIfObjectIsAvailable

      public boolean getOnlyCallIfObjectIsAvailable()
      Internal usage.

    • setOnlyCallIfObjectIsAvailable

      public void setOnlyCallIfObjectIsAvailable(boolean onlyCallIfObjectIsAvailable)
      Internal usage.

    • readParam

      protected String readParam(int index)
      "Robust" reading of parameter.

    • setPrior

      protected void setPrior(boolean prior)
      Indicate that this event is called prior to normal events.

    • isPrior

      public boolean isPrior()