Package com.vaadin.client.ui

Class VTabsheet

  • 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, Focusable, SubPartAware, Iterable<com.google.gwt.user.client.ui.Widget>
    public class VTabsheet
extends VTabsheetBase
implements Focusable, SubPartAware

    • Field Detail

      • tabs

        public final com.google.gwt.dom.client.Element tabs
        For internal use only. May be removed or replaced in the future.

      • tabPanel

        protected final VTabsheetPanel tabPanel
        For internal use only. May be removed or replaced in the future.

      • contentNode

        public final com.google.gwt.dom.client.Element contentNode
        For internal use only. May be removed or replaced in the future.

      • waitingForResponse

        public boolean waitingForResponse
        For internal use only. May be removed or replaced in the future.

    • Constructor Detail

      • VTabsheet

        public VTabsheet()

    • Method Detail

      • loadTabSheet

        public boolean loadTabSheet​(int tabIndex)
        Load the content of a tab of the provided index.
        Parameters:
        index - of the tab to load
        Returns:
        true if the specified sheet gets loaded, otherwise false.

      • getCurrentlyDisplayedWidget

        public com.google.gwt.user.client.ui.Widget getCurrentlyDisplayedWidget()
        Returns the currently displayed widget in the tab panel.
        Returns:
        currently displayed content widget
        Since:
        7.2

      • getRpcProxy

        protected TabsheetServerRpc getRpcProxy()
        Returns the client to server RPC proxy for the tabsheet.
        Returns:
        RPC proxy
        Since:
        7.2

      • getApplicationConnection

        @Deprecated
public ApplicationConnection getApplicationConnection()
        Deprecated.
        since 7.2 - use more specific methods instead (getRpcProxy(), getConnectorForWidget(Widget) etc.)
        For internal use only. Avoid using this method directly and use appropriate superclass methods where applicable.
        Returns:
        ApplicationConnection

      • tabSizeMightHaveChanged

        public void tabSizeMightHaveChanged​(VTabsheet.Tab tab)

      • onBrowserEvent

        public void onBrowserEvent​(com.google.gwt.user.client.Event event)
        Specified by:
        onBrowserEvent in interface com.google.gwt.user.client.EventListener
        Overrides:
        onBrowserEvent in class com.google.gwt.user.client.ui.Widget

      • handleStyleNames

        public void handleStyleNames​(AbstractComponentState state)
        For internal use only. May be removed or replaced in the future.

      • updateDynamicWidth

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

      • renderTab

        public void renderTab​(TabState tabState,
                      int index)
        Description copied from class: VTabsheetBase
        Implement in extending classes. This method should render needed elements and set the visibility of the tab according to the 'selected' parameter.
        Specified by:
        renderTab in class VTabsheetBase

      • renderContent

        public void renderContent​(com.google.gwt.user.client.ui.Widget newWidget)
        Renders the widget content for a tab sheet.
        Parameters:
        newWidget -

      • updateContentNodeHeight

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

      • iLayout

        public void iLayout()
        Run internal layouting.

      • updateOpenTabSize

        public void updateOpenTabSize()
        Sets the size of the visible tab (component). As the tab is set to position: absolute (to work around a firefox flickering bug) we must keep this up-to-date by hand.

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

      • showAllTabs

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

      • getWidgetIterator

        public Iterator<com.google.gwt.user.client.ui.Widget> getWidgetIterator()
        Specified by:
        getWidgetIterator in class VTabsheetBase
        Returns:
        a list of currently shown Widgets

      • getContentAreaBorderWidth

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

      • getTabCount

        public int getTabCount()
        Description copied from class: VTabsheetBase
        Implement in extending classes. This method should return the number of tabs currently rendered.
        Specified by:
        getTabCount in class VTabsheetBase

      • getTab

        public ComponentConnector getTab​(int index)
        Description copied from class: VTabsheetBase
        Implement in extending classes. This method should return the Paintable corresponding to the given index.
        Specified by:
        getTab in class VTabsheetBase

      • removeTab

        public void removeTab​(int index)
        Description copied from class: VTabsheetBase
        Implement in extending classes. This method should remove the rendered tab with the specified index.
        Specified by:
        removeTab in class VTabsheetBase

      • selectTab

        public void selectTab​(int index)
        Description copied from class: VTabsheetBase
        For internal use only. May be removed or replaced in the future.
        Specified by:
        selectTab in class VTabsheetBase

      • focus

        public void focus()
        Description copied from interface: Focusable
        Sets focus to this widget.
        Specified by:
        focus in interface Focusable

      • blur

        public void blur()

      • getPreviousTabKey

        protected int getPreviousTabKey()
        Returns:
        The key code of the keyboard shortcut that selects the previous tab in a focused tabsheet.

      • getSelectTabKey

        protected int getSelectTabKey()
        Gets the key to activate the selected tab when navigating using previous/next (left/right) keys.
        Returns:
        the key to activate the selected tab.
        See Also:
        getNextTabKey(), getPreviousTabKey()

      • getNextTabKey

        protected int getNextTabKey()
        Returns:
        The key code of the keyboard shortcut that selects the next tab in a focused tabsheet.

      • getCloseTabKey

        protected int getCloseTabKey()
        Returns:
        The key code of the keyboard shortcut that closes the currently selected tab in a focused tabsheet.

      • showTabs

        public void showTabs()
        Makes tab bar visible.
        Since:
        7.2

      • hideTabs

        public void hideTabs()
        Makes tab bar invisible.
        Since:
        7.2

      • getSubPartElement

        public com.google.gwt.user.client.Element getSubPartElement​(String subPart)
        Description copied from interface: SubPartAware
        Locates an element inside a component using the identifier provided in subPart. The subPart identifier is component specific and may be any string of characters, numbers, space characters and brackets.
        Specified by:
        getSubPartElement in interface SubPartAware
        Parameters:
        subPart - The identifier for the element inside the component
        Returns:
        The element identified by subPart or null if the element could not be found.

      • getSubPartName

        public String getSubPartName​(com.google.gwt.user.client.Element subElement)
        Description copied from interface: SubPartAware
        Provides an identifier that identifies the element within the component. The subElement is a part of the component and must never be null.

        Note! getSubPartElement(getSubPartName(element)) == element is not always true. A component can choose to provide a more generic identifier for any given element if the results of all interactions with subElement are the same as interactions with the element identified by the return value. For example a button can return an identifier for the root element even though a DIV inside the button was passed as subElement because interactions with the DIV and the root button element produce the same result.

        Specified by:
        getSubPartName in interface SubPartAware
        Parameters:
        subElement - The element the identifier string should uniquely identify
        Returns:
        An identifier that uniquely identifies subElement or null if no identifier could be provided.