GUIParameter

java.lang.Object
-
- javafx.scene.Node
- -
  - javafx.scene.Parent
  - -
    - javafx.scene.layout.Region
    - -
      - javafx.scene.layout.Pane
      - -
        -
        javafx.scene.layout.HBox
        -
        -
        -
        jcgp.gui.settings.parameters.GUIParameter<T>
        -
        -
        -
        -
      -
    -
  -
-

-
-
Type Parameters:
-
T - the parameter data type
-
-
-
All Implemented Interfaces:
-
javafx.css.Styleable, javafx.event.EventTarget
-
-
-
Direct Known Subclasses:
-
GUIBooleanParameter, GUIDoubleParameter, GUIIntegerParameter
-
-
-
-
```
public abstract class GUIParameter<T>
-extends javafx.scene.layout.HBox
```
-
This is the base class for all @code{GUIParameter}s. Using the factory method @code{GUIParameter.create()} - generates an appropriate instance of this class for the specified parameter. -

- A @code{GUIParameter} is an @code{HBox} containing a @code{Text} for the parameter name - and a @code{Control} for interaction. - It stores an instance of its associated @code{Parameter} object and also contains a @code{Tooltip} for - displaying status information. -

- Monitor parameters are updated automatically and have their @code{Control} disabled so - that no changes can be made via the GUI. - Non-monitor parameters are updated automatically as well, but may be changed by the user - if the program is not evolving.
-
-
Author:
-
Eduardo Pedroni
-
See Also:
-
Parameter
-
-

- -

- - -
Property Summary
-
- - - -
  Properties inherited from class javafx.scene.layout.HBox
  -alignmentProperty, fillHeightProperty, 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, 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
`static java.lang.String`	`BASE_CHECKBOX_STYLE`
`static java.lang.String`	`BASE_TEXT_STYLE`
`static java.lang.String`	`INVALID_PARAMETER_STYLE`
`static java.lang.String`	`VALID_PARAMETER_STYLE`
`static java.lang.String`	`WARNING_PARAMETER_STYLE`

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

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyValue()` - Set the current parameter value as the reference value of the @code{GUIParameter}. -
`static GUIParameter<?>`	`create(Parameter<?> parameter, - SettingsPane sp)` - Factory method to create @code{GUIParameter}s from @code{Parameter}s. -
`boolean`	`isValid()`
`boolean`	`requiresReset()` - Certain parameter changes might require the experiment to be reset, either - because the parameter is critical or because its status requires a reset. -
`void`	`validate()` - Force the parameter to validate its current value, and apply the associated - style to the @code{GUIParameter}. -

- - -
Methods inherited from class javafx.scene.layout.HBox
-alignmentProperty, clearConstraints, fillHeightProperty, getAlignment, getBaselineOffset, getClassCssMetaData, getContentBias, getCssMetaData, getHgrow, getMargin, getSpacing, isFillHeight, requestLayout, setAlignment, setFillHeight, setHgrow, setMargin, setSpacing, spacingProperty

- - -
Methods inherited from class javafx.scene.layout.Pane
-getChildren

- - -
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_computeGeomBounds, impl_createPeer, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapToPixelProperty, widthProperty

- - -
Methods inherited from class javafx.scene.Parent
-getChildrenUnmodifiable, getImpl_traversalEngine, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, setImpl_traversalEngine

- - -
Methods inherited from class javafx.scene.Node
-addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, 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_getAccessible, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_isShowMnemonics, impl_isTreeVisible, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, 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, setEffect, setEventDispatcher, setFocusTraversable, 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, 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
-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- -
- - - -
  Field Detail
  - - - -
  - -
    BASE_TEXT_STYLE
    -
```
public static final java.lang.String BASE_TEXT_STYLE
```
    -
    -
    See Also:
    -
    Constant Field Values
    -
    -
  - - - -
  - -
    BASE_CHECKBOX_STYLE
    -
```
public static final java.lang.String BASE_CHECKBOX_STYLE
```
    -
    -
    See Also:
    -
    Constant Field Values
    -
    -
  - - - -
  - -
    INVALID_PARAMETER_STYLE
    -
```
public static final java.lang.String INVALID_PARAMETER_STYLE
```
    -
    -
    See Also:
    -
    Constant Field Values
    -
    -
  - - - -
  - -
    WARNING_PARAMETER_STYLE
    -
```
public static final java.lang.String WARNING_PARAMETER_STYLE
```
    -
    -
    See Also:
    -
    Constant Field Values
    -
    -
  - - - -
  - -
    VALID_PARAMETER_STYLE
    -
```
public static final java.lang.String VALID_PARAMETER_STYLE
```
    -
    -
    See Also:
    -
    Constant Field Values
    -
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    create
    -
```
public static GUIParameter<?> create(Parameter<?> parameter,
-                                     SettingsPane sp)
```
    -
    Factory method to create @code{GUIParameter}s from @code{Parameter}s. - Use this to create an appropriate @code{GUIParameter} from any instance of @code{Parameter}, - rather than manually downcasting the @code{Parameter} object every time.
    -
    -
    Parameters:
    -
    parameter - a parameter for which to generate a @code{GUIParameter}.
    -
    sp - a reference to the @code{SettingsPane}.
    -
    Returns:
    -
    an appropriate instance of @code{GUIParameter}.
    -
    -
  - - - -
  - -
    isValid
    -
```
public boolean isValid()
```
    -
    -
    Returns:
    -
    true if the current value of the parameter does not prevent the - experiment from running.
    -
    -
  - - - -
  - -
    validate
    -
```
public void validate()
```
    -
    Force the parameter to validate its current value, and apply the associated - style to the @code{GUIParameter}.
    -
  - - - -
  - -
    requiresReset
    -
```
public boolean requiresReset()
```
    -
    Certain parameter changes might require the experiment to be reset, either - because the parameter is critical or because its status requires a reset.
    -
    -
    Returns:
    -
    true if an experiment reset is required due to this parameter changing.
    -
    -
  - - - -
  - -
    applyValue
    -
```
public void applyValue()
```
    -
    Set the current parameter value as the reference value of the @code{GUIParameter}. - The new reference value will be used to determine the validity of the parameter, - should its value change.
    -
  -
-

Class GUIParameter<T>

Property Summary

Properties inherited from class javafx.scene.layout.HBox

Properties inherited from class javafx.scene.layout.Region

Properties inherited from class javafx.scene.Parent

Properties inherited from class javafx.scene.Node

Field Summary

Fields inherited from class javafx.scene.layout.Region

Fields inherited from class javafx.scene.Node

Method Summary

Methods inherited from class javafx.scene.layout.HBox

Methods inherited from class javafx.scene.layout.Pane

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class javafx.scene.Parent

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Field Detail

BASE_TEXT_STYLE

BASE_CHECKBOX_STYLE

INVALID_PARAMETER_STYLE

WARNING_PARAMETER_STYLE

VALID_PARAMETER_STYLE

Method Detail

create

isValid

validate

requiresReset

applyValue