Package overit.geocall.ui

Class UIMessage

java.lang.Object
overit.geocall.ui.UIMessage
public class UIMessage extends Object
Implements the object that is passed to the event handler methods triggered via sendEvent; contains additional information and values with respect to the classic HashGetter passed to the event handler, such as the possibility to check if during the event launch a control key was pressed (ctrl, alt, etc.). In addition, the UIMessage contains a bubbling track map, a map of additional information that can be set to allow other interceptors of the same event (for example customizations) to find them and use them to implement different logics based on the different values.

  • Field Details

  • Constructor Details

    • UIMessage

      public UIMessage(String id, String container, Object param, HashGetter controlValues, HashGetter values, HashGetter daValues, overit.geocall.servlet.UserAgent ua, overit.geocall.servlet.Reference reference)
      Creates an instance of UIMessage
      Parameters:
      id - The id of the message
      container - The id string of the container to which it is associated the message
      param - Programmatically set parameters, those that are defined via XML and on which we have control; they are the set of param (like row, column, prompt, etc.) and of the values
      controlValues - The HashGetter that contains the control parameters, such as "code", "__refed", "__keys" and in general all those who start with "__"
      values - The HashGetter that contains the values
      daValues - The HashGetter that contains the values with dalink set to true, those for the database
      ua - The UserAgent
      reference - the Reference instance related to the current http servlet request

    • UIMessage

      public UIMessage(String id, String container, Object param, HashGetter controlValues, HashGetter values, HashGetter daValues, overit.geocall.servlet.UserAgent ua)
      Creates an instance of UIMessage
      Parameters:
      id - The id of the message
      container - The id string of the container to which it is associated the message
      param - Programmatically set parameters, those that are defined via XML and on which we have control; they are the set of param (like row, column, prompt, etc.) and of the values
      controlValues - The HashGetter that contains the control parameters, such as "code", "__refed", "__keys" and in general all those who start with "__"
      values - The HashGetter that contains the values
      daValues - The HashGetter that contains the values with dalink set to true, those for the database
      ua - The UserAgent

    • UIMessage

      public UIMessage(String id, String container, Object param, HashGetter controlValues, HashGetter values, HashGetter daValues)
      Creates an instance of UIMessage
      Parameters:
      id - The id of the message
      container - The id string of the container to which it is associated the message
      param - Programmatically set parameters, those that are defined via XML and on which we have control; they are the set of param (like row, column, prompt, etc.) and of the values
      controlValues - The HashGetter that contains the control parameters, such as "code", "__refed", "__keys" and in general all those who start with "__"
      values - The HashGetter that contains the values passed to the event
      daValues - The HashGetter that contains the values with dalink set to true, those for the database

    • UIMessage

      public UIMessage(String strId, String strContainer, Object oParam, HashGetter values, HashGetter daValues)
      Creates an instance of UIMessage
      Parameters:
      strId - The id of the message
      strContainer - The id string of the container to which it is associated the message
      oParam - Programmatically set parameters, those that are defined via XML and on which we have control; they are the set of param (like row, column, prompt, etc.) and of the values
      values - The HashGetter that contains the values passed to the event
      daValues - The HashGetter that contains the values with dalink set to true, those for the database

  • Method Details

    • getId

      public String getId()
      Returns the id of the UIMessage
      Returns:
      The string that represents the id of the UIMessage

    • getContainer

      public String getContainer()
      Returns the id of the container to which it is associated the message
      Returns:
      The string that represents the id of the container to which it is associated the message

    • getParam

      public <T> T getParam()
      Returns the programmatically set parameters, those that are defined via XML and on which we have control; they are the set of param (like row, column, prompt, etc.) and of the values
      Type Parameters:
      T - The type of params
      Returns:
      The parameters object, casted in the right way

    • getControlValues

      public UIMessage.ControlValues getControlValues()
      Returns the control parameters passed to the event
      Returns:
      The UIMessage.ControlValues, the HashGetter that contains the control parameters, such as "code", "__refed", "__keys" and in general all those who start with "__", and a series of utility

    • getValues

      public HashGetter getValues()
      Returns the values passed to the event
      Returns:
      The HashGetter that contains the values

    • getDAValues

      public HashGetter getDAValues()
      Returns the values with dalink set to true
      Returns:
      The HashGetter that contains the values with dalink set to true, those for the database

    • getProcessedParams

      public Object getProcessedParams()
      Returns the bubbling track map, the map of additional information set to the UIMessage, that allow other interceptors of the same event (for example customizations) to find and use them to implement different logics based on the different values
      Returns:
      The Object that contains the additional information

    • setEventValidator

      public void setEventValidator(EventValidator ev)
      Stores the EventValidator that accepted this message
      Parameters:
      ev - the EventValidator that accepted this message

    • getEventValidator

      public EventValidator getEventValidator()
      Retrieves the EventValidator that accepted this message
      Returns:
      the EventValidator that accepted this message

    • putBubblingTrack

      public void putBubblingTrack(String name, Object obj)
      Put a key / value couple in the bubbling track map (see getProcessedParams())
      Parameters:
      name - The name of the key
      obj - The object stored in the map

    • getBubblingTrack

      public Object getBubblingTrack(String name)
      Returns the object stored in the bubbling track map that corresponds to the key passed as parameter
      Parameters:
      name - The name of the key
      Returns:
      The object stored in the map, or null if the map is null

    • getReference

      public overit.geocall.servlet.Reference getReference()
      Return the Reference instance containing the information related to the calling URL
      Returns:
      instance containing the information related to the calling URL, or null it there's none.

    • toString

      public String toString()
      Overrides:
      toString in class Object