lk.vivoxalabs.customstage

Class CustomStage

java.lang.Object

javafx.stage.Window

javafx.stage.Stage

lk.vivoxalabs.customstage.CustomStage

All Implemented Interfaces:

javafx.event.EventTarget

public class CustomStage
extends javafx.stage.Stage

A fully user customizable JavaFX Stage All of the customizing methods and methods which changing the appearance of the scene executed on FX-threads so user does not have to call these methods inside a Platform.runlater

Version:

1.1.1

Author:

oshan

Property Summary

Properties inherited from class javafx.stage.Stage

alwaysOnTopProperty, fullScreenExitHintProperty, fullScreenExitKeyProperty, fullScreenProperty, iconifiedProperty, maxHeightProperty, maximizedProperty, maxWidthProperty, minHeightProperty, minWidthProperty, resizableProperty, titleProperty

Properties inherited from class javafx.stage.Window

eventDispatcherProperty, focusedProperty, heightProperty, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, sceneProperty, showingProperty, widthProperty, xProperty, yProperty

Field Summary

Fields inherited from class javafx.stage.Window

impl_peer, peerListener

Method Summary

Modifier and Type	Method and Description
void	changeScene(javafx.scene.layout.Pane pane) Changes the current view of the Stage to the given view (pane)
void	dynamicDrawerEvent(NavigationType type) This method shall be called if a dynamic navigationPane is in use.
static SceneManager	getDefaultSceneManager()
void	removeNavigationPane(NavigationType type) Removes the pointed navigationPane from the window
void	setNavigationPane(NavigationType type, javafx.scene.layout.Pane navigationPane) Sets a static navigation pane (right side of the window) attaching the pane given
void	setStyleSheet(URL path) Style the CustomStage as to the user given stylesheet
void	setTitleColor(String color) Changes the color of the color in title-bar
void	setWindowColor(String color) Changes the color of the window
void	setWindowTitle(String title) Sets the title of the title-bar

Methods inherited from class javafx.stage.Stage

alwaysOnTopProperty, close, fullScreenExitHintProperty, fullScreenExitKeyProperty, fullScreenProperty, getFullScreenExitHint, getFullScreenExitKeyCombination, getIcons, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getModality, getOwner, getStyle, getTitle, iconifiedProperty, impl_getMXWindowType, impl_setImportant, impl_setPrimary, impl_visibleChanged, impl_visibleChanging, initModality, initOwner, initStyle, isAlwaysOnTop, isFullScreen, isIconified, isMaximized, isResizable, maxHeightProperty, maximizedProperty, maxWidthProperty, minHeightProperty, minWidthProperty, resizableProperty, setAlwaysOnTop, setFullScreen, setFullScreenExitHint, setFullScreenExitKeyCombination, setIconified, setMaxHeight, setMaximized, setMaxWidth, setMinHeight, setMinWidth, setResizable, setScene, setTitle, show, showAndWait, titleProperty, toBack, toFront

Methods inherited from class javafx.stage.Window

addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getProperties, getScene, getUserData, getWidth, getX, getY, hasProperties, heightProperty, hide, impl_getPeer, impl_getWindows, isFocused, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, removeEventFilter, removeEventHandler, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setFocused, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setUserData, setWidth, setX, setY, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

Methods inherited from class java.lang.Object

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

Method Detail

changeScene

public void changeScene(javafx.scene.layout.Pane pane)

Changes the current view of the Stage to the given view (pane)

Parameters:

pane - root pane of the loaded fxml view

setWindowTitle

public void setWindowTitle(String title)

Sets the title of the title-bar

Parameters:

title - title for the window

setWindowColor

public void setWindowColor(String color)

Changes the color of the window

Parameters:

color - name/hex/rgb/rgba value of the color

setTitleColor

public void setTitleColor(String color)

Changes the color of the color in title-bar

Parameters:

color - name/hex/rgb/rgba value of the color

setStyleSheet

public void setStyleSheet(URL path)

Style the CustomStage as to the user given stylesheet

Parameters:

path - URL of the stylesheet

setNavigationPane

public void setNavigationPane(NavigationType type,
                              javafx.scene.layout.Pane navigationPane)

Sets a static navigation pane (right side of the window) attaching the pane given

Parameters:

type - where the navigationPane should be placed on the window (LEFT/RIGHT/TOP/BOTTOM)

navigationPane - root pane of the navigation (fxml file)

removeNavigationPane

public void removeNavigationPane(NavigationType type)

Removes the pointed navigationPane from the window

Parameters:

type - which navigationPane should be removed from the window (LEFT/RIGHT/TOP/BOTTOM)

dynamicDrawerEvent

public void dynamicDrawerEvent(NavigationType type)

This method shall be called if a dynamic navigationPane is in use. Will call either drawer.open() or drawer.hide() method depending on the drawer's current showing state.

It is recommended to use this event especially if you're using NavigationType.TOP navigation, inorder to avoid the navigationPane from overlapping the title-bar on its drawer.hider() call.

Parameters:

type - the navigationPane which the event should be triggered for

getDefaultSceneManager

public static SceneManager getDefaultSceneManager()

Returns:

the static SceneManager object in CustomStage