Package jakarta.faces.component.behavior

Class AjaxBehavior

    • Constructor Detail

      • AjaxBehavior

        public AjaxBehavior()
        Default constructor that just creates this instance.

    • Method Detail

      • getOnerror

        public String getOnerror()

        Return the String of JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.

        Returns:
        the JavaScript function name of ONERROR.
        Since:
        2.0

      • setOnerror

        public void setOnerror​(String onerror)

        Sets the JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.

        Parameters:
        onerror - the error handling function name
        Since:
        2.0

      • getOnevent

        public String getOnevent()

        Return the String of JavaScript function name that will be used to identify the client callback function that should be run on the occurance of a client-side event.

        Returns:
        the JavaScript function name of ONEVENT.
        Since:
        2.0

      • setOnevent

        public void setOnevent​(String onevent)

        Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity.

        Parameters:
        onevent - the event handling function name
        Since:
        2.0

      • getExecute

        public Collection<String> getExecute()

        Return a non-empty Collection<String> of component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.

        Note that the returned collection may be unmodifiable. Modifications should be performed by calling setExecute(java.util.Collection<java.lang.String>).

        Returns:
        the JavaScript function name of EXECUTE.
        Since:
        2.0

      • setExecute

        public void setExecute​(Collection<String> execute)

        Sets the component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.

        Parameters:
        execute - the ids of components to execute
        Since:
        2.0

      • getDelay

        public String getDelay()

        Returns the delay value, or null if no value was set.

        Returns:
        the delay value.
        Since:
        2.2

      • setDelay

        public void setDelay​(String delay)

        If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. The default value of this option is 300. If the value of delay is the literal string 'none' without the quotes, no delay is used.

        Parameters:
        delay - the ajax delay value
        Since:
        2.2

      • getRender

        public Collection<String> getRender()

        Return a non-empty Collection<String> of component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.

        Note that the returned collection may be unmodifiable. Modifications should be performed by calling setRender(java.util.Collection<java.lang.String>).

        Returns:
        the ids of components to render.
        Since:
        2.0

      • setRender

        public void setRender​(Collection<String> render)

        Sets the component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.

        Parameters:
        render - the ids of components to render
        Since:
        2.0

      • isResetValues

        public boolean isResetValues()

        Return the resetValues status of this behavior.

        Returns:
        the resetValues status.
        Since:
        2.2

      • setResetValues

        public void setResetValues​(boolean resetValues)

        Set the resetValues status of this behavior.

        Parameters:
        resetValues - the resetValues status.
        Since:
        2.2

      • isDisabled

        public boolean isDisabled()

        Return the disabled status of this behavior.

        Returns:
        the disabled status of this behavior.
        Since:
        2.0

      • setDisabled

        public void setDisabled​(boolean disabled)

        Sets the disabled status of this behavior.

        Parameters:
        disabled - the flag to be set.
        Since:
        2.0

      • isImmediate

        public boolean isImmediate()

        Return the immediate status of this behavior.

        Returns:
        the immediate status.
        Since:
        2.0

      • setImmediate

        public void setImmediate​(boolean immediate)

        Sets the immediate status of this behavior.

        Parameters:
        immediate - the flag to be set.
        Since:
        2.0

      • isImmediateSet

        public boolean isImmediateSet()

        Tests whether the immediate attribute is specified. Returns true if the immediate attribute is specified, either as a locally set property or as a value expression. This information allows an associated client behavior renderer to fall back on the parent component's immediate status when immediate is not explicitly specified on the AjaxBehavior.

        Returns:
        the flag whether the immediate attribute is specified.
        Since:
        2.0

      • isResetValuesSet

        public boolean isResetValuesSet()

        Tests whether the resetValues attribute is specified. Returns true if the resetValues attribute is specified, either as a locally set property or as a value expression.

        Returns:
        the flag whether the resetValues attribute is specified.
        Since:
        2.2