AbstractTabSwitcherLayout (library API)

java.lang.Object
- de.mrapp.android.tabswitcher.layout.AbstractTabSwitcherLayout

All Implemented Interfaces:

android.view.ViewTreeObserver.OnGlobalLayoutListener, PullDownGestureEventHandler.Callback, SwipeGestureEventHandler.Callback, TouchEventDispatcher.Callback, AbstractDragTabsEventHandler.Callback, TabSwitcherLayout, Model.Listener

Direct Known Subclasses:

PhoneTabSwitcherLayout, TabletTabSwitcherLayout
```
public abstract class AbstractTabSwitcherLayout
extends java.lang.Object
implements TabSwitcherLayout, android.view.ViewTreeObserver.OnGlobalLayoutListener, Model.Listener, TouchEventDispatcher.Callback, AbstractDragTabsEventHandler.Callback, SwipeGestureEventHandler.Callback, PullDownGestureEventHandler.Callback
```
An abstract base class for all layouts, which implement the functionality of a TabSwitcher.

Since:

0.1.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractTabSwitcherLayout.AnimationListenerWrapper` A animation listener, which increases the number of running animations, when the observed animation is started, and decreases the number of accordingly, when the animation is finished.
`static interface`	`AbstractTabSwitcherLayout.Callback` Defines the interface, a class, which should be notified about the events of a tab switcher layout, must implement.
`protected class`	`AbstractTabSwitcherLayout.InitialItemIterator` An iterator, which allows to iterate the items, which correspond to the child views of a `TabSwitcher`.
`protected class`	`AbstractTabSwitcherLayout.InitialItemIteratorBuilder` A builder, which allows to configure and create instances of the class `AbstractTabSwitcherLayout.InitialItemIterator`.
`static class`	`AbstractTabSwitcherLayout.LayoutListenerWrapper` A layout listener, which unregisters itself from the observed view, when invoked.

Constructor Summary

Constructors
Constructor and Description
`AbstractTabSwitcherLayout(TabSwitcher tabSwitcher, TabSwitcherModel model, Arithmetics arithmetics, TabSwitcherStyle style, TouchEventDispatcher touchEventDispatcher)` Creates a new layout, which implements the functionality of a `TabSwitcher`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected float`	`calculateAttachedPosition(int count)` Calculates and returns the position on the dragging axis, where the distance between an item and its predecessor should have reached the maximum.
`protected float`	`calculateMaxEndPosition(int index)` The method, which is invoked on implementing subclasses in order to retrieve the maximum position of a specific item, when dragging towards the end.
`protected float`	`calculateMinStartPosition(int index)` The method, which is invoked on implementing subclasses in order to retrieve the minimum position of a specific item, when dragging towards the start.
`protected abstract <any>`	`calculatePositionAndStateWhenStackedAtEnd(int index)` The method, which is invoked on implementing subclasses in order to retrieve the position and state of a specific item, when stacked at the end.
`protected <any>`	`calculatePositionAndStateWhenStackedAtStart(int count, int index, AbstractItem predecessor)` Calculates and returns the position and state of a specific item, when stacked at the start.
`protected abstract <any>`	`calculatePositionAndStateWhenStackedAtStart(int count, int index, State predecessorState)` The method, which is invoked on implementing subclasses in order to retrieve the position and state of a specific item, when stacked at the start.
`protected abstract float`	`calculatePredecessorPosition(AbstractItem item, AbstractItem successor)` Calculates the position of an item in relation to the position of its successor.
`protected abstract float`	`calculateSuccessorPosition(AbstractItem item, AbstractItem predecessor)` Calculates the position of an item in relation to the position of its predecessor.
`protected <any>`	`clipPosition(int index, float position, AbstractItem predecessor)` Clips the position of a specific item.
`protected <any>`	`clipPosition(int index, float position, State predecessorState)` Clips the position of a specific item.
`<any>`	`detachLayout(boolean tabsOnly)` Detaches the layout.
`protected Arithmetics`	`getArithmetics()` Returns the arithmetics, which are used by the layout.
`protected abstract <any>`	`getContentViewRecycler()` The method, which is invoked on implementing subclasses in order to retrieve the view recycler, which allows to recycle the views, which are associated with tabs.
`protected android.content.Context`	`getContext()` Returns the context, which is used by the layout.
`abstract AbstractDragTabsEventHandler<?>`	`getDragHandler()` The method, which is invoked on implementing subclasses in order to retrieve the drag handler, which is used by the layout.
`protected int`	`getFirstVisibleIndex()` Returns the index of the first visible tab.
`protected int`	`getItemCount()` Returns the number of child views, which are contained by the tab switcher.
`protected Logger`	`getLogger()` Returns the logger, which is used for logging.
`protected TabSwitcherModel`	`getModel()` Returns the model of the tab switcher, the layout belongs to.
`protected abstract int`	`getStackedTabCount()` The method, which is invoked on implementing subclasses in order to retrieve the number of tabs, which are contained by a stack.
`protected int`	`getStackedTabSpacing()` Returns the space between tabs, which are part of a stack.
`protected TabSwitcherStyle`	`getStyle()` Returns the style, which allows to retrieve style attributes of the tab switcher.
`protected abstract AbstractTabRecyclerAdapter`	`getTabRecyclerAdapter()` The method, which is invoked on implementing subclasses in order to retrieve the adapter of the view recycler, which allows to inflate the views, which are used to visualize the tabs.
`protected TabSwitcher`	`getTabSwitcher()` Returns the tab switcher, the layout belongs to.
`protected abstract <any>`	`getTabViewRecycler()` The method, which is invoked on implementing subclasses in order to retrieve the view recycler, which allows to inflate the views, which are used to visualize the tabs.
`android.view.Menu`	`getToolbarMenu()` Returns the menu of the toolbar, which is shown, when the tab switcher is shown.
`protected abstract void`	`inflateAndUpdateView(AbstractItem item, boolean dragging, android.view.ViewTreeObserver.OnGlobalLayoutListener listener)` The method, which is invoked on implementing subclasses in order to inflate and update the view, which is used to visualize a specific item.
`void`	`inflateLayout(boolean tabsOnly)` Inflates the layout.
`protected void`	`inflateOrRemoveView(AbstractItem item, boolean dragging)` Inflates or removes the view, which is used to visualize a specific item, depending on the item's current state.
`protected void`	`inflateView(AbstractItem item, android.view.ViewTreeObserver.OnGlobalLayoutListener listener, java.lang.Integer... params)` Inflates the view, which is used to visualize a specific item.
`boolean`	`isAnimationRunning()` Returns, whether an animation is currently running, or not.
`protected boolean`	`isOvershootingAtEnd(AbstractDragTabsEventHandler.DragState dragState, AbstractItemIterator iterator)` The method, which is invoked on implementing subclasses in order to retrieve, whether the items are overshooting at the end.
`protected boolean`	`isOvershootingAtStart()` The method, which is invoked on implementing subclasses in order to retrieve, whether the items are overshooting at the start.
`protected boolean`	`isStackedAtStart(int index)` Returns, whether a hidden tab at a specific index, is part of the stack, which is located at the start, or not.
`void`	`onAddedEventHandler(TouchEventDispatcher dispatcher, AbstractTouchEventHandler eventHandler)` The method, which is invoked, when an event handler has been added.
`void`	`onAddTabButtonColorChanged(android.content.res.ColorStateList colorStateList)` The method, which is invoked, when the color of the button, which allows to add a new tab, has been changed.
`void`	`onAddTabButtonVisibilityChanged(boolean visible)` The method, which is invoked, when it has been changed, whether the button, which allows to add a new tab, should be shown, or not.
`void`	`onCancelFling()` The method, which is invoked, when a fling has been cancelled.
`void`	`onClick(AbstractItem item)` The method, which is invoked, when a view has been clicked.
`protected <any>`	`onCreateContentRecyclerAdapter()` The method, which is invoked on implementing subclasses in order to create the view recycler adapter, which allows to inflate the views, which are associated with tabs.
`void`	`onDecoratorChanged(TabSwitcherDecorator decorator)` The method, which is invoked, when the decorator has been changed.
`protected abstract <any>`	`onDetachLayout(boolean tabsOnly)` The method, which is invoked on implementing subclasses in order to detach the layout.
`AbstractDragTabsEventHandler.DragState`	`onDrag(AbstractDragTabsEventHandler.DragState dragState, float dragDistance)` The method, which is invoked in order to calculate the positions of all tabs, depending on the current drag distance.
`void`	`onFling(float distance, long duration)` The method, which is invoked, when a fling has been triggered.
`protected abstract void`	`onInflateLayout(android.view.LayoutInflater inflater, boolean tabsOnly)` The method, which is invoked on implementing subclasses in order to inflate the layout.
`void`	`onLogLevelChanged(LogLevel logLevel)` The method, which is invoked, when the log level has been changed.
`void`	`onPressEnded(AbstractItem item)` The method, which is invoked, when pressing a view has been ended.
`void`	`onPressStarted(AbstractItem item)` The method, which is invoked, when pressing a view has been started.
`void`	`onPulledDown()` The method, which is notified, when the currently selected tab has been pulled down.
`void`	`onRemovedEventHandler(TouchEventDispatcher dispatcher, AbstractTouchEventHandler eventHandler)` The method, which is invoked, when an event handler has been removed.
`void`	`onRevertEndOvershoot()` The method, which is invoked, when an overshoot at the end should be reverted.
`void`	`onRevertStartOvershoot()` The method, which is invoked, when an overshoot at the start should be reverted.
`void`	`onSwipe(TabItem tabItem, float distance)` The method, which is invoked, when a tab is swiped.
`void`	`onSwipeEnded(TabItem tabItem, boolean remove, float velocity)` The method, which is invoked, when swiping a tab ended.
`void`	`onSwitcherHidden()` The method, which is invoked, when the tab switcher has been hidden.
`void`	`onSwitcherShown()` The method, which is invoked, when the tab switcher has been shown.
`void`	`onTabBackgroundColorChanged(android.content.res.ColorStateList colorStateList)` The method, which is invoked, when the background color of a tab has been changed.
`void`	`onTabCloseButtonIconChanged(android.graphics.drawable.Drawable icon)` The method, which is invoked, when the icon of a tab's close button has been changed.
`void`	`onTabContentBackgroundColorChanged(int color)` The method, which is invoked, when the background color of a tab's content has been changed.
`void`	`onTabIconChanged(android.graphics.drawable.Drawable icon)` The method, which is invoked, when the default icon of a tab has been changed.
`void`	`onTabProgressBarColorChanged(int color)` The method, which is invoked, when the color of a tab's progress bar has been changed.
`void`	`onTabTitleColorChanged(android.content.res.ColorStateList colorStateList)` The method, which is invoked, when the text color of a tab's title has been changed.
`void`	`onToolbarMenuInflated(int resourceId, OnMenuItemClickListener listener)` The method, which is invoked, when the menu of the toolbar, which is shown, when the tab switcher is shown, has been inflated.
`void`	`onToolbarNavigationIconChanged(android.graphics.drawable.Drawable icon, android.view.View.OnClickListener listener)` The method, which is invoked, when the navigation icon of the toolbar, which is shown, when the tab switcher is shown, has been changed.
`void`	`onToolbarTitleChanged(java.lang.CharSequence title)` The method, which is invoked, when the title of the toolbar, which is shown, when the tab switcher is shown, has been changed.
`void`	`onToolbarVisibilityChanged(boolean visible)` The method, which is invoked, when it has been changed, whether the toolbars should be shown, when the tab switcher is shown, or not.
`protected void`	`secondLayoutPass(AbstractItemIterator.AbstractBuilder builder)` The method, which is called when dragging after the positions and states of all tabs have been calculated.
`void`	`setCallback(AbstractTabSwitcherLayout.Callback callback)` Sets the callback, which should be notified about the layout's events.
`protected void`	`setFirstVisibleIndex(int firstVisibleIndex)` Sets the index of the first visible tab.
`protected void`	`updateView(AbstractItem item, boolean dragging)` Updates the view, which is used to visualize a specific item.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.mrapp.android.tabswitcher.layout.TabSwitcherLayout
getTabContainer, getToolbars

Methods inherited from interface android.view.ViewTreeObserver.OnGlobalLayoutListener
onGlobalLayout

Methods inherited from interface de.mrapp.android.tabswitcher.model.Model.Listener
onAllTabsAdded, onAllTabsRemoved, onEmptyViewChanged, onPaddingChanged, onSelectionChanged, onTabAdded, onTabRemoved

Methods inherited from interface de.mrapp.android.tabswitcher.gesture.SwipeGestureEventHandler.Callback
onSwitchingBetweenTabs, onSwitchingBetweenTabsEnded

- Constructor Detail
  - AbstractTabSwitcherLayout
```
public AbstractTabSwitcherLayout(TabSwitcher tabSwitcher,
                                 TabSwitcherModel model,
                                 Arithmetics arithmetics,
                                 TabSwitcherStyle style,
                                 TouchEventDispatcher touchEventDispatcher)
```
    Creates a new layout, which implements the functionality of a TabSwitcher.
    
    Parameters:
    
    tabSwitcher - The tab switcher, the layout belongs to, as an instance of the class TabSwitcher. The tab switcher may not be null
    
    model - The model of the tab switcher, the layout belongs to, as an instance of the class TabSwitcherModel. The model may not be null
    
    arithmetics - The arithmetics, which should be used by the layout, as an instance of the type Arithmetics. The arithmetics may not be null
    
    style - The style, which allows to retrieve style attributes of the tab switcher, as an instance of the class TabSwitcherStyle. The style may not be null
    
    touchEventDispatcher - The dispatcher, which is used to dispatch touch events to event handlers, as an instance of the class TouchEventDispatcher. The dispatcher may not be null
- Method Detail
  - getTabSwitcher
```
protected final TabSwitcher getTabSwitcher()
```
    Returns the tab switcher, the layout belongs to.
    
    Returns:
    
    The tab switcher, the layout belongs to, as an instance of the class TabSwitcher. The tab switcher may not be null
  - getModel
```
protected final TabSwitcherModel getModel()
```
    Returns the model of the tab switcher, the layout belongs to.
    
    Returns:
    
    The model of the tab switcher, the layout belongs to, as an instance of the class TabSwitcherModel. The model may not be null
  - getArithmetics
```
protected final Arithmetics getArithmetics()
```
    Returns the arithmetics, which are used by the layout.
    
    Returns:
    
    The arithmetics, which are used by the layout, as an instance of the type Arithmetics. The arithmetics may not be null
  - getStyle
```
protected final TabSwitcherStyle getStyle()
```
    Returns the style, which allows to retrieve style attributes of the tab switcher.
    
    Returns:
    
    The style, which allows to retrieve style attributes of the tab switcher, as an instance of the class TabSwitcherStyle. The style may not be null
  - getStackedTabSpacing
```
protected final int getStackedTabSpacing()
```
    Returns the space between tabs, which are part of a stack.
    
    Returns:
    
    The space between tabs, which are part of a stack, in pixels as an Integer value
  - getLogger
```
protected final Logger getLogger()
```
    Returns the logger, which is used for logging.
    
    Returns:
    
    The logger, which is used for logging, as an instance of the class Logger. The logger may not be null
  - getContext
```
protected final android.content.Context getContext()
```
    Returns the context, which is used by the layout.
    
    Returns:
    
    The context, which is used by the layout, as an instance of the class Context. The context may not be null
  - getFirstVisibleIndex
```
protected final int getFirstVisibleIndex()
```
    Returns the index of the first visible tab.
    
    Returns:
    
    The index of the first visible tab as an Integer value or -1, if no tabs is visible
  - setFirstVisibleIndex
```
protected final void setFirstVisibleIndex(int firstVisibleIndex)
```
    Sets the index of the first visible tab.
    
    Parameters:
    
    firstVisibleIndex - The index, which should be set, as an Integer value or -1, if no tab is visible
  - getItemCount
```
protected final int getItemCount()
```
    Returns the number of child views, which are contained by the tab switcher.
    
    Returns:
    
    The number of child views, which are contained by the tab switcher, as an Integer value
  - isStackedAtStart
```
protected final boolean isStackedAtStart(int index)
```
    Returns, whether a hidden tab at a specific index, is part of the stack, which is located at the start, or not.
    
    Parameters:
    
    index - The index of the hidden tab, as an Integer value
    
    Returns:
    
    True, if the hidden tab is part of the stack, which is located at the start, false otherwise
  - clipPosition
```
protected final <any> clipPosition(int index,
                                   float position,
                                   AbstractItem predecessor)
```
    Clips the position of a specific item.
    
    Parameters:
    
    index - The index of the item, whose position should be clipped, as an Integer value
    
    position - The position, which should be clipped, in pixels as a Float value
    
    predecessor - The predecessor of the given item as an instance of the class AbstractItem or null, if the item does not have a predecessor
    
    Returns:
    
    A pair, which contains the position and state of the item, as an instance of the class Pair. The pair may not be null
  - clipPosition
```
protected final <any> clipPosition(int index,
                                   float position,
                                   State predecessorState)
```
    Clips the position of a specific item.
    
    Parameters:
    
    index - The index of the item, whose position should be clipped, as an Integer value
    
    position - The position, which should be clipped, in pixels as a Float value
    
    predecessorState - The state of the predecessor of the given item as a value of the enum State or null, if the item does not have a predecessor
    
    Returns:
    
    A pair, which contains the position and state of the item, as an instance of the class Pair. The pair may not be null
  - calculatePositionAndStateWhenStackedAtStart
```
protected final <any> calculatePositionAndStateWhenStackedAtStart(int count,
                                                                  int index,
                                                                  AbstractItem predecessor)
```
    Calculates and returns the position and state of a specific item, when stacked at the start.
    
    Parameters:
    
    count - The total number of items, which are currently contained by the tab switcher, as an Integer value
    
    index - The index of the item, whose position and state should be returned, as an Integer value
    
    predecessor - The predecessor of the given item as an instance of the class AbstractItem or null, if the item does not have a predecessor
    
    Returns:
    
    A pair, which contains the position and state of the given item, when stacked at the start, as an instance of the class Pair. The pair may not be null
  - inflateOrRemoveView
```
protected final void inflateOrRemoveView(AbstractItem item,
                                         boolean dragging)
```
    Inflates or removes the view, which is used to visualize a specific item, depending on the item's current state.
    
    Parameters:
    
    item - The item, whose view should be inflated or removed, as an instance of the class AbstractItem. The item may not be null
    
    dragging - True, if the item is currently being dragged, false otherwise
  - inflateView
```
protected final void inflateView(AbstractItem item,
                                 android.view.ViewTreeObserver.OnGlobalLayoutListener listener,
                                 java.lang.Integer... params)
```
    Inflates the view, which is used to visualize a specific item.
    
    Parameters:
    
    item - The item, whose view should be inflated, as an instance of the class AbstractItem. The item may not be null
    
    listener - The layout listener, which should be notified, when the view has been inflated, as an instance of the type ViewTreeObserver.OnGlobalLayoutListener or null, if no listener should be notified
    
    params - An array, which contains optional parameters, which should be passed to the view recycler, which is used to inflate the view, as an Integer array or null, if no optional parameters should be used
  - updateView
```
protected void updateView(AbstractItem item,
                          boolean dragging)
```
    Updates the view, which is used to visualize a specific item.
    
    Parameters:
    
    item - The item, whose view should be updated, as an instance of the class AbstractItem. The item may not be null
    
    dragging - True, if the item is currently being dragged, false otherwise
  - calculateAttachedPosition
```
protected float calculateAttachedPosition(int count)
```
    Calculates and returns the position on the dragging axis, where the distance between an item and its predecessor should have reached the maximum.
    
    Parameters:
    
    count - The total number of items, which are contained by the tab switcher, as an Integer value
    
    Returns:
    
    The position, which has been calculated, in pixels as an Float value or -1, if no attached position is used
  - getDragHandler
```
public abstract AbstractDragTabsEventHandler<?> getDragHandler()
```
    The method, which is invoked on implementing subclasses in order to retrieve the drag handler, which is used by the layout.
    
    Returns:
    
    The drag handler, which is used by the layout, as an instance of the class AbstractDragTabsEventHandler or null, if the drag handler has not been initialized yet
  - onInflateLayout
```
protected abstract void onInflateLayout(android.view.LayoutInflater inflater,
                                        boolean tabsOnly)
```
    The method, which is invoked on implementing subclasses in order to inflate the layout.
    
    Parameters:
    
    inflater - The layout inflater, which should be used, as an instance of the class LayoutInflater. The layout inflater may not be null
    
    tabsOnly - True, if only the tabs should be inflated, false otherwise
  - onDetachLayout
```
protected abstract <any> onDetachLayout(boolean tabsOnly)
```
    The method, which is invoked on implementing subclasses in order to detach the layout.
    
    Parameters:
    
    tabsOnly - True, if only the tabs should be detached, false otherwise
    
    Returns:
    
    A pair, which contains the index of the tab, which should be used as a reference, when restoring the positions of tabs, as well as its current position in relation to the available space, as an instance of the class Pair or null, if the positions of tabs should not be restored
  - getContentViewRecycler
```
protected abstract <any> getContentViewRecycler()
```
    The method, which is invoked on implementing subclasses in order to retrieve the view recycler, which allows to recycle the views, which are associated with tabs.
    
    Returns:
    
    The view recycler, which allows to recycle the views, which are associated with tabs, as an instance of the class ViewRecycler or null, if the view recycler has not been initialized yet
  - getTabViewRecycler
```
protected abstract <any> getTabViewRecycler()
```
    The method, which is invoked on implementing subclasses in order to retrieve the view recycler, which allows to inflate the views, which are used to visualize the tabs.
    
    Returns:
    
    The view recycler, which allows to inflate the views, which are used to visualize the tabs, as an instance of the class AttachedViewRecycler or null, if the view recycler has not been initialized yet
  - getTabRecyclerAdapter
```
protected abstract AbstractTabRecyclerAdapter getTabRecyclerAdapter()
```
    The method, which is invoked on implementing subclasses in order to retrieve the adapter of the view recycler, which allows to inflate the views, which are used to visualize the tabs.
    
    Returns:
    
    The adapter of the view recycler, which allows to inflated the views, which are used to visualize the tabs, as an instance of the class AbstractTabRecyclerAdapter or null, if the view recycler has not been initialized yet
  - inflateAndUpdateView
```
protected abstract void inflateAndUpdateView(AbstractItem item,
                                             boolean dragging,
                                             android.view.ViewTreeObserver.OnGlobalLayoutListener listener)
```
    The method, which is invoked on implementing subclasses in order to inflate and update the view, which is used to visualize a specific item.
    
    Parameters:
    
    item - The item, whose view should be inflated, as an instance of the class AbstractItem. The item may not be null
    
    dragging - True, if the view is currently being dragged, false otherwise
    
    listener - The layout listener, which should be notified, when the view has been inflated, as an instance of the type ViewTreeObserver.OnGlobalLayoutListener or null, if no listener should be notified
  - getStackedTabCount
```
protected abstract int getStackedTabCount()
```
    The method, which is invoked on implementing subclasses in order to retrieve the number of tabs, which are contained by a stack.
    
    Returns:
    
    The number of tabs, which are contained by a stack, as an Integer value
  - calculatePositionAndStateWhenStackedAtStart
```
protected abstract <any> calculatePositionAndStateWhenStackedAtStart(int count,
                                                                     int index,
                                                                     State predecessorState)
```
    The method, which is invoked on implementing subclasses in order to retrieve the position and state of a specific item, when stacked at the start.
    
    Parameters:
    
    count - The total number of items, which are currently contained by the tab switcher, as an Integer value
    
    index - The index of the item, whose position and state should be returned, as an Integer value
    
    predecessorState - The state of the predecessor of the given item as a value of the enum State or null, if the item does not have a predecessor
    
    Returns:
    
    A pair, which contains the position and state of the given item, when stacked at the start, as an instance of the class Pair. The pair may not be null
  - calculatePositionAndStateWhenStackedAtEnd
```
protected abstract <any> calculatePositionAndStateWhenStackedAtEnd(int index)
```
    The method, which is invoked on implementing subclasses in order to retrieve the position and state of a specific item, when stacked at the end.
    
    Parameters:
    
    index - The index of the item, whose position and state should be returned, as an Integer value
    
    Returns:
    
    A pair, which contains the position and state of the given item, when stacked at the end, as an instance of the class Pair. The pair may not be null
  - calculateSuccessorPosition
```
protected abstract float calculateSuccessorPosition(AbstractItem item,
                                                    AbstractItem predecessor)
```
    Calculates the position of an item in relation to the position of its predecessor.
    
    Parameters:
    
    item - The item, whose position should be calculated, as an instance of the class AbstractItem. The item may not be null
    
    predecessor - The predecessor as an instance of the class AbstractItem. The predecessor may not be null
    
    Returns:
    
    The position, which has been calculated, as a Float value
  - calculatePredecessorPosition
```
protected abstract float calculatePredecessorPosition(AbstractItem item,
                                                      AbstractItem successor)
```
    Calculates the position of an item in relation to the position of its successor.
    
    Parameters:
    
    item - The item, whose position should be calculated, as an instance of the class AbstractItem. The item may not be null
    
    successor - The successor as an instance of the class AbstractItem. The successor may not be null
    
    Returns:
    
    The position, which has been calculated, as a Float value
  - calculateMinStartPosition
```
protected float calculateMinStartPosition(int index)
```
    The method, which is invoked on implementing subclasses in order to retrieve the minimum position of a specific item, when dragging towards the start.
    
    Parameters:
    
    index - The index of the item, whose position should be calculated, as an Integer value
    
    Returns:
    
    The position, which has been calculated, as a Float value or -1, if no minimum position is available
  - calculateMaxEndPosition
```
protected float calculateMaxEndPosition(int index)
```
    The method, which is invoked on implementing subclasses in order to retrieve the maximum position of a specific item, when dragging towards the end.
    
    Parameters:
    
    index - The index of the item, whose position should be calculated, as an Integer value
    
    Returns:
    
    The position, which has been calculated, as a Float value or -1, if no maximum position is available
  - isOvershootingAtStart
```
protected boolean isOvershootingAtStart()
```
    The method, which is invoked on implementing subclasses in order to retrieve, whether the items are overshooting at the start.
    
    Returns:
    
    True, if the items are overshooting at the start, false otherwise
  - isOvershootingAtEnd
```
protected boolean isOvershootingAtEnd(AbstractDragTabsEventHandler.DragState dragState,
                                      AbstractItemIterator iterator)
```
    The method, which is invoked on implementing subclasses in order to retrieve, whether the items are overshooting at the end.
    
    Parameters:
    
    dragState - The current drag state as an instance of the enum AbstractDragTabsEventHandler.DragState. The drag state may not be null
    
    iterator - An iterator, which allows to iterate the items, which are contained by the tab switcher, as an instance of the class AbstractItemIterator. The iterator may not be null
    
    Returns:
    
    True, if the items are overshooting at the end, false otherwise
  - secondLayoutPass
```
protected void secondLayoutPass(AbstractItemIterator.AbstractBuilder builder)
```
    The method, which is called when dragging after the positions and states of all tabs have been calculated. It may be overridden by subclasses in order to implement a second layout pass, which requires the information, which has been calculated in the first pass, and allows to perform additional modifications of the tabs based on that information.
    
    Parameters:
    
    builder - The builder, which allows to create the iterator, which should be used to iterate the tabs, as an instance of the class AbstractItemIterator.AbstractBuilder. The builder may not be null
  - onCreateContentRecyclerAdapter
```
protected <any> onCreateContentRecyclerAdapter()
```
    The method, which is invoked on implementing subclasses in order to create the view recycler adapter, which allows to inflate the views, which are associated with tabs.
    
    Returns:
    
    The view recycler adapter, which has been created, as an instance of the class AttachedViewRecycler.Adapter. The recycler adapter may not be null }
  - inflateLayout
```
public final void inflateLayout(boolean tabsOnly)
```
    Inflates the layout.
    
    Parameters:
    
    tabsOnly - True, if only the tabs should be inflated, false otherwise
  - detachLayout
```
public final <any> detachLayout(boolean tabsOnly)
```
    Detaches the layout.
    
    Parameters:
    
    tabsOnly - True, if only the tabs should be detached, false otherwise
    
    Returns:
    
    A pair, which contains the index of the first visible tab, as well as its current position in relation to the available space, as an instance of the class Pair or null, if the tab switcher is not shown
  - setCallback
```
public final void setCallback(AbstractTabSwitcherLayout.Callback callback)
```
    Sets the callback, which should be notified about the layout's events.
    
    Parameters:
    
    callback - The callback, which should be set, as an instance of the type AbstractTabSwitcherLayout.Callback or null, if no callback should be notified
  - isAnimationRunning
```
public final boolean isAnimationRunning()
```
    Description copied from interface: TabSwitcherLayout
    
    Returns, whether an animation is currently running, or not.
    
    Specified by:
    
    isAnimationRunning in interface TabSwitcherLayout
    
    Returns:
    
    True, if an animation is currently running, false otherwise
  - getToolbarMenu
```
public final android.view.Menu getToolbarMenu()
```
    Description copied from interface: TabSwitcherLayout
    
    Returns the menu of the toolbar, which is shown, when the tab switcher is shown. When using the tablet layout, the menu corresponds to the secondary toolbar.
    
    Specified by:
    
    getToolbarMenu in interface TabSwitcherLayout
    
    Returns:
    
    The menu of the toolbar as an instance of the type Menu or null, if the view has not been laid out yet
  - onLogLevelChanged
```
public final void onLogLevelChanged(LogLevel logLevel)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the log level has been changed.
    
    Specified by:
    
    onLogLevelChanged in interface Model.Listener
    
    Parameters:
    
    logLevel - The log level, which has been set, as a value of the enum LogLevel. The log level may not be null
  - onDecoratorChanged
```
public void onDecoratorChanged(TabSwitcherDecorator decorator)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the decorator has been changed.
    
    Specified by:
    
    onDecoratorChanged in interface Model.Listener
    
    Parameters:
    
    decorator - The decorator, which has been set, as an instance of the class TabSwitcherDecorator. The decorator may not be null
  - onAddTabButtonVisibilityChanged
```
public void onAddTabButtonVisibilityChanged(boolean visible)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when it has been changed, whether the button, which allows to add a new tab, should be shown, or not.
    
    Specified by:
    
    onAddTabButtonVisibilityChanged in interface Model.Listener
    
    Parameters:
    
    visible - True, if the button, which allows to add a new tab, should be shown, false otherwise
  - onAddTabButtonColorChanged
```
public final void onAddTabButtonColorChanged(android.content.res.ColorStateList colorStateList)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the color of the button, which allows to add a new tab, has been changed.
    
    Specified by:
    
    onAddTabButtonColorChanged in interface Model.Listener
    
    Parameters:
    
    colorStateList - The color, which has been set, as an instance of the class ColorStateList or null, if the default color should be used
  - onToolbarVisibilityChanged
```
public final void onToolbarVisibilityChanged(boolean visible)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when it has been changed, whether the toolbars should be shown, when the tab switcher is shown, or not.
    
    Specified by:
    
    onToolbarVisibilityChanged in interface Model.Listener
    
    Parameters:
    
    visible - True, if the toolbars should be shown, when the tab switcher is shown, false otherwise
  - onToolbarTitleChanged
```
public final void onToolbarTitleChanged(java.lang.CharSequence title)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the title of the toolbar, which is shown, when the tab switcher is shown, has been changed.
    
    Specified by:
    
    onToolbarTitleChanged in interface Model.Listener
    
    Parameters:
    
    title - The title, which has been set, as an instance of the type CharSequence or null, if no title is set
  - onToolbarNavigationIconChanged
```
public final void onToolbarNavigationIconChanged(android.graphics.drawable.Drawable icon,
                                                 android.view.View.OnClickListener listener)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the navigation icon of the toolbar, which is shown, when the tab switcher is shown, has been changed.
    
    Specified by:
    
    onToolbarNavigationIconChanged in interface Model.Listener
    
    Parameters:
    
    icon - The navigation icon, which has been set, as an instance of the class Drawable or null, if no navigation icon is set
    
    listener - The listener, which should be notified, when the navigation item has been clicked, as an instance of the type View.OnClickListener or null, if no listener should be notified
  - onToolbarMenuInflated
```
public final void onToolbarMenuInflated(int resourceId,
                                        OnMenuItemClickListener listener)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the menu of the toolbar, which is shown, when the tab switcher is shown, has been inflated.
    
    Specified by:
    
    onToolbarMenuInflated in interface Model.Listener
    
    Parameters:
    
    resourceId - The resource id of the menu, which has been inflated, as an Integer value. The resource id must correspond to a valid menu resource
    
    listener - The listener, which has been registered to be notified, when an item of the menu has been clicked, as an instance of the type OnMenuItemClickListener or null, if no listener should be notified
  - onTabIconChanged
```
public final void onTabIconChanged(android.graphics.drawable.Drawable icon)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the default icon of a tab has been changed.
    
    Specified by:
    
    onTabIconChanged in interface Model.Listener
    
    Parameters:
    
    icon - The icon, which has been set, as an instance of the class Drawable or null, if no icon is set
  - onTabBackgroundColorChanged
```
public void onTabBackgroundColorChanged(android.content.res.ColorStateList colorStateList)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the background color of a tab has been changed.
    
    Specified by:
    
    onTabBackgroundColorChanged in interface Model.Listener
    
    Parameters:
    
    colorStateList - The color state list, which has been set, as an instance of the class ColorStateList or null, if the default color should be used
  - onTabContentBackgroundColorChanged
```
public void onTabContentBackgroundColorChanged(int color)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the background color of a tab's content has been changed.
    
    Specified by:
    
    onTabContentBackgroundColorChanged in interface Model.Listener
    
    Parameters:
    
    color - The color, which has been set, as an Integer value or -1, if the default color should be used
  - onTabTitleColorChanged
```
public final void onTabTitleColorChanged(android.content.res.ColorStateList colorStateList)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the text color of a tab's title has been changed.
    
    Specified by:
    
    onTabTitleColorChanged in interface Model.Listener
    
    Parameters:
    
    colorStateList - The color state list, which has been set, as an instance of the class ColorStateList or null, if the default color should be used
  - onTabCloseButtonIconChanged
```
public final void onTabCloseButtonIconChanged(android.graphics.drawable.Drawable icon)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the icon of a tab's close button has been changed.
    
    Specified by:
    
    onTabCloseButtonIconChanged in interface Model.Listener
    
    Parameters:
    
    icon - The icon, which has been set, as an instance of the class Drawable or null, if the default icon should be used
  - onTabProgressBarColorChanged
```
public final void onTabProgressBarColorChanged(int color)
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the color of a tab's progress bar has been changed.
    
    Specified by:
    
    onTabProgressBarColorChanged in interface Model.Listener
    
    Parameters:
    
    color - The color, which has been set, as an Integer value or -1, if the default color should be used
  - onSwitcherShown
```
public void onSwitcherShown()
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the tab switcher has been shown.
    
    Specified by:
    
    onSwitcherShown in interface Model.Listener
  - onSwitcherHidden
```
public void onSwitcherHidden()
```
    Description copied from interface: Model.Listener
    
    The method, which is invoked, when the tab switcher has been hidden.
    
    Specified by:
    
    onSwitcherHidden in interface Model.Listener
  - onAddedEventHandler
```
public final void onAddedEventHandler(TouchEventDispatcher dispatcher,
                                      AbstractTouchEventHandler eventHandler)
```
    Description copied from interface: TouchEventDispatcher.Callback
    
    The method, which is invoked, when an event handler has been added.
    
    Specified by:
    
    onAddedEventHandler in interface TouchEventDispatcher.Callback
    
    Parameters:
    
    dispatcher - The dispatcher, the event handler has been added to, as an instance of the class TouchEventDispatcher. The dispatcher may not be null
    
    eventHandler - The event handler, which has been added, as an instance of the class AbstractTouchEventHandler. The event handler may not be null
  - onRemovedEventHandler
```
public final void onRemovedEventHandler(TouchEventDispatcher dispatcher,
                                        AbstractTouchEventHandler eventHandler)
```
    Description copied from interface: TouchEventDispatcher.Callback
    
    The method, which is invoked, when an event handler has been removed.
    
    Specified by:
    
    onRemovedEventHandler in interface TouchEventDispatcher.Callback
    
    Parameters:
    
    dispatcher - The dispatcher, the event handler has been removed from, as an instance of the class TouchEventDispatcher. The dispatcher may not be null
    
    eventHandler - The event handler, which has been removed, as an instance of the class AbstractTouchEventHandler. The event handler may not be null
  - onDrag
```
public final AbstractDragTabsEventHandler.DragState onDrag(AbstractDragTabsEventHandler.DragState dragState,
                                                           float dragDistance)
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked in order to calculate the positions of all tabs, depending on the current drag distance.
    
    Specified by:
    
    onDrag in interface AbstractDragTabsEventHandler.Callback
    
    Parameters:
    
    dragState - The current drag state as a value of the enum AbstractDragTabsEventHandler.DragState. The drag state must either be AbstractDragTabsEventHandler.DragState.DRAG_TO_END or AbstractDragTabsEventHandler.DragState.DRAG_TO_START
    
    dragDistance - The current drag distance in pixels as a Float value
    
    Returns:
    
    A drag state, which specifies whether the tabs are overshooting, or not. If the tabs are overshooting, the drag state must be AbstractDragTabsEventHandler.DragState.OVERSHOOT_START or AbstractDragTabsEventHandler.DragState.OVERSHOOT_END, null otherwise
  - onPressStarted
```
public final void onPressStarted(AbstractItem item)
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when pressing a view has been started.
    
    Specified by:
    
    onPressStarted in interface AbstractDragTabsEventHandler.Callback
    
    Parameters:
    
    item - The item, which corresponds to the view, which has been pressed, as an instance of the class AbstractItem. The item may not be null
  - onPressEnded
```
public final void onPressEnded(AbstractItem item)
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when pressing a view has been ended.
    
    Specified by:
    
    onPressEnded in interface AbstractDragTabsEventHandler.Callback
    
    Parameters:
    
    item - Tge item, which corresponds to the view, which was previously pressed, as an instance of the class AbstractItem. The item may not be null
  - onClick
```
public final void onClick(AbstractItem item)
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when a view has been clicked.
    
    Specified by:
    
    onClick in interface AbstractDragTabsEventHandler.Callback
    
    Parameters:
    
    item - The item, which corresponds to the view, which has been clicked, as an instance of the class AbstractItem. The item may not be null
  - onFling
```
public final void onFling(float distance,
                          long duration)
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when a fling has been triggered.
    
    Specified by:
    
    onFling in interface AbstractDragTabsEventHandler.Callback
    
    Parameters:
    
    distance - The distance of the fling in pixels as a Float value
    
    duration - The duration of the fling in milliseconds as a Long value
  - onCancelFling
```
public final void onCancelFling()
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when a fling has been cancelled.
    
    Specified by:
    
    onCancelFling in interface AbstractDragTabsEventHandler.Callback
  - onRevertStartOvershoot
```
public void onRevertStartOvershoot()
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when an overshoot at the start should be reverted.
    
    Specified by:
    
    onRevertStartOvershoot in interface AbstractDragTabsEventHandler.Callback
  - onRevertEndOvershoot
```
public void onRevertEndOvershoot()
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when an overshoot at the end should be reverted.
    
    Specified by:
    
    onRevertEndOvershoot in interface AbstractDragTabsEventHandler.Callback
  - onSwipe
```
public void onSwipe(TabItem tabItem,
                    float distance)
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when a tab is swiped.
    
    Specified by:
    
    onSwipe in interface AbstractDragTabsEventHandler.Callback
    
    Parameters:
    
    tabItem - The tab item, which corresponds to the swiped tab, as an instance of the class TabItem. The tab item may not be null
    
    distance - The distance, the tab is swiped by, in pixels as a Float value
  - onSwipeEnded
```
public void onSwipeEnded(TabItem tabItem,
                         boolean remove,
                         float velocity)
```
    Description copied from interface: AbstractDragTabsEventHandler.Callback
    
    The method, which is invoked, when swiping a tab ended.
    
    Specified by:
    
    onSwipeEnded in interface AbstractDragTabsEventHandler.Callback
    
    Parameters:
    
    tabItem - The tab item, which corresponds to the swiped tab, as an instance of the class TabItem. The tab item may not be null
    
    remove - True, if the tab should be removed, false otherwise
    
    velocity - The velocity of the swipe gesture in pixels per second as a Float value
  - onPulledDown
```
public void onPulledDown()
```
    Description copied from interface: PullDownGestureEventHandler.Callback
    
    The method, which is notified, when the currently selected tab has been pulled down.
    
    Specified by:
    
    onPulledDown in interface PullDownGestureEventHandler.Callback

Class AbstractTabSwitcherLayout

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.mrapp.android.tabswitcher.layout.TabSwitcherLayout

Methods inherited from interface android.view.ViewTreeObserver.OnGlobalLayoutListener

Methods inherited from interface de.mrapp.android.tabswitcher.model.Model.Listener

Methods inherited from interface de.mrapp.android.tabswitcher.gesture.SwipeGestureEventHandler.Callback

Constructor Detail

AbstractTabSwitcherLayout

Method Detail

getTabSwitcher

getModel

getArithmetics

getStyle

getStackedTabSpacing

getLogger

getContext

getFirstVisibleIndex

setFirstVisibleIndex

getItemCount

isStackedAtStart

clipPosition

clipPosition

calculatePositionAndStateWhenStackedAtStart

inflateOrRemoveView

inflateView

updateView

calculateAttachedPosition

getDragHandler

onInflateLayout

onDetachLayout

getContentViewRecycler

getTabViewRecycler

getTabRecyclerAdapter

inflateAndUpdateView

getStackedTabCount

calculatePositionAndStateWhenStackedAtStart

calculatePositionAndStateWhenStackedAtEnd

calculateSuccessorPosition

calculatePredecessorPosition

calculateMinStartPosition

calculateMaxEndPosition

isOvershootingAtStart

isOvershootingAtEnd

secondLayoutPass

onCreateContentRecyclerAdapter

inflateLayout

detachLayout

setCallback

isAnimationRunning

getToolbarMenu

onLogLevelChanged

onDecoratorChanged

onAddTabButtonVisibilityChanged

onAddTabButtonColorChanged

onToolbarVisibilityChanged

onToolbarTitleChanged

onToolbarNavigationIconChanged

onToolbarMenuInflated

onTabIconChanged

onTabBackgroundColorChanged

onTabContentBackgroundColorChanged

onTabTitleColorChanged

onTabCloseButtonIconChanged

onTabProgressBarColorChanged

onSwitcherShown

onSwitcherHidden

onAddedEventHandler

onRemovedEventHandler

onDrag

onPressStarted

onPressEnded

onClick

onFling

onCancelFling

onRevertStartOvershoot

onRevertEndOvershoot

onSwipe