Package org.zkoss.stateless.sul

Interface IGoldenLayout

All Superinterfaces:
IAnyGroup<IGoldenLayout>, IChildable<IGoldenLayout,IGoldenPanel<IAnyGroup>>, IComponent<IGoldenLayout>, IHtmlBasedComponent<IGoldenLayout>, IXulElement<IGoldenLayout>
public interface IGoldenLayout extends IXulElement<IGoldenLayout>, IChildable<IGoldenLayout,IGoldenPanel<IAnyGroup>>, IAnyGroup<IGoldenLayout>
Immutable GoldenLayout component

GoldenLayout is a layout container which layouts panels as docker type and is used to represent GoldenLayout. GoldenLayout is the parent component, and its children component can only be GoldenPanel.

A GoldenLayout could be nested to another GoldenLayout (actually, almost all kinds of components) to form a complicated layout.

Author:
katherine
See Also:
  • GoldenLayout

  • Field Details

    • DEFAULT

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

  • Method Details

    • getWidgetClass

      default String getWidgetClass()
      Returns the client widget class.

      Default: "zkmax.goldenlayout.GoldenLayout"

      Specified by:
      getWidgetClass in interface IComponent<IGoldenLayout>

    • getAreas

      @Nullable String getAreas()
      Return the area of this GoldenPanel.

      Default: null

    • withAreas

      IGoldenLayout withAreas(@Nullable String areas)
      Returns a copy of this immutable component with the specified areas.

      Sets a matrix-like areas template, supports only on initial rendering. Notice that areas is only supported for the initial rendering. (i.e. it won't work with IGoldenLayout.Updater)

      Parameters:
      areas - The template of the goldenlayout.

      Default: null.

      Returns:
      A modified copy of the this object

    • getOrient

      default String getOrient()
      Returns the layout dividing orientation.

      Default: "vertical"

    • withOrient

      IGoldenLayout withOrient(String orient)
      Returns a copy of this immutable component with the specified orient.

      Sets the orient of component

      Parameters:
      orient - Either "horizontal" or "vertical"

      Default: "vertical".

      Returns:
      A modified copy of the this object

    • withOrient

      default IGoldenLayout withOrient(IGoldenLayout.Orient orient)
      Returns a copy of this immutable component with the specified orient.

      Sets the orient of component

      Parameters:
      orient - The orient

      Default: "vertical".

      Returns:
      A modified copy of the this object

    • of

      static IGoldenLayout of(Iterable<? extends IGoldenPanel<IAnyGroup>> children)
      Returns the instance with the given IGoldenPanel children.
      Parameters:
      children - The children of IGoldenPanel

    • of

      static IGoldenLayout of(IGoldenPanel<IAnyGroup>... children)
      Returns the instance with the given IGoldenPanel children.
      Parameters:
      children - The children of IGoldenPanel

    • ofSize

      static IGoldenLayout ofSize(String width, String height)
      Returns the instance with the given width and height
      Parameters:
      width - The width of the component
      height - The height of the component

    • ofFlex

      static IGoldenLayout ofFlex(String hflex, String vflex)
      Returns the instance with the given vflex and hflex
      Parameters:
      hflex - The horizontal flex hint
      vflex - The vertical flex hint

    • ofId

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