Package org.zkoss.stateless.sul

Interface IScript

All Superinterfaces:
IComponent<IScript>
public interface IScript extends IComponent<IScript>
Immutable Script component

A component to generate script codes that will be evaluated at the client. It is similar to HTML SCRIPT tag, except the defer option (withDefer(boolean)) will cause the evaluation of JavaScript until the widget has been instantiated and mounted to the DOM tree.

Author:
katherine
See Also:
  • Script

  • Field Details

    • DEFAULT

      static final IScript DEFAULT
      Constant for default attributes of this immutable component.

  • Method Details

    • getWidgetClass

      default String getWidgetClass()
      Returns the client widget class.

      Default: "zul.utl.Script"

      Specified by:
      getWidgetClass in interface IComponent<IScript>
      Returns:

    • getCharset

      @Nullable String getCharset()
      Returns the character encoding of the source. It is used with getSrc().

      Default: null.

    • withCharset

      IScript withCharset(@Nullable String charset)
      Returns a copy of this immutable component with the specified charset.

      Sets the character encoding of the source. It is used with withSrc(java.lang.String).

      Refer to HTML Character Setsfor more information.

      Parameters:
      charset - The character encoding of the source.

      Default: null.

      Returns:
      A modified copy of the this object

    • getSrc

      @Nullable String getSrc()
      Returns the URI of the source that contains the script codes.

      Default: null.

    • withSrc

      IScript withSrc(@Nullable String charset)
      Returns a copy of this immutable component with the specified charset.

      Sets the URI of the source that contains the script codes.

      Parameters:
      charset - The character encoding of the source.

      Default: null.

      Returns:
      A modified copy of the this object

    • isDefer

      default boolean isDefer()
      Returns whether to defer the execution of the script codes until the widget is instantiated and mounted.

      Default: false.

      Specifying false (default), if you want to do the desktop-level (or class-level) initialization, such as defining a widget class or a global function.

      Specifying true, if you want to access widgets. Notice that this references to this script widget.

    • withDefer

      IScript withDefer(boolean defer)
      Returns a copy of this immutable component with the specified defer.

      Sets whether to defer the execution of the script codes.

      Parameters:
      defer - Whether to defer the execution of the script codes.

      Default: false.

      Returns:
      A modified copy of the this object

    • getContent

      @Nullable String getContent()
      Returns the content of the script element. By content we mean the JavaScript codes that will be enclosed by the HTML SCRIPT element.

      Default: null.

    • withContent

      IScript withContent(@Nullable String content)
      Returns a copy of this immutable component with the specified content.

      Sets the content of the script element. By content we mean the JavaScript codes that will be enclosed by the HTML SCRIPT element.

      Parameters:
      content - The content of the script element.

      Default: null.

      Returns:
      A modified copy of the this object

    • getPackages

      @Nullable String getPackages()
      Returns the list of packages to load before evaluating the script defined in getContent(). It is meaning only if getContent() not null.

      Default: null.

    • withPackages

      IScript withPackages(@Nullable String packages)
      Returns a copy of this immutable component with the specified packages.

      Sets the list of packages to load before evaluating the script defined in getContent(). If more than a package to load, separate them with comma.

      Parameters:
      packages - The list of packages to load before evaluating the script.

      Default: null.

      Returns:
      A modified copy of the this object

    • of

      static IScript of(String content)
      Returns the instance with the given content.
      Parameters:
      content - The script content.

    • ofSrc

      static IScript ofSrc(String src)
      Returns the instance with the given src.
      Parameters:
      src - The script URI.

    • ofId

      static IScript ofId(String id)
      Returns the instance with the given id.
      Parameters:
      id - The id to identify this component