org.jacpfx.rcp.components.toolBar

Class JACPToolBar

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.ToolBar

org.jacpfx.rcp.components.toolBar.JACPToolBar

All Implemented Interfaces:

javafx.beans.value.ChangeListener<javafx.geometry.Orientation>, javafx.collections.ListChangeListener<javafx.scene.Node>, javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class JACPToolBar
extends javafx.scene.control.ToolBar
implements javafx.beans.value.ChangeListener<javafx.geometry.Orientation>, javafx.collections.ListChangeListener<javafx.scene.Node>

The Class JACPToolBar.

Author:

Patrick Symmangk (pete.jacp@gmail.com)

Property Summary

Properties inherited from class javafx.scene.control.ToolBar

orientationProperty

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested classes/interfaces inherited from interface javafx.collections.ListChangeListener

javafx.collections.ListChangeListener.Change<E>

Field Summary

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
JACPToolBar() Instantiates a new jACP tool bar.

Method Summary

Modifier and Type	Method and Description
void	add(javafx.scene.layout.Region region)
void	add(java.lang.String id, javafx.scene.layout.Region region) Adds the.
void	addAll(javafx.scene.layout.Region... regions) Add multiple regions to the toolbar.
void	addAll(java.lang.String id, javafx.scene.layout.Region... regions) Add multiple regions to the toolbar.
void	addAllOnEnd(javafx.scene.layout.Region... regions) Add multiple regions to the toolbar.
void	addAllOnEnd(java.lang.String id, javafx.scene.layout.Region... regions) Add multiple regions to the toolbar.
void	addAllToCenter(javafx.scene.layout.Region... regions) Add multiple regions to the toolbar.
void	addAllToCenter(java.lang.String id, javafx.scene.layout.Region... regions) Add multiple regions to the toolbar.
void	addOnEnd(javafx.scene.layout.Region region) Adds the on end.
void	addOnEnd(java.lang.String id, javafx.scene.layout.Region region) Adds the on end.
void	addToCenter(javafx.scene.layout.Region region) Adds the on end.
void	addToCenter(java.lang.String id, javafx.scene.layout.Region region) Adds the on end.
void	changed(javafx.beans.value.ObservableValue<? extends javafx.geometry.Orientation> arg0, javafx.geometry.Orientation oldOrientation, javafx.geometry.Orientation newOrientation)
void	clearRegions(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> subcomponent, java.lang.String parentId)
int	countVisibleButtons()
protected javafx.collections.ObservableList<javafx.scene.Node>	getChildren()
java.util.List<javafx.scene.layout.Region>	getNodes(java.lang.String id) returns all the regions for the given id.
java.util.Map<org.jacpfx.rcp.components.toolBar.JACPToolBar.JACPToolBarPosition,javafx.scene.layout.Pane>	getToolBarContainer()
void	hideButtons(java.lang.String id) hide Toolbar Buttons by a given Id
void	onChanged(javafx.collections.ListChangeListener.Change<? extends javafx.scene.Node> arg0)
void	removeForId(java.lang.String id)
void	setButtonsVisible(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective, boolean visible)
void	setButtonsVisible(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> subcomponent, java.lang.String parentId, boolean visible)
void	setContext(java.lang.String parentId, java.lang.String componentId)
void	setWorkbenchButtonsVisible(java.lang.String id, boolean visible)
void	showButtons(java.lang.String id) show Toolbar Buttons by a given Id

Methods inherited from class javafx.scene.control.ToolBar

createDefaultSkin, getClassCssMetaData, getControlCssMetaData, getItems, getOrientation, impl_cssGetFocusTraversableInitialValue, orientationProperty, setOrientation

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, getUserAgentStylesheet, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

JACPToolBar

public JACPToolBar()

Instantiates a new jACP tool bar.

Method Detail

add

public void add(javafx.scene.layout.Region region)

add

public void add(java.lang.String id,
                javafx.scene.layout.Region region)

Adds the.

Parameters:

id - an unique id

region - the region

removeForId

public void removeForId(java.lang.String id)

addAll

public void addAll(javafx.scene.layout.Region... regions)

Add multiple regions to the toolbar. Those regions are added by id and will appear in the first place of the toolbar

The id is the name of the calling component by default. For self-managed ids see addAll(String id, Region... regions)

Parameters:

regions - the regions to add

addAll

public void addAll(java.lang.String id,
                   javafx.scene.layout.Region... regions)

Add multiple regions to the toolbar. Those regions are added by id and will appear in the first place of the toolbar

Parameters:

id - - the id the regions will refer to

regions - the regions to add

addAllOnEnd

public void addAllOnEnd(javafx.scene.layout.Region... regions)

Add multiple regions to the toolbar. Those regions are added by id and will appear on the end of the toolbar Means right hand side for ToolbarPosition.NORTH and ToolbarPosition.SOUTH and on the bottom for ToolbarPosition.EAST and ToolbarPosition.WEST

The id is the name of the calling component by default. For self-managed ids see addAllOnEnd(String id, Region... regions)

Parameters:

regions - the regions to add

addAllOnEnd

public void addAllOnEnd(java.lang.String id,
                        javafx.scene.layout.Region... regions)

Add multiple regions to the toolbar. Those regions are added by id and will appear on the end of the toolbar Means right hand side for ToolbarPosition.NORTH and ToolbarPosition.SOUTH and on the bottom for ToolbarPosition.EAST and ToolbarPosition.WEST

Parameters:

id - self managed id for the given regions

regions - the regions to add

addAllToCenter

public void addAllToCenter(javafx.scene.layout.Region... regions)

Add multiple regions to the toolbar. Those regions are added by id and will appear in the middle of the toolbar

The id is the name of the calling component by default. For self-managed ids see addAllOnEnd(String id, Region... regions)

Parameters:

regions - the regions to add

addAllToCenter

public void addAllToCenter(java.lang.String id,
                           javafx.scene.layout.Region... regions)

Add multiple regions to the toolbar. Those regions are added by id and will appear in the middle of the toolbar

Parameters:

id - self managed id for the given regions

regions - the regions to add

addToCenter

public void addToCenter(java.lang.String id,
                        javafx.scene.layout.Region region)

Adds the on end.

Parameters:

id - an unique id

region - the region

addToCenter

public void addToCenter(javafx.scene.layout.Region region)

Adds the on end.

Parameters:

region - the region

addOnEnd

public void addOnEnd(java.lang.String id,
                     javafx.scene.layout.Region region)

Adds the on end.

Parameters:

id - an unique id

region - the region

addOnEnd

public void addOnEnd(javafx.scene.layout.Region region)

Adds the on end.

Parameters:

region - the region

getToolBarContainer

public java.util.Map<org.jacpfx.rcp.components.toolBar.JACPToolBar.JACPToolBarPosition,javafx.scene.layout.Pane> getToolBarContainer()

hideButtons

public void hideButtons(java.lang.String id)

hide Toolbar Buttons by a given Id

Parameters:

id - -the given id

showButtons

public void showButtons(java.lang.String id)

show Toolbar Buttons by a given Id

Parameters:

id - -the given id

setButtonsVisible

public void setButtonsVisible(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective,
                              boolean visible)

setButtonsVisible

public void setButtonsVisible(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> subcomponent,
                              java.lang.String parentId,
                              boolean visible)

setWorkbenchButtonsVisible

public void setWorkbenchButtonsVisible(java.lang.String id,
                                       boolean visible)

changed

public void changed(javafx.beans.value.ObservableValue<? extends javafx.geometry.Orientation> arg0,
                    javafx.geometry.Orientation oldOrientation,
                    javafx.geometry.Orientation newOrientation)

Specified by:

changed in interface javafx.beans.value.ChangeListener<javafx.geometry.Orientation>

onChanged

public void onChanged(javafx.collections.ListChangeListener.Change<? extends javafx.scene.Node> arg0)

Specified by:

onChanged in interface javafx.collections.ListChangeListener<javafx.scene.Node>

getNodes

public java.util.List<javafx.scene.layout.Region> getNodes(java.lang.String id)

returns all the regions for the given id.

Parameters:

id - - the custom id, which was provided on add .

Returns:

A list of regions, if any or an empty list.

getChildren

protected javafx.collections.ObservableList<javafx.scene.Node> getChildren()

Overrides:

getChildren in class javafx.scene.Parent

clearRegions

public void clearRegions(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> subcomponent,
                         java.lang.String parentId)

setContext

public void setContext(java.lang.String parentId,
                       java.lang.String componentId)

countVisibleButtons

public int countVisibleButtons()