Package org.zkoss.stateless.sul

Interface IGroupbox<I extends IAnyGroup>

All Superinterfaces:
IAnyGroup<IGroupbox<I>>, IChildable<IGroupbox<I>,I>, IComponent<IGroupbox<I>>, IComposite<IGroupbox<I>,IAnyGroup>, IHtmlBasedComponent<IGroupbox<I>>, IXulElement<IGroupbox<I>>
public interface IGroupbox<I extends IAnyGroup> extends IXulElement<IGroupbox<I>>, IChildable<IGroupbox<I>,I>, IAnyGroup<IGroupbox<I>>, IComposite<IGroupbox<I>,IAnyGroup>
Immutable Groupbox component.

A group box is used to group components together. A border is typically drawn around the components to show that they are related. The label across the top of the group box can be created by using Caption component. It works much like the HTML legend element. Unlike IWindow, a group box cannot be overlapped or popup.

Support @Action

Name Action Type
onOpen ActionData: OpenData
Denotes user has opened or closed a component.

Support Molds

Name Snapshot
"default"
"3d"
Author:
katherine
See Also:
  • Groupbox

  • Field Details

    • DEFAULT

      static final IGroupbox<IAnyGroup> DEFAULT
      Constant for default attributes of this immutable component.

    • THREE_D

      static final IGroupbox<IAnyGroup> THREE_D
      Constant for 3d attributes of this immutable component.

  • Method Details

    • getWidgetClass

      default String getWidgetClass()
      Returns the client widget class.

      Default: "zul.wgt.Groupbox"

      Specified by:
      getWidgetClass in interface IComponent<I extends IAnyGroup>

    • getCaption

      @Nullable ICaption getCaption()
      Returns the caption child of this groupbox.

    • withCaption

      IGroupbox<I> withCaption(@Nullable ICaption caption)
      Returns a copy of this immutable component with the specified caption.

      Sets the caption child of this component.

      Parameters:
      caption - The caption child of the component.

      Default: null.

      Returns:
      A modified copy of the this object

    • getContentStyle

      @Nullable String getContentStyle()
      Returns the CSS style for the content block of the groupbox. Used only if IComponent.getMold() is not "default".

    • withContentStyle

      IGroupbox<I> withContentStyle(@Nullable String contentStyle)
      Returns a copy of this immutable component with the specified contentStyle.

      Sets the CSS style for the content block of the groupbox. Used only if IComponent.getMold() is not "default".

      Parameters:
      contentStyle - The CSS style for the content block of the groupbox.

      Default: null.

      Returns:
      A modified copy of the this object

    • getContentSclass

      @Nullable String getContentSclass()
      Returns the style class used for the content block of the groupbox. Used only if IComponent.getMold() is not "default".

    • withContentSclass

      IGroupbox<I> withContentSclass(@Nullable String contentSclass)
      Returns a copy of this immutable component with the specified contentSclass.

      Sets the style class used for the content block of the groupbox.

      Parameters:
      contentSclass - The style class used for the content block of the groupbox

      Default: null.

      Returns:
      A modified copy of the this object

    • getTitle

      default String getTitle()
      Returns the title. Besides this attribute, you could use ICaption to define a more sophisticated caption (a.k.a., title).

      It will be displayed before caption if both are applied.

      Default: "" (empty).

    • withTitle

      IGroupbox<I> withTitle(String title)
      Returns a copy of this immutable component with the specified title.

      Sets the title. Besides this attribute, you could use ICaption to define a more sophisticated caption (a.k.a., title).

      It will be displayed before caption if both are applied.

      Parameters:
      title - The title of the component.

      Default: "" (empty).

      Returns:
      A modified copy of the this object

    • isOpen

      default boolean isOpen()
      Returns whether this groupbox is open.

      Default: true.

    • withOpen

      IGroupbox<I> withOpen(boolean open)
      Returns a copy of this immutable component with the specified open.

      Sets to open or close this groupbox.

      Parameters:
      open - Whether to open or close this groupbox

      Default: true.

      Returns:
      A modified copy of the this object

    • isClosable

      default boolean isClosable()
      Returns whether user can open or close the group box. In other words, if false, users are no longer allowed to change the open status (by clicking on the title).

      Default: true.

    • withClosable

      IGroupbox<I> withClosable(boolean closable)
      Returns a copy of this immutable component with the specified closable.

      Sets whether user can open or close the group box. In other words, if false, users are no longer allowed to change the open status (by clicking on the title).

      Parameters:
      closable - Whether user can open or close the group box.

      Default: true.

      Returns:
      A modified copy of the this object

    • isNativeScrollbar

      default boolean isNativeScrollbar()
      Returns whether to use Browser's scrollbar or a floating scrollbar (if with false).

      Default: true to use Browser's scrollbar, if the "org.zkoss.zul.nativebar" library property is not set in zk.xml.

    • withNativeScrollbar

      IGroupbox withNativeScrollbar(boolean nativeScrollbar)
      Returns a copy of this immutable component with the specified nativeScrollbar.

      Sets to use Browser's scrollbar or a floating scrollbar

      Parameters:
      nativeScrollbar - true to use Browser's scrollbar, or false to use a floating scrollbar.

      Default: true.

      Returns:
      A modified copy of the this object

    • withAllComponents

      default IGroupbox<I> withAllComponents(Iterable<? extends IAnyGroup> elements)
      Description copied from interface: IComposite
      Copy the current immutable object with elements that replace the content of children. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Specified by:
      withAllComponents in interface IComposite<IGroupbox<I extends IAnyGroup>,IAnyGroup>
      Parameters:
      elements - An iterable of children elements to set
      Returns:
      A modified copy of this object

    • of

      static <I extends IAnyGroup> IGroupbox<I> of(Iterable<? extends I> children)
      Returns the instance with the given any group children.
      Parameters:
      children - The children belong to any group
      See Also:

    • of

      static <I extends IAnyGroup> IGroupbox<I> of(I... children)
      Returns the instance with the given any group children.
      Parameters:
      children - The children belong to any group
      See Also:

    • ofCaption

      static <I extends IAnyGroup> IGroupbox<I> ofCaption(ICaption caption)
      Returns the instance with the given caption.
      Parameters:
      caption - The caption child

    • ofId

      static <I extends IAnyGroup> IGroupbox<I> ofId(String id)
      Returns the instance with the given id.
      Parameters:
      id - The id to identify this component

    • ofTitle

      static <I extends IAnyGroup> IGroupbox<I> ofTitle(String title)
      Returns the instance with the given title.
      Parameters:
      title - The title of the groupbox.

    • ofSize

      static <I extends IAnyGroup> IGroupbox<I> ofSize(String width, String height)
      Returns the instance with the given size, width and height
      Parameters:
      width - The width of the component
      height - The height of the component