Package pamViewFX.fxNodes.hidingPane

Class HidingTab

java.lang.Object

pamViewFX.fxNodes.hidingPane.HidingTab

public class HidingTab
extends Object

A hiding tab is is used in a HidingTabPane

Author:

Jamie Macaulay

Field Summary

Fields

Modifier and Type	Field	Description
javafx.animation.Timeline	timeLineShow

Constructor Summary

Constructors

Constructor	Description
HidingTab(javafx.scene.layout.Pane contentPane, javafx.scene.control.Label tabName, javafx.scene.control.Label hideTabName)
HidingTab(javafx.scene.layout.Region contentPane, HidingTabPane hidingTabPane, javafx.scene.control.Label tabName, javafx.scene.control.Label hideTabName)

Method Summary

Modifier and Type	Method	Description
javafx.scene.layout.Region	getContentPane()	Get the Node that contains the tab content
javafx.scene.layout.Pane	getHideTab()	Get the hiding tab node.
javafx.event.EventHandler<? super javafx.scene.input.MouseEvent>	getHideTabClickProperty()	Get mouse clicked property for the Hide Tab.
javafx.scene.control.Label	getHideTabName()	Get the label that is displayed when the tab is closed.
HidingTabPane	getHidingTabPane()
javafx.scene.layout.Pane	getShowTab()	Get the tab which shows when the tab pane is open- this is located on top of the content pane and allows users to close the tab.
javafx.event.EventHandler<? super javafx.scene.input.MouseEvent>	getShowTabClickProperty()	Get mouse clicked property for the Show Tab.
javafx.scene.control.Label	getTabName()	Get the tab label which shows when the tab is open.
PamBorderPane	getTabPane()	Get the tab pane .
double	getTabWidth()	Get the size of the tab.
boolean	isShowing()	Check whether the tab is showing
protected void	setAnimation()	Set up the animation that shows tabs opening and closing.
void	setContentNode(javafx.scene.layout.Pane contentNode)	Set the the Node that contains the tab content
void	setHideTabName(javafx.scene.control.Label hideTabName)	Set the label that is displayed when the tab is closed.
void	setHidingTabPane(HidingTabPane hidingTabPane)
void	setShowing(boolean showing)	Set whether the tab should show or not.
void	setTabName(javafx.scene.control.Label tabName)	Set the label that is displayed when the tab is open.
void	showTab(boolean show)	Show the tab or hide tab.

Methods inherited from class java.lang.Object

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

Field Details

timeLineShow

public javafx.animation.Timeline timeLineShow

Constructor Details

HidingTab

public HidingTab(javafx.scene.layout.Pane contentPane,
 javafx.scene.control.Label tabName,
 javafx.scene.control.Label hideTabName)

HidingTab

public HidingTab(javafx.scene.layout.Region contentPane,
 HidingTabPane hidingTabPane,
 javafx.scene.control.Label tabName,
 javafx.scene.control.Label hideTabName)

Method Details

showTab

public void showTab(boolean show)

Show the tab or hide tab. Note this should only be called if the tab has been added to the tab list.

Parameters:

show - - true to show the tab;

tab - -the tab to show.

getTabWidth

public double getTabWidth()

Get the size of the tab. This is it's preferred size as animation deals with prefWidthproperty.

Returns:

the tab width.

setAnimation

protected void setAnimation()

Set up the animation that shows tabs opening and closing. This is similar to the hiding pane animation but

getHideTabClickProperty

public javafx.event.EventHandler<? super javafx.scene.input.MouseEvent> getHideTabClickProperty()

Get mouse clicked property for the Hide Tab. This is used whenever any section of the hide tab is clicked;

Returns:

getShowTabClickProperty

public javafx.event.EventHandler<? super javafx.scene.input.MouseEvent> getShowTabClickProperty()

Get mouse clicked property for the Show Tab. This is used whenever the top tab in the showing tab pane is clicked.

Returns:

getContentPane

public javafx.scene.layout.Region getContentPane()

Get the Node that contains the tab content

Returns:

node that contains the tab content when tab is open.

setContentNode

public void setContentNode(javafx.scene.layout.Pane contentNode)

Set the the Node that contains the tab content

Parameters:

contentNode - - the node to show when the tab is open

getHideTabName

public javafx.scene.control.Label getHideTabName()

Get the label that is displayed when the tab is closed.

Returns:

the label that is displayed when the tab is closed

setHideTabName

public void setHideTabName(javafx.scene.control.Label hideTabName)

Set the label that is displayed when the tab is closed.

Parameters:

hideTabName - - the label on the tab which shows when the tab is closed.

getTabName

public javafx.scene.control.Label getTabName()

Get the tab label which shows when the tab is open.

Returns:

-the label on the tab which shows when the tab is open.

setTabName

public void setTabName(javafx.scene.control.Label tabName)

Set the label that is displayed when the tab is open.

Parameters:

hideTabName - - the label on the tab which shows when the tab is open.

isShowing

public boolean isShowing()

Check whether the tab is showing

Returns:

true of the tab is currently open and showing.

setShowing

public void setShowing(boolean showing)

Set whether the tab should show or not.

Parameters:

showing -

getHideTab

public javafx.scene.layout.Pane getHideTab()

Get the hiding tab node.

Returns:

the hiding tab.

getShowTab

public javafx.scene.layout.Pane getShowTab()

Get the tab which shows when the tab pane is open- this is located on top of the content pane and allows users to close the tab.

Returns:

the show tab, that is the tab that sits above the content pane when the tab is showing.

getTabPane

public PamBorderPane getTabPane()

Get the tab pane . The tab pane contains all tab nodes and changes size on tab open/close.

Returns:

the tab pane.

getHidingTabPane

public HidingTabPane getHidingTabPane()

setHidingTabPane

public void setHidingTabPane(HidingTabPane hidingTabPane)