jfxtras.labs.scene.control

Class BigDecimalField

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

jfxtras.labs.scene.control.BigDecimalField

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class BigDecimalField
extends javafx.scene.control.Control

Input field for BigDecimal values. This control has the following features: <ul> <li>BigDecimal number is parsed and formatted according to the provided NumberFormat</li> <li>getter/setter for BigDecimal and (formatted) String representation of the number value</li> <li>up/down arrow keys and buttons increment/decrement the number by stepwidth</li> <li>If minValueProperty() and/or maxValue are set, values outside these boundaries are not accepted for number</li> </ul> CSS structure is: <ul> <li>.big-decimal-field <ul> <li>.text-field</li> <li>.arrow-button.arrow-button-up <ul> <li>.spinner-arrow.spinner-arrow-up</li> </ul></li> <li>.arrow-button.arrow-button-down <ul> <li>.spinner-arrow.spinner-arrow-down</li> </ul></li> </ul></li> </ul>

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<java.text.NumberFormat>	format
javafx.beans.property.ObjectProperty<java.math.BigDecimal>	maxValue
javafx.beans.property.ObjectProperty<java.math.BigDecimal>	minValue
javafx.beans.property.ObjectProperty<java.math.BigDecimal>	number
javafx.beans.property.StringProperty	promptText
javafx.beans.property.ObjectProperty<java.math.BigDecimal>	stepwidth

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

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, 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 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
BigDecimalField() Default constructor.
BigDecimalField(java.math.BigDecimal initialValue) Returns a BigDecimalField with stepwidth 1 and number set to initialValue.
BigDecimalField(java.math.BigDecimal initialValue, java.math.BigDecimal stepwidth, java.text.NumberFormat format)

Method Summary

Modifier and Type	Method and Description
void	decrement() decrements the number by stepwidth
javafx.beans.property.ObjectProperty<java.text.NumberFormat>	formatProperty()
java.text.NumberFormat	getFormat()
java.math.BigDecimal	getMaxValue()
java.math.BigDecimal	getMinValue()
java.math.BigDecimal	getNumber()
java.lang.String	getPromptText()
java.math.BigDecimal	getStepwidth()
java.lang.String	getText()
java.lang.String	getUserAgentStylesheet()
void	increment() increments the number by stepwidth
javafx.beans.property.ObjectProperty<java.math.BigDecimal>	maxValueProperty()
javafx.beans.property.ObjectProperty<java.math.BigDecimal>	minValueProperty()
javafx.beans.property.ObjectProperty<java.math.BigDecimal>	numberProperty()
javafx.beans.property.StringProperty	promptTextProperty()
void	setFormat(java.text.NumberFormat value)
void	setMaxValue(java.math.BigDecimal value)
void	setMinValue(java.math.BigDecimal value)
void	setNumber(java.math.BigDecimal value)
void	setPromptText(java.lang.String value)
void	setStepwidth(java.math.BigDecimal value)
void	setText(java.lang.String formattedNumber)
javafx.beans.property.ObjectProperty<java.math.BigDecimal>	stepwidthProperty()

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, queryAccessibleAttribute, 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

getChildren, 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

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, 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, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, 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, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, 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

Property Detail

number

public javafx.beans.property.ObjectProperty<java.math.BigDecimal> numberProperty

Returns:

The property containing the BigDecimal number

stepwidth

public javafx.beans.property.ObjectProperty<java.math.BigDecimal> stepwidthProperty

format

public javafx.beans.property.ObjectProperty<java.text.NumberFormat> formatProperty

promptText

public javafx.beans.property.StringProperty promptTextProperty

maxValue

public javafx.beans.property.ObjectProperty<java.math.BigDecimal> maxValueProperty

minValue

public javafx.beans.property.ObjectProperty<java.math.BigDecimal> minValueProperty

Constructor Detail

BigDecimalField

public BigDecimalField()

Default constructor. Returns a BigDecimalField with no number, minValue and maxValue set, but stepwidth 1 and default NumberFormat.

BigDecimalField

public BigDecimalField(java.math.BigDecimal initialValue)

Returns a BigDecimalField with stepwidth 1 and number set to initialValue.

Parameters:

initialValue - The initial BigDecimal value of this control.

BigDecimalField

public BigDecimalField(java.math.BigDecimal initialValue,
                       java.math.BigDecimal stepwidth,
                       java.text.NumberFormat format)

Parameters:

initialValue - The initial BigDecimal value of this control.

stepwidth - The stepwidth for increment/decrement operations.

format - The NumberFormat that is used to format the number in the control.

Method Detail

getText

public java.lang.String getText()

Returns:

The formatted String representation of number

setText

public void setText(java.lang.String formattedNumber)

Parameters:

formattedNumber - representation of number

increment

public void increment()

increments the number by stepwidth

decrement

public void decrement()

decrements the number by stepwidth

getNumber

public java.math.BigDecimal getNumber()

Returns:

The number of this control as BigDecimal.

setNumber

public void setNumber(java.math.BigDecimal value)

Parameters:

value -

Throws:

java.lang.IllegalArgumentException - if minValue and/or maxValue are set and value is out of these bounds.

numberProperty

public javafx.beans.property.ObjectProperty<java.math.BigDecimal> numberProperty()

Returns:

The property containing the BigDecimal number

getStepwidth

public java.math.BigDecimal getStepwidth()

setStepwidth

public void setStepwidth(java.math.BigDecimal value)

stepwidthProperty

public javafx.beans.property.ObjectProperty<java.math.BigDecimal> stepwidthProperty()

getFormat

public java.text.NumberFormat getFormat()

setFormat

public final void setFormat(java.text.NumberFormat value)

formatProperty

public javafx.beans.property.ObjectProperty<java.text.NumberFormat> formatProperty()

getPromptText

public java.lang.String getPromptText()

setPromptText

public final void setPromptText(java.lang.String value)

promptTextProperty

public javafx.beans.property.StringProperty promptTextProperty()

getMaxValue

public java.math.BigDecimal getMaxValue()

setMaxValue

public void setMaxValue(java.math.BigDecimal value)

maxValueProperty

public javafx.beans.property.ObjectProperty<java.math.BigDecimal> maxValueProperty()

getMinValue

public java.math.BigDecimal getMinValue()

setMinValue

public void setMinValue(java.math.BigDecimal value)

minValueProperty

public javafx.beans.property.ObjectProperty<java.math.BigDecimal> minValueProperty()

getUserAgentStylesheet

public java.lang.String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class javafx.scene.layout.Region