fi.jyu.mit.fxgui

Class BaseBoxChooser<TO,TC extends Node>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.VBox

fi.jyu.mit.fxgui.BaseBoxChooser<TO,TC>

Type Parameters:

TO - Type of objects to be stored.

TC - Type of components to be used

All Implemented Interfaces:

Chooser<TO>, MultipleChooser<TO>, Styleable, EventTarget

Direct Known Subclasses:

CheckBoxChooser, RadioButtonChooser

public abstract class BaseBoxChooser<TO,TC extends Node>
extends VBox
implements MultipleChooser<TO>

Base class for any single object that want to be added in multiples and then selected

Version:

13.1.2017

Author:

terop

Property Summary

Properties inherited from class javafx.scene.layout.VBox

alignmentProperty, fillWidthProperty, spacingProperty

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<TC>	boxes All of the components that were created
protected ArrayList<ChangeListener<Boolean>>	changeListenersForRemoval Stored listeners for easy removal
protected ObservableList<StringAndObject<TO>>	items The stored items inside this system
protected ArrayList<Consumer<TO>>	lambdaListeners Listeners for everyone who registered to any kind of changes for this object
protected BooleanProperty	nollataanko Should the components example data be reset at start
protected StringProperty	rivit StringProperty for asking the example data from the scenebuilder

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
BaseBoxChooser() Initializes the control.

Method Summary

Modifier and Type	Method and Description
void	add(StringAndObject<TO> so) Adds the StringAndObject to the system and creates components necessary
void	add(String name, TO object) Adds the given object with given name
void	add(TO object) Addes the given object to the list
protected abstract void	addChangeListener(TC box, ChangeListener<Boolean> listener) Adds to the component a listener when its state is changed.
protected abstract TC	addCorrectComponent(String name, TO object) Will give the created new component to this class so no reflection is needed.
void	addExample(String text) Adds example text to the list
void	addSelectionListener(Consumer<TO> event) Adds a selection listener to the base component so when someone does selection this event is called
void	clear() Clears the ObservableList that holds the objects
ObservableList<StringAndObject<TO>>	getItems() Returns the inner ObservableList.
boolean	getNollataanko() Returns if the component was selected to be cleared
String	getRivit() Returns the contents of the ListChooser as a multiline string.
int	getSelectedIndex() Returns the first selected index
List<Integer>	getSelectedIndices() Returns all of the selected indices
TO	getSelectedObject() Palauttaa valitun olion tai null
List<TO>	getSelectedObjects() Returns all of the selected objects from the components
String	getSelectedText() Returns the first selected text component
List<String>	getSelectedTexts() Returns all of the selected texts in the components
protected abstract boolean	isComponentSelected(TC component) Returns if the component should be selected by the baseboxchooser for getItems
protected abstract void	removeListener(TC node, ArrayList<ChangeListener<Boolean>> list) Removes all the listeners from the node from the property they may be linked to
String	removeMnemonic(String item) Poistetaan alleviiva
protected abstract boolean	setComponentSelected(TC component, boolean value) Sets component selected
void	setNollataanko(boolean reset) Sets the value if the component should be reset after the original example data
void	setRivit(String jono) Sets the rows.
void	setRivit(String[] rivit) Sets the rows.
int	setSelectedIndex(int index) Sets item in index selected
void	UpdateComponents(ObservableList<StringAndObject<TO>> list) Updates the components to match given list

Methods inherited from class javafx.scene.layout.VBox

alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, fillWidthProperty, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, getSpacing, getVgrow, isFillWidth, layoutChildren, requestLayout, setAlignment, setFillWidth, setMargin, setSpacing, setVgrow, spacingProperty

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, 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, isResizable, 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

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, 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, 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_cssGetFocusTraversableInitialValue, impl_geomChanged, impl_getAccessible, 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

Field Detail

rivit

protected StringProperty rivit

StringProperty for asking the example data from the scenebuilder

nollataanko

protected BooleanProperty nollataanko

Should the components example data be reset at start

boxes

protected ArrayList<TC extends Node> boxes

All of the components that were created

items

protected ObservableList<StringAndObject<TO>> items

The stored items inside this system

lambdaListeners

protected ArrayList<Consumer<TO>> lambdaListeners

Listeners for everyone who registered to any kind of changes for this object

changeListenersForRemoval

protected ArrayList<ChangeListener<Boolean>> changeListenersForRemoval

Stored listeners for easy removal

Constructor Detail

BaseBoxChooser

public BaseBoxChooser()

Initializes the control.

Method Detail

addSelectionListener

public void addSelectionListener(Consumer<TO> event)

Adds a selection listener to the base component so when someone does selection this event is called

Specified by:

addSelectionListener in interface Chooser<TO>

Parameters:

event - what to do when event happens

add

public void add(String name,
                TO object)

Adds the given object with given name

Specified by:

add in interface Chooser<TO>

Parameters:

name - objektin kohdalla näkyvä teksti

object - tallennettava olio

add

public void add(StringAndObject<TO> so)

Adds the StringAndObject to the system and creates components necessary

Parameters:

so - object to add

addChangeListener

protected abstract void addChangeListener(TC box,
                                          ChangeListener<Boolean> listener)

Adds to the component a listener when its state is changed. Base cannot know which property is to be cared about

Parameters:

box - componetn to use

listener - function listen

addCorrectComponent

protected abstract TC addCorrectComponent(String name,
                                          TO object)

Will give the created new component to this class so no reflection is needed. Since the class is abstract anyways

Parameters:

name - ???

object - ???

Returns:

??

getItems

public ObservableList<StringAndObject<TO>> getItems()

Returns the inner ObservableList. Will break functionality. You have been warned

Returns:

the inner observableList

UpdateComponents

public void UpdateComponents(ObservableList<StringAndObject<TO>> list)

Updates the components to match given list

Parameters:

list - the objects to make the gui look like

add

public void add(TO object)

Addes the given object to the list

Specified by:

add in interface Chooser<TO>

Parameters:

object - tallennettava olio

addExample

public void addExample(String text)

Adds example text to the list

Specified by:

addExample in interface Chooser<TO>

Parameters:

text - teksti joka näytetään

clear

public void clear()

Clears the ObservableList that holds the objects

Specified by:

clear in interface Chooser<TO>

removeListener

protected abstract void removeListener(TC node,
                                       ArrayList<ChangeListener<Boolean>> list)

Removes all the listeners from the node from the property they may be linked to

Parameters:

node - ???

list - ???

setRivit

public void setRivit(String jono)

Sets the rows.

Specified by:

setRivit in interface Chooser<TO>

Parameters:

jono - A multiline string, each line representing a single row.

setRivit

public void setRivit(String[] rivit)

Sets the rows.

Specified by:

setRivit in interface Chooser<TO>

Parameters:

rivit - A string arrays, each line representing a single row.

getSelectedObject

public TO getSelectedObject()

Palauttaa valitun olion tai null

Specified by:

getSelectedObject in interface Chooser<TO>

Returns:

valittu olio tai null

getSelectedText

public String getSelectedText()

Returns the first selected text component

Specified by:

getSelectedText in interface Chooser<TO>

Returns:

text shown on gui

getSelectedIndex

public int getSelectedIndex()

Returns the first selected index

Specified by:

getSelectedIndex in interface Chooser<TO>

Returns:

index

setSelectedIndex

public int setSelectedIndex(int index)

Description copied from interface: Chooser

Sets item in index selected

Specified by:

setSelectedIndex in interface Chooser<TO>

Parameters:

index - item to be selected

Returns:

old selected index

isComponentSelected

protected abstract boolean isComponentSelected(TC component)

Returns if the component should be selected by the baseboxchooser for getItems

Parameters:

component - the generic component that we want to know if is selected

Returns:

if the component is selected or not

setComponentSelected

protected abstract boolean setComponentSelected(TC component,
                                                boolean value)

Sets component selected

Parameters:

component - the generic component that we want to know if is selected

value - value to set for component

Returns:

if the component was selected or not

getSelectedObjects

public List<TO> getSelectedObjects()

Description copied from interface: MultipleChooser

Returns all of the selected objects from the components

Specified by:

getSelectedObjects in interface MultipleChooser<TO>

Returns:

the objects

getSelectedTexts

public List<String> getSelectedTexts()

Description copied from interface: MultipleChooser

Returns all of the selected texts in the components

Specified by:

getSelectedTexts in interface MultipleChooser<TO>

Returns:

the texts

getSelectedIndices

public List<Integer> getSelectedIndices()

Description copied from interface: MultipleChooser

Returns all of the selected indices

Specified by:

getSelectedIndices in interface MultipleChooser<TO>

Returns:

all selected indices

getRivit

public String getRivit()

Returns the contents of the ListChooser as a multiline string.

Returns:

The contents of the ListChooser as a multiline string.

setNollataanko

public void setNollataanko(boolean reset)

Sets the value if the component should be reset after the original example data

Parameters:

reset - should it be reset

getNollataanko

public boolean getNollataanko()

Returns if the component was selected to be cleared

Returns:

should it be cleared

removeMnemonic

public String removeMnemonic(String item)

Poistetaan alleviiva

Specified by:

removeMnemonic in interface Chooser<TO>

Parameters:

item - mistä poistetaan

Returns:

ilman 1. alleviivaa