Package snap.view

Class TabBar

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.TabBar

All Implemented Interfaces:

PropChange.DoChange, Selectable<Tab>, XMLArchiver.Archivable

public class TabBar
extends ParentView
implements Selectable<Tab>

This class manages and displays a list of tabs.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AllowEmptySelection_Prop
static final Insets	DEFAULT_PADDING
static final double	DEFAULT_SPACING
static final String	Tabs_Prop

Fields inherited from class snap.view.ParentView

_children, Child_Prop, NeedsLayout_Prop

Fields inherited from class snap.view.View

_align, _borderRadius, _effect, _font, _margin, _padding, _repaintRect, _showing, _spacing, _vertical, Action, Align_Prop, Border_Prop, BorderRadius_Prop, Clip_Prop, Cursor_Prop, DEFAULT_ALIGN, DEFAULT_MARGIN, Disabled_Prop, DragEvents, Effect_Prop, Fill_Prop, Focusable_Prop, Focused_Prop, FocusWhenPressed_Prop, Font_Prop, GrowHeight_Prop, GrowWidth_Prop, Height_Prop, KeyEvents, KeyPress, KeyRelease, KeyType, LeanX_Prop, LeanY_Prop, Managed_Prop, Margin_Prop, MaxHeight_Prop, MaxWidth_Prop, MinHeight_Prop, MinWidth_Prop, MouseDrag, MouseEnter, MouseEvents, MouseExit, MouseMove, MousePress, MouseRelease, Name_Prop, Opacity_Prop, Padding_Prop, Paintable_Prop, Parent_Prop, Pickable_Prop, PrefHeight_Prop, PrefWidth_Prop, Rotate_Prop, ScaleX_Prop, ScaleY_Prop, Scroll, Showing_Prop, Spacing_Prop, Text_Prop, ToolTip_Prop, TransX_Prop, TransY_Prop, Vertical_Prop, Visible_Prop, Width_Prop, X_Prop, Y_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Fields inherited from interface snap.util.Selectable

Items_Prop, SelIndex_Prop, SelItem_Prop

Constructor Summary

Constructors

Constructor	Description
TabBar()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addTab(String aTitle, View aView)	Creates and adds a tab for given name and content view.
void	addTab(Tab aTab)	Adds a tab.
void	addTab(Tab aTab, int anIndex)	Adds a tab at given index.
View	getChildForName(String aName)	Override to search Tabs.Content not showing.
protected double	getPrefHeightImpl(double aW)	Returns the preferred height.
protected double	getPrefWidthImpl(double aH)	Returns the preferred width.
int	getSelIndex()	Returns the tap pane's selected index.
Tab	getSelItem()	Returns the selected item (tab).
Tab	getTab(int anIndex)	Returns the tab at given index.
ToggleButton	getTabButton(int anIndex)	Returns a tab button.
BiConsumer<ViewEvent,Tab>	getTabCloseActionHandler()	Returns the tab close action handler, called when a tab button close box is triggered.
int	getTabCount()	Returns the number of tabs in pane.
double	getTabMinWidth()	Returns the tab min width.
List<Tab>	getTabs()	Returns the tabs.
ParentView	getTabsBox()	Returns the actual box that holds the tabs.
String	getTabTitle(int anIndex)	Returns tab content at index.
boolean	isAllowEmptySelection()	Returns whether it is acceptable for tool bar to have no button selected.
protected void	layoutImpl()	Override to layout children with BoxView layout.
void	removeTab(int anIndex)	Removes the tab at given index.
void	removeTab(Tab aTab)	Removes the given tab.
void	removeTabs()	Removes all tabs.
void	setAllowEmptySelection(boolean aValue)	Sets whether it is acceptable for tool bar to have no button selected.
void	setSelIndex(int anIndex)	Sets the TabView's selected index.
void	setSelItem(Tab aTab)	Sets the selected item (tab).
void	setTabCloseActionHandler(BiConsumer<ViewEvent,Tab> eventListener)	Sets the tab close action handler, called when a tab button close box is triggered.
void	setTabMinWidth(double aValue)	Sets the tab min width.
protected void	tabButtonDidFireAction(ViewEvent anEvent)	Called when tab button fires action.

Methods inherited from class snap.view.ParentView

addChild, addChild, addDeepChangeListener, childDidDeepChange, childDidPropChange, fromXML, fromXMLChildren, fromXMLView, getChild, getChildAt, getChildAt, getChildCount, getChildCountManaged, getChildForClass, getChildLast, getChildren, getChildrenForClass, getChildrenInPaintOrder, getChildrenManaged, getFocusNext, getFocusPrev, getPropValue, getViewList, getViewProxy, indexOfChild, initProps, intersectsShape, isInLayout, isNeedsLayout, isNeedsLayoutDeep, isNeedsRepaintDeep, layout, layoutDeep, layoutDeepImpl, layoutFloatingViews, paintAbove, paintAll, paintChildren, parentFontChanged, processPropChange, relayout, removeChild, removeChild, removeChildren, removeDeepChangeListener, setChildren, setFont, setNeedsLayout, setNeedsLayoutDeep, setNeedsRepaintDeep, setOwner, setOwnerChildren, setPropValue, setShowing, themeChanged, toXML, toXMLChildren, toXMLView

Methods inherited from class snap.view.View

addBinding, addEventFilter, addEventHandler, clone, contains, contains, containsShape, createActionEvent, disableEvents, enableEvents, fireActionEvent, getAlign, getAlignX, getAlignY, getAnim, getAnimCleared, getAnimTimeDeep, getBestHeight, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBorder, getBorderRadius, getBounds, getBoundsLocal, getBoundsParent, getBoundsShape, getBoundsShapeParent, getClip, getClipAll, getClipAllBounds, getClipBounds, getClippedRect, getCursor, getDefaultBorder, getDefaultFill, getDefaultFont, getEffect, getEnv, getEventAdapter, getFill, getFillColor, getFocusNext, getFocusPrev, getFont, getHeight, getHost, getInsetsAll, getLean, getLeanX, getLeanY, getLocalToParent, getLocalToParent, getMargin, getMaxHeight, getMaxSize, getMaxWidth, getMaxX, getMaxY, getMidX, getMidY, getMinHeight, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, getName, getOpacity, getOpacityAll, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefSize, getPrefWidth, getPrefWidth, getProp, getPropDefault, getProps, getRealClassName, getRepaintRect, getRepaintRectExpanded, getRootView, getRotate, getScale, getScaleX, getScaleY, getSize, getSpacing, getText, getToolTip, getToolTip, getTransX, getTransY, getUpdater, getValuePropName, getVisRect, getWidth, getWindow, getX, getXY, getY, indexInHost, indexInParent, isActionable, isAncestor, isClipToBounds, isDisabled, isEnabled, isFocusable, isFocused, isFocusKeysEnabled, isFocusPainted, isFocusWhenPressed, isFontSet, isGrowHeight, isGrowWidth, isGuest, isHorizontal, isLocalToParentSimple, isManaged, isManagedVisible, isMaxHeightSet, isMaxWidthSet, isMinHeightSet, isMinWidthSet, isMouseDown, isMouseOver, isNeedsRepaint, isPaintable, isPickable, isPickableVisible, isPrefHeightSet, isPrefWidthSet, isShowing, isToolTipEnabled, isVertical, isVisible, localToParent, localToParent, localToParent, localToParent, localToScreen, paintBack, paintFront, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEvent, processEventAll, processEventFilters, processEventHandlers, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimProps, setAnimString, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, setBounds, setBounds, setBoundsLocal, setClip, setClipToBounds, setCursor, setDisabled, setEffect, setEnabled, setFill, setFocusable, setFocused, setFocusKeysEnabled, setFocusPainted, setFocusWhenPressed, setGrowHeight, setGrowWidth, setHeight, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setRealClassName, setRotate, setScale, setScaleX, setScaleY, setSize, setSize, setSizeLocal, setSizeToBestSize, setSizeToPrefSize, setSpacing, setText, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, stopIntervals, toStringProps

Methods inherited from class snap.props.PropObject

addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropsString, isPropDefault, removePropChangeListener, removePropChangeListener, setPropsString, setPropValues, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface snap.util.Selectable

getItemsList, removeItem, removeItemAndUpdateSel, setItems, setItemsList

Field Details

Tabs_Prop

public static final String Tabs_Prop

See Also:

• Constant Field Values

AllowEmptySelection_Prop

public static final String AllowEmptySelection_Prop

See Also:

• Constant Field Values

DEFAULT_PADDING

public static final Insets DEFAULT_PADDING

DEFAULT_SPACING

public static final double DEFAULT_SPACING

See Also:

• Constant Field Values

Constructor Details

TabBar

public TabBar()

Constructor.

Method Details

getTabs

public List<Tab> getTabs()

Returns the tabs.

getTabCount

public int getTabCount()

Returns the number of tabs in pane.

getTab

public Tab getTab(int anIndex)

Returns the tab at given index.

addTab

public void addTab(Tab aTab)

Adds a tab.

addTab

public void addTab(Tab aTab,
 int anIndex)

Adds a tab at given index.

removeTab

public void removeTab(int anIndex)

Removes the tab at given index.

removeTab

public void removeTab(Tab aTab)

Removes the given tab.

removeTabs

public void removeTabs()

Removes all tabs.

addTab

public void addTab(String aTitle,
 View aView)

Creates and adds a tab for given name and content view.

isAllowEmptySelection

public boolean isAllowEmptySelection()

Returns whether it is acceptable for tool bar to have no button selected. If true, clicking the selected button results in it being deselected.

setAllowEmptySelection

public void setAllowEmptySelection(boolean aValue)

Sets whether it is acceptable for tool bar to have no button selected.

getTabCloseActionHandler

public BiConsumer<ViewEvent,Tab> getTabCloseActionHandler()

Returns the tab close action handler, called when a tab button close box is triggered.

setTabCloseActionHandler

public void setTabCloseActionHandler(BiConsumer<ViewEvent,Tab> eventListener)

Sets the tab close action handler, called when a tab button close box is triggered.

getTabTitle

public String getTabTitle(int anIndex)

Returns tab content at index.

getTabMinWidth

public double getTabMinWidth()

Returns the tab min width.

setTabMinWidth

public void setTabMinWidth(double aValue)

Sets the tab min width.

getSelIndex

public int getSelIndex()

Returns the tap pane's selected index.

Specified by:

getSelIndex in interface Selectable<Tab>

setSelIndex

public void setSelIndex(int anIndex)

Sets the TabView's selected index.

Specified by:

setSelIndex in interface Selectable<Tab>

getSelItem

public Tab getSelItem()

Returns the selected item (tab).

Specified by:

getSelItem in interface Selectable<Tab>

setSelItem

public void setSelItem(Tab aTab)

Sets the selected item (tab).

Specified by:

setSelItem in interface Selectable<Tab>

getTabButton

public ToggleButton getTabButton(int anIndex)

Returns a tab button.

getTabsBox

public ParentView getTabsBox()

Returns the actual box that holds the tabs.

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Returns the preferred width.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Returns the preferred height.

Overrides:

getPrefHeightImpl in class View

layoutImpl

protected void layoutImpl()

Override to layout children with BoxView layout.

Overrides:

layoutImpl in class ParentView

tabButtonDidFireAction

protected void tabButtonDidFireAction(ViewEvent anEvent)

Called when tab button fires action.

getChildForName

public View getChildForName(String aName)

Override to search Tabs.Content not showing.

Overrides:

getChildForName in class ParentView