Class Ajax

    • Method Detail

      • getContext

        public static PartialViewContext getContext()
        Returns the current partial view context (the ajax context).

        Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.

        Returns:
        The current partial view context.
        See Also:
        FacesContext.getPartialViewContext()
      • update

        public static void update​(String... clientIds)
        Update the given client IDs in the current ajax response. Note that those client IDs should not start with the naming container separator character like :. This method also supports the client ID keywords @all, @form and @this which respectively refers the entire view, the currently submitted form as obtained by Components.getCurrentForm() and the currently processed component as obtained by UIComponent.getCurrentComponent(FacesContext). Any other client ID starting with @ is by design ignored, including @none.
        Parameters:
        clientIds - The client IDs to be updated in the current ajax response.
        See Also:
        PartialViewContext.getRenderIds()
      • updateRow

        public static void updateRow​(UIData table,
                                     int index)
        Update the row of the given UIData component at the given zero-based row index. This will basically update all direct children of all UIColumn components at the given row index.

        Note that the to-be-updated direct child of UIColumn must be a fullworthy Faces UI component which renders a concrete HTML element to the output, so that JS/ajax can update it. So if you have due to design restrictions for example a <h:panelGroup rendered="..."> without an ID, then you should give it an ID. This way it will render a <span id="..."> which is updateable by JS/ajax.

        Parameters:
        table - The UIData component.
        index - The zero-based index of the row to be updated.
        Since:
        1.3
      • updateColumn

        public static void updateColumn​(UIData table,
                                        int index)
        Update the column of the given UIData component at the given zero-based column index. This will basically update all direct children of the UIColumn component at the given column index in all rows. The column index is the physical column index and does not depend on whether one or more columns is rendered or not (i.e. it is not necessarily the same column index as the enduser sees in the UI).

        Note that the to-be-updated direct child of UIColumn must be a fullworthy Faces UI component which renders a concrete HTML element to the output, so that JS/ajax can update it. So if you have due to design restrictions for example a <h:panelGroup rendered="..."> without an ID, then you should give it an ID. This way it will render a <span id="..."> which is updateable by JS/ajax.

        Parameters:
        table - The UIData component.
        index - The zero-based index of the column to be updated.
        Since:
        1.3
      • data

        public static void data​(Object... namesValues)
        Add the given data arguments to the current ajax response. The arguments length must be even. Every first and second argument is considered the name and value pair. The name must always be a String. They are as JSON object available by OmniFaces.Ajax.data.
        Parameters:
        namesValues - The argument names and values.
        Throws:
        IllegalArgumentException - When the arguments length is not even, or when a name is not a string.
        See Also:
        OmniPartialViewContext.addArgument(String, Object)
      • isExecuted

        public static boolean isExecuted​(String clientId)
        Returns true if the given client ID was executed in the current ajax request.
        Parameters:
        clientId - The client ID to be checked.
        Returns:
        true if the given client ID was executed in the current ajax request.
        Since:
        3.6