Options
All
  • Public
  • Public/Protected
  • All
Menu

PrimeFaces TabView Widget

TabView is a container component to group content in tabs.

Type parameters

  • TCfg: TabViewCfg = TabViewCfg

    Defaults to TabViewCfg. Type of the configuration object for this widget.

Hierarchy

Index

Constructors

constructor

  • Creates a new instance of this widget. Please note that you should NOT override this constructor. Instead, override the init method, which is called at the end of the constructor once the instance is created.

    Type parameters

    Parameters

    • cfg: PartialWidgetCfg<TCfg>

      The widget configuration to be used for this widget instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for this component.

    Returns TabView<TCfg>

Properties

cfg

cfg: PartialWidgetCfg<TCfg>

The configuration of this widget instance. Please note that no property is guaranteed to be present, you should always check for undefined before accessing a property. This is partly because the value of a property is not transmitted from the server to the client when it equals the default.

destroyListeners

Array of registered listeners invoked when this widget is destroyed. You should normally not use modify this directly, use addDestroyListener instead.

firstTab

firstTab: JQuery<HTMLElement>

The DOM element for the first tab.

focusedTab

focusedTab: JQuery<HTMLElement>

The DOM element for the tab that is currently focused.

headerContainer

headerContainer: JQuery<HTMLElement>

The DOM element for the container element with the tab header.

id

id: string | string[]

The client-side ID of this widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

jq

The jQuery instance of the container element of this widget. In case id is an array, it will contain multiple elements. Please note that some widgets have got not DOM elements at all, in this case this will be an empty jQuery instance.

jqId

jqId: string

A CSS selector for the container element (or elements, in case id is an array) of this widget, This is usually an ID selector (that is properly escaped). You can select the container element or elements like this: $(widget.jqId).

lastTab

The DOM element for the last tab.

navContainer

navContainer: JQuery<HTMLElement>

The DOM element for the container element with the tab navigation bar.

navcrollerLeft

navcrollerLeft: JQuery<HTMLElement>

The DOM element for the button that scrolls the tab navigation bar to the left.

navcrollerRight

navcrollerRight: JQuery<HTMLElement>

The DOM element for the button that scrolls the tab navigation bar to the right.

navscroller

navscroller: JQuery<HTMLElement>

The DOM element for the tab navigation bar.

panelContainer

panelContainer: JQuery<HTMLElement>

The DOM element for the panel with the tab's contents.

refreshListeners

Array of registered listeners invoked when this widget is refreshed. You should normally not use modify this directly, use addRefreshListener instead.

scrollStateHolder

scrollStateHolder: JQuery<HTMLElement>

The DOM element for the hidden input field storing the current scroll position.

stateHolder

stateHolder: JQuery<HTMLElement>

The DOM element for the hidden input field storing which is tab is active and visible.

tabindex

tabindex: number

Position of the element in the tabbing order.

widgetVar

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF('myWidgetVar').

Methods

Protected _render

  • _render(): void
  • This render method is called by this deferred widget once the widget container has become visible. You may now proceed with widget initialization.

    Must be overridden, or an error will be thrown.

    override

    Returns void

Protected addDeferredRender

  • addDeferredRender(widgetId: string, container: JQuery<HTMLElement>, callback: () => boolean): void
  • Adds a deferred rendering task for the given widget to the queue.

    Parameters

    • widgetId: string

      The ID of a deferred widget.

    • container: JQuery<HTMLElement>

      The container element that should be visible.

    • callback: () => boolean

      Callback that is invoked when the widget may possibly have become visible. Should return true when the widget was rendered, or false when the widget still needs to be rendered later.

        • (): boolean
        • Returns boolean

    Returns void

addDestroyListener

  • Lets you register a listener that is called before the component is destroyed.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and all destroy listeners are called. This makes it possible to add listeners from outside the widget code.

    If you call this method twice with the same listener, it will be registered twice and later also called twice.

    Note that for this to work, you must not override the destroy method; or if you do, call super.

    Also, after this widget was detached is done, all destroy listeners will be unregistered.

    since

    7.0

    Parameters

    Returns void

addRefreshListener

  • When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, all refresh listeners are called. This makes it possible to add listeners from outside the widget code.

    If you call this method twice with the same listener, it will be registered twice and later also called twice.

    Note that for this to work, you must not override the refresh method; or if you do, call super.

    Also, after the refresh is done, all refresh listeners will be deregistered. If you added the listeners from within this widget, consider adding the refresh listeners not only in the init method, but also again in the refresh method after calling super.

    since

    7.0.0

    Parameters

    Returns void

Private bindEvents

  • bindEvents(): void
  • Sets up all event listeners that are required by this widget.

    Returns void

Private bindKeyEvents

  • bindKeyEvents(): void
  • Sets up all keyboard related event listeners that are required by this widget.

    Returns void

Private bindSwipeEvents

  • bindSwipeEvents(): void
  • Binds swipe events to this tabview.

    Returns void

callBehavior

  • Each widget may have one or several behaviors attached to it. This method calls all attached behaviors for the given event name. In case no such behavior exists, this method does nothing and returns immediately.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    since

    7.0

    Parameters

    • event: string

      The name of an event to call.

    • Optional ext: Partial<ConfigurationExtender>

      Additional configuration that is passed to the AJAX request for the server-side callback.

    Returns void

destroy

  • destroy(): void
  • Cleans up deferred render tasks. When you extend this class and override this method, make sure to call super.

    override

    Returns void

disable

  • disable(index: number): void
  • Disables the tab at the given index. Disabled tabs may not be selected.

    Parameters

    • index: number

      0-based index of the tab to disable.

    Returns void

disableScrollerButton

  • Disables the buttons for scrolling the contents of the navigation bar.

    Parameters

    Returns void

enable

  • enable(index: number): void
  • Enables the tab at the given index. Enabled tabs may be selected.

    Parameters

    • index: number

      0-based index of the tab to enable.

    Returns void

enableScrollerButton

  • Enables the buttons for scrolling the contents of the navigation bar.

    Parameters

    Returns void

Private fireTabChangeEvent

  • Calls the appropriate behaviors when a different tab was selected.

    Parameters

    Returns void

Private fireTabCloseEvent

  • fireTabCloseEvent(id: string, index: number): void
  • Calls the appropriate behaviors when a tab was closed.

    Parameters

    • id: string

      Client ID of the tab that was closed.

    • index: number

      0-based index of the tab that was closed.

    Returns void

getActiveIndex

  • getActiveIndex(): number
  • Finds and returns the tab that is currently selected.

    Returns number

    The 0-based index of the currently selected tab.

getBehavior

  • getBehavior(name: string): null | Behavior
  • Each widget may have one or several behaviors attached to it. This method returns the callback function for the given event.

    Note: Do not call the method directly, the recommended way to invoke a behavior is via callBehavior.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    Parameters

    • name: string

      The name of an event for which to retrieve the behavior.

    Returns null | Behavior

    The behavior with the given name, or null if no such behavior exists.

getJQ

  • Each widget has got a container element, this method returns that container. This container element is usually also the element whose ID is the client-side ID of the JSF component.

    Returns JQuery<HTMLElement>

    The jQuery instance representing the main HTML container element of this widget.

getLength

  • getLength(): number
  • Fins the number of tabs of this tab view.

    Returns number

    The number of tabs.

getParentForm

  • Gets the closest parent form for this widget.

    since

    10.0.0

    Returns JQuery<HTMLElement>

    A JQuery instance that either contains the form when found, or an empty JQuery instance when the form could not be found.

getParentFormId

  • getParentFormId(): undefined | string
  • Gets the closest parent form ID for this widget lazily so it can be used in AJAX requests.

    since

    10.0.0

    Returns undefined | string

    Either the form ID or undefined if no form can be found.

hasBehavior

  • hasBehavior(event: string): boolean
  • Each widget may have one or several behaviors attached to it. This method checks whether this widget has got at least one behavior associated with given event name.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    Parameters

    • event: string

      The name of an event to check.

    Returns boolean

    true if this widget has the given behavior, false otherwise.

init

  • A widget class should not declare an explicit constructor, the default constructor provided by this base widget should be used. Instead, override this initialize method which is called after the widget instance was constructed. You can use this method to perform any initialization that is required. For widgets that need to create custom HTML on the client-side this is also the place where you should call your render method.

    Please make sure to call the super method first before adding your own custom logic to the init method:

    PrimeFaces.widget.MyWidget = PrimeFaces.widget.BaseWidget.extend({
      init: function(cfg) {
        this._super(cfg);
        // custom initialization
      }
    });
    
    override

    Parameters

    • cfg: PartialWidgetCfg<TCfg>

      The widget configuration to be used for this widget instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for this component.

    Returns void

Private initScrolling

  • initScrolling(): void
  • Sets up the classes and attributes required for scrolling the tab navigation bar.

    Returns void

isDetached

  • isDetached(): boolean
  • Checks if this widget is detached, ie whether the HTML element of this widget is currently contained within the DOM (the HTML body element). A widget may become detached during an AJAX update, and it may remain detached in case the update removed this component from the component tree.

    Returns boolean

    true if this widget is currently detached, or false otherwise.

Private isLoaded

  • If the content of the tab is loaded dynamically via AJAX, checks if the content was loaded already.

    Parameters

    Returns boolean

    Whether the content of the given panel was loaded from the server.

Private loadDynamicTab

  • Dynamically loads contents of a tab from the server via AJAX.

    Parameters

    Returns void

Private markAsLoaded

  • Marks the content of the given tab as loaded.

    Parameters

    Returns void

Protected postRender

  • postRender(): void
  • Called after the widget has become visible and after it was rendered. May be overridden, the default implementation is a no-op.

    Returns void

Private postTabShow

  • Callback that is invoked after a tab was shown.

    Parameters

    Returns void

refresh

  • Used in ajax updates, reloads the widget configuration.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, this method is called with the new widget configuration from the server. This makes it possible to persist client-side state during an update, such as the currently selected tab.

    Please note that instead of overriding this method, you should consider adding a refresh listener instead via addRefreshListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.

    By default, this method calls all refresh listeners, then reinitializes the widget by calling the init method.

    Parameters

    Returns unknown

    The value as returned by the init method, which is often undefined.

remove

  • remove(index: number): void
  • Closes the tab at the given index.

    Parameters

    • index: number

      0-based index of the tab to close.

    Returns void

removeScriptElement

  • removeScriptElement(clientId: string | string[]): void
  • Removes the widget's script block from the DOM. Currently, the ID of this script block consists of the client-side ID of this widget with the prefix _s, but this is subject to change.

    Parameters

    • clientId: string | string[]

      The client-side ID of the widget.

    Returns void

render

  • This render method to check whether the widget container is visible. Do not override this method, or the deferred widget functionality may not work properly anymore.

    Returns ReturnOrVoid<undefined | boolean>

    true if the widget container is visible, false or undefined otherwise.

renderDeferred

  • renderDeferred(): void
  • Call this method in the init method if you want deferred rendering support. This method checks whether the container of this widget is visible and call _render only once it is.

    override

    Returns void

Private restoreScrollState

  • restoreScrollState(): void
  • Restores the current scroll position in a hidden input field, called after an AJAX request.

    Returns void

Private saveScrollState

  • saveScrollState(value: number): void
  • Stores the current scroll position in a hidden input field, called before an AJAX request.

    Parameters

    • value: number

      The scroll position to be saved.

    Returns void

scroll

  • scroll(step: number): void
  • Scrolls the tab navigation bar by the given amount.

    Parameters

    • step: number

      Amount to scroll the navigation bar, positive to scroll to the right, negative to scroll to the left.

    Returns void

select

  • select(index: number, silent?: boolean): boolean
  • Selects the given tab, if it is not selected already.

    Parameters

    • index: number

      0-based index of the tab to select.

    • Optional silent: boolean

      Controls whether events are triggered.

    Returns boolean

    Whether the given tab is now selected.

Private show

  • After a tab was loaded from the server, prepares the given tab and shows it.

    Parameters

    Returns void

Generated using TypeDoc