Package com.vaadin.client.ui

Class VTabsheetBase

  • All Implemented Interfaces:
    com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>
    Direct Known Subclasses:
    VAccordion, VTabsheet
    public abstract class VTabsheetBase
extends com.google.gwt.user.client.ui.ComplexPanel
implements com.google.gwt.user.client.ui.HasEnabled

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

        com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

      • Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

        com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

      • Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

        com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addTabKey​(String key, boolean disabled)
      For internal use only.
      protected abstract void clearPaintables()
      Clears current tabs and contents
      void clearTabKeys()
      For internal use only.
      protected ComponentConnector getConnectorForWidget​(com.google.gwt.user.client.ui.Widget widget)
      For internal use only.
      abstract ComponentConnector getTab​(int index)
      Implement in extending classes.
      abstract int getTabCount()
      Implement in extending classes.
      abstract Iterator<com.google.gwt.user.client.ui.Widget> getWidgetIterator()  
      protected boolean isDynamicHeight()
      Returns true if the height of the widget is undefined, false otherwise.
      protected boolean isDynamicWidth()
      Returns true if the width of the widget is undefined, false otherwise.
      boolean isEnabled()  
      boolean isTabCaptionsAsHtml()
      Checks whether captions are rendered as HTML The default is false, i.e.
      abstract void removeTab​(int index)
      Implement in extending classes.
      abstract void renderTab​(TabState tabState, int index)
      Implement in extending classes.
      abstract void selectTab​(int index)
      For internal use only.
      void setActiveTabIndex​(int activeTabIndex)
      For internal use only.
      void setClient​(ApplicationConnection client)
      For internal use only.
      void setConnector​(AbstractComponentConnector connector)
      Sets the connector that should be notified of events etc.
      void setEnabled​(boolean enabled)
      For internal use only.
      void setReadonly​(boolean readonly)
      For internal use only.
      void setTabCaptionsAsHtml​(boolean tabCaptionsAsHtml)
      Sets whether the caption is rendered as HTML.

      • Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

        add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

      • Methods inherited from class com.google.gwt.user.client.ui.Panel

        add, add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

      • Methods inherited from class com.google.gwt.user.client.ui.Widget

        addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

      • Methods inherited from class com.google.gwt.user.client.ui.UIObject

        addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

    • Field Detail

      • client

        protected ApplicationConnection client
        For internal use only. May be removed or replaced in the future.

      • tabKeys

        protected final ArrayList<String> tabKeys
        For internal use only. May be removed or replaced in the future.

      • disabledTabKeys

        protected Set<String> disabledTabKeys
        For internal use only. May be removed or replaced in the future.

      • activeTabIndex

        protected int activeTabIndex
        For internal use only. May be removed or replaced in the future.

      • disabled

        protected boolean disabled
        For internal use only. May be removed or replaced in the future.

      • readonly

        protected boolean readonly
        For internal use only. May be removed or replaced in the future.

    • Constructor Detail

      • VTabsheetBase

        public VTabsheetBase​(String classname)

    • Method Detail

      • getWidgetIterator

        public abstract Iterator<com.google.gwt.user.client.ui.Widget> getWidgetIterator()
        Returns:
        a list of currently shown Widgets

      • clearPaintables

        protected abstract void clearPaintables()
        Clears current tabs and contents

      • renderTab

        public abstract void renderTab​(TabState tabState,
                               int index)
        Implement in extending classes. This method should render needed elements and set the visibility of the tab according to the 'selected' parameter.

      • getTabCount

        public abstract int getTabCount()
        Implement in extending classes. This method should return the number of tabs currently rendered.

      • getTab

        public abstract ComponentConnector getTab​(int index)
        Implement in extending classes. This method should return the Paintable corresponding to the given index.

      • removeTab

        public abstract void removeTab​(int index)
        Implement in extending classes. This method should remove the rendered tab with the specified index.

      • isDynamicWidth

        protected boolean isDynamicWidth()
        Returns true if the width of the widget is undefined, false otherwise.
        Returns:
        true if width of the widget is determined by its content
        Since:
        7.2

      • isDynamicHeight

        protected boolean isDynamicHeight()
        Returns true if the height of the widget is undefined, false otherwise.
        Returns:
        true if width of the height is determined by its content
        Since:
        7.2

      • setConnector

        public void setConnector​(AbstractComponentConnector connector)
        Sets the connector that should be notified of events etc. For internal use only. This method may be removed or replaced in the future.
        Parameters:
        connector -
        Since:
        7.2

      • clearTabKeys

        public void clearTabKeys()
        For internal use only. May be removed or replaced in the future.

      • addTabKey

        public void addTabKey​(String key,
                      boolean disabled)
        For internal use only. May be removed or replaced in the future.

      • setClient

        public void setClient​(ApplicationConnection client)
        For internal use only. May be removed or replaced in the future.

      • setActiveTabIndex

        public void setActiveTabIndex​(int activeTabIndex)
        For internal use only. May be removed or replaced in the future.

      • setEnabled

        public void setEnabled​(boolean enabled)
        For internal use only. May be removed or replaced in the future.
        Specified by:
        setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

      • setReadonly

        public void setReadonly​(boolean readonly)
        For internal use only. May be removed or replaced in the future.

      • getConnectorForWidget

        protected ComponentConnector getConnectorForWidget​(com.google.gwt.user.client.ui.Widget widget)
        For internal use only. May be removed or replaced in the future.

      • selectTab

        public abstract void selectTab​(int index)
        For internal use only. May be removed or replaced in the future.

      • isEnabled

        public boolean isEnabled()
        Specified by:
        isEnabled in interface com.google.gwt.user.client.ui.HasEnabled

      • setTabCaptionsAsHtml

        public void setTabCaptionsAsHtml​(boolean tabCaptionsAsHtml)
        Sets whether the caption is rendered as HTML.

        The default is false, i.e. render tab captions as plain text

        Parameters:
        captionAsHtml - true if the captions are rendered as HTML, false if rendered as plain text
        Since:
        7.4

      • isTabCaptionsAsHtml

        public boolean isTabCaptionsAsHtml()
        Checks whether captions are rendered as HTML The default is false, i.e. render tab captions as plain text
        Returns:
        true if the captions are rendered as HTML, false if rendered as plain text
        Since:
        7.4