Package com.hybris.cockpitng.renderers.header

Interface WidgetCaptionWrapper

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addListener​(java.lang.String eventName, WidgetCaptionEventListener eventListener)  
      void close()
      Closes the container (this usually means that the related widget instance is removed).
      void hideContainerControls​(int controls)
      Call this in your renderer method to hide standard controls from the container, e.g.
      boolean isClosable()
      Returns true if the current state of the container allows closing.
      boolean isCollapsed()
      Returns true if the caption indicates that the container is collapsed.
      boolean isCollapsible()
      Returns true if the current state of the container allows collapsing.
      boolean isFocused()
      Returns true if the caption indicates that the container is focused/selected.
      boolean isMaximizable()
      Returns true if the current state of the container allows maximizing.
      boolean isMaximized()
      Returns true if the caption indicates that the container is maximized.
      boolean isMinimizable()
      Returns true if the current state of the container allows minimizing.
      boolean isMinimized()
      Returns true if the caption indicates that the container is minimized.
      void setCollapsed​(boolean collapsed)
      Expands or collapses the container according to the argument.
      void setFocused​(boolean focused)
      Sets the focus to (or selects) the current widget within it's widgetchildren container.
      void setMaximized​(boolean maximized)
      Maximizes/unmaximizes the container according to the argument.
      void setMinimized​(boolean minimized)
      Minimizes/unminimizes the container according to the argument.

    • Method Detail

      • isCollapsed

        boolean isCollapsed()
        Returns true if the caption indicates that the container is collapsed.

      • setCollapsed

        void setCollapsed​(boolean collapsed)
        Expands or collapses the container according to the argument.

      • isMinimized

        boolean isMinimized()
        Returns true if the caption indicates that the container is minimized.

      • setMinimized

        void setMinimized​(boolean minimized)
        Minimizes/unminimizes the container according to the argument.

      • isMaximized

        boolean isMaximized()
        Returns true if the caption indicates that the container is maximized.

      • setMaximized

        void setMaximized​(boolean maximized)
        Maximizes/unmaximizes the container according to the argument.

      • isFocused

        boolean isFocused()
        Returns true if the caption indicates that the container is focused/selected.

      • setFocused

        void setFocused​(boolean focused)
        Sets the focus to (or selects) the current widget within it's widgetchildren container.

      • close

        void close()
        Closes the container (this usually means that the related widget instance is removed).

      • isCollapsible

        boolean isCollapsible()
        Returns true if the current state of the container allows collapsing.

      • isMinimizable

        boolean isMinimizable()
        Returns true if the current state of the container allows minimizing.

      • isMaximizable

        boolean isMaximizable()
        Returns true if the current state of the container allows maximizing.

      • isClosable

        boolean isClosable()
        Returns true if the current state of the container allows closing.

      • hideContainerControls

        void hideContainerControls​(int controls)
        Call this in your renderer method to hide standard controls from the container, e.g. if you want to render buttons to control minimizing and maximizing of the widget and thus don't need the minimize/maximize buttons of a window/panel/... you could use

        hideContainerControls(WidgetCaptionWrapper.CONTROL_MINIMIZE | WidgetCaptionWrapper.CONTROL_MAXIMIZE)

      • addListener

        void addListener​(java.lang.String eventName,
                 WidgetCaptionEventListener eventListener)
        Parameters:
        eventListener - a listener to be notified when an operation happens