Date: Tue, 6 May 2014 14:29:37 +0100 Subject: Added javadocs, made minor changes to the comments --- doc/jcgp/gui/settings/SettingsPane.html | 495 ++++++++++++++++++ doc/jcgp/gui/settings/class-use/SettingsPane.html | 167 ++++++ doc/jcgp/gui/settings/package-frame.html | 20 + doc/jcgp/gui/settings/package-summary.html | 142 +++++ doc/jcgp/gui/settings/package-tree.html | 157 ++++++ doc/jcgp/gui/settings/package-use.html | 157 ++++++ .../settings/parameters/GUIBooleanParameter.html | 392 ++++++++++++++ .../settings/parameters/GUIDoubleParameter.html | 392 ++++++++++++++ .../settings/parameters/GUIIntegerParameter.html | 392 ++++++++++++++ doc/jcgp/gui/settings/parameters/GUIParameter.html | 575 +++++++++++++++++++++ .../parameters/class-use/GUIBooleanParameter.html | 124 +++++ .../parameters/class-use/GUIDoubleParameter.html | 124 +++++ .../parameters/class-use/GUIIntegerParameter.html | 124 +++++ .../parameters/class-use/GUIParameter.html | 197 +++++++ .../gui/settings/parameters/package-frame.html | 23 + .../gui/settings/parameters/package-summary.html | 165 ++++++ doc/jcgp/gui/settings/parameters/package-tree.html | 163 ++++++ doc/jcgp/gui/settings/parameters/package-use.html | 159 ++++++ doc/jcgp/gui/settings/testcase/TestCaseTable.html | 343 ++++++++++++ .../settings/testcase/class-use/TestCaseTable.html | 164 ++++++ doc/jcgp/gui/settings/testcase/package-frame.html | 20 + .../gui/settings/testcase/package-summary.html | 144 ++++++ doc/jcgp/gui/settings/testcase/package-tree.html | 145 ++++++ doc/jcgp/gui/settings/testcase/package-use.html | 159 ++++++ 24 files changed, 4943 insertions(+) create mode 100644 doc/jcgp/gui/settings/SettingsPane.html create mode 100644 doc/jcgp/gui/settings/class-use/SettingsPane.html create mode 100644 doc/jcgp/gui/settings/package-frame.html create mode 100644 doc/jcgp/gui/settings/package-summary.html create mode 100644 doc/jcgp/gui/settings/package-tree.html create mode 100644 doc/jcgp/gui/settings/package-use.html create mode 100644 doc/jcgp/gui/settings/parameters/GUIBooleanParameter.html create mode 100644 doc/jcgp/gui/settings/parameters/GUIDoubleParameter.html create mode 100644 doc/jcgp/gui/settings/parameters/GUIIntegerParameter.html create mode 100644 doc/jcgp/gui/settings/parameters/GUIParameter.html create mode 100644 doc/jcgp/gui/settings/parameters/class-use/GUIBooleanParameter.html create mode 100644 doc/jcgp/gui/settings/parameters/class-use/GUIDoubleParameter.html create mode 100644 doc/jcgp/gui/settings/parameters/class-use/GUIIntegerParameter.html create mode 100644 doc/jcgp/gui/settings/parameters/class-use/GUIParameter.html create mode 100644 doc/jcgp/gui/settings/parameters/package-frame.html create mode 100644 doc/jcgp/gui/settings/parameters/package-summary.html create mode 100644 doc/jcgp/gui/settings/parameters/package-tree.html create mode 100644 doc/jcgp/gui/settings/parameters/package-use.html create mode 100644 doc/jcgp/gui/settings/testcase/TestCaseTable.html create mode 100644 doc/jcgp/gui/settings/testcase/class-use/TestCaseTable.html create mode 100644 doc/jcgp/gui/settings/testcase/package-frame.html create mode 100644 doc/jcgp/gui/settings/testcase/package-summary.html create mode 100644 doc/jcgp/gui/settings/testcase/package-tree.html create mode 100644 doc/jcgp/gui/settings/testcase/package-use.html (limited to 'doc/jcgp/gui/settings') diff --git a/doc/jcgp/gui/settings/SettingsPane.html b/doc/jcgp/gui/settings/SettingsPane.html new file mode 100644 index 0000000..ad765ec --- /dev/null +++ b/doc/jcgp/gui/settings/SettingsPane.html @@ -0,0 +1,495 @@ + + + + + +SettingsPane + + + + + + + + +

+ + +

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- javafx.scene.Node
- +
  - javafx.scene.Parent
  - +
    - javafx.scene.layout.Region
    - +
      - javafx.scene.layout.Pane
      - +
        +
        javafx.scene.layout.AnchorPane
        +
        +
        +
        jcgp.gui.settings.SettingsPane
        +
        +
        +
        +
      +
    +
  +
+

+
+
All Implemented Interfaces:
+
javafx.css.Styleable, javafx.event.EventTarget
+
+
+
+
```
public class SettingsPane
+extends javafx.scene.layout.AnchorPane
```
+

+ +

+ + +
Property Summary
+
- + + +
  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 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
SettingsPane(GUI gui)
+

Constructors
Constructor and Description
`SettingsPane(GUI gui)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyParameters()` + Calls applyValue() on every parameter. +
`boolean`	`areParametersValid()`
`TestCaseTable`	`getTestCaseTable()`
`boolean`	`isExperimentRunning()`
`boolean`	`isResetRequired()`
`void`	`revalidateParameters()` + Calls validate() on every parameter. +
`void`	`updateControls(boolean running, + boolean finished)` + Updates all of the controls to their appropriate state based on the status of the + experiment, in order to prevent inappropriate operations if the experiment is + running or finished. +

+ + +
Methods inherited from class javafx.scene.layout.AnchorPane
+clearConstraints, getBottomAnchor, getLeftAnchor, getRightAnchor, getTopAnchor, setBottomAnchor, setLeftAnchor, setRightAnchor, setTopAnchor

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

+ + +
Methods inherited from class javafx.scene.layout.Region
+backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getClassCssMetaData, getCssMetaData, 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
+getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, 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, 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_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

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    SettingsPane
    +
```
public SettingsPane(GUI gui)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    isExperimentRunning
    +
```
public boolean isExperimentRunning()
```
    +
  + + + +
  - +
    isResetRequired
    +
```
public boolean isResetRequired()
```
    +
    +
    Returns:
    +
    true if the experiment needs to be reset, false if otherwise.
    +
    +
  + + + +
  - +
    areParametersValid
    +
```
public boolean areParametersValid()
```
    +
    +
    Returns:
    +
    true if no parameters have their status set to ParameterStatus.INVALID.
    +
    +
  + + + +
  - +
    revalidateParameters
    +
```
public void revalidateParameters()
```
    +
    Calls validate() on every parameter. This is called whenever a parameter changes, + so that other parameters update their status in case they were dependent on the + changed parameter.
    +
  + + + +
  - +
    applyParameters
    +
```
public void applyParameters()
```
    +
    Calls applyValue() on every parameter. This is called when a reset occurs, so that + the new value will be used as a reference instead of the old reference value.
    +
  + + + +
  - +
    updateControls
    +
```
public void updateControls(boolean running,
+                           boolean finished)
```
    +
    Updates all of the controls to their appropriate state based on the status of the + experiment, in order to prevent inappropriate operations if the experiment is + running or finished.
    +
    +
    Parameters:
    +
    running - true if the experiment is running
    +
    finished - true if the experiment is finished
    +
    +
  + + + +
  - +
    getTestCaseTable
    +
```
public TestCaseTable getTestCaseTable()
```
    +
  +
+

+ + +

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`

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}. +

Modifier and Type	Class and Description
`class`	`GUIBooleanParameter` + This extension of @code{GUIParameter} uses a @code{CheckBox} to display + the value of a @code{BooleanParameter}. +
`class`	`GUIDoubleParameter` + This extension of @code{GUIParameter} uses a @code{TextField} to display + the value of a @code{DoubleParameter}. +
`class`	`GUIIntegerParameter` + This extension of @code{GUIParameter} uses a @code{TextField} to display + the value of a @code{IntegerParameter}. +

Class	Description
GUIBooleanParameter	+ This extension of @code{GUIParameter} uses a @code{CheckBox} to display + the value of a @code{BooleanParameter}. +
GUIDoubleParameter	+ This extension of @code{GUIParameter} uses a @code{TextField} to display + the value of a @code{DoubleParameter}. +
GUIIntegerParameter	+ This extension of @code{GUIParameter} uses a @code{TextField} to display + the value of a @code{IntegerParameter}. +
GUIParameter<T>	+ This is the base class for all @code{GUIParameter}s. +

Class SettingsPane

Property Summary

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

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.layout.AnchorPane

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

Constructor Detail

SettingsPane

Method Detail

isExperimentRunning

isResetRequired

areParametersValid

revalidateParameters

applyParameters

updateControls

getTestCaseTable

Uses of Classjcgp.gui.settings.SettingsPane

Uses of SettingsPane in jcgp.gui.settings.parameters

jcgp.gui.settings

Classes

Package jcgp.gui.settings

Hierarchy For Package jcgp.gui.settings

Class Hierarchy

Uses of Packagejcgp.gui.settings

Class GUIBooleanParameter

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 jcgp.gui.settings.parameters.GUIParameter

Fields inherited from class javafx.scene.layout.Region

Fields inherited from class javafx.scene.Node

Method Summary

Methods inherited from class jcgp.gui.settings.parameters.GUIParameter

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

Method Detail

refreshValue

Class GUIDoubleParameter

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 jcgp.gui.settings.parameters.GUIParameter

Fields inherited from class javafx.scene.layout.Region

Fields inherited from class javafx.scene.Node

Method Summary

Methods inherited from class jcgp.gui.settings.parameters.GUIParameter

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

Method Detail

refreshValue

Class GUIIntegerParameter

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

Uses of Class
jcgp.gui.settings.SettingsPane

Uses of Package
jcgp.gui.settings

Uses of Class
jcgp.gui.settings.parameters.GUIBooleanParameter

Uses of Class
jcgp.gui.settings.parameters.GUIDoubleParameter

Uses of Class
jcgp.gui.settings.parameters.GUIIntegerParameter

Uses of Class
jcgp.gui.settings.parameters.GUIParameter

Uses of Package
jcgp.gui.settings.parameters

Uses of Class
jcgp.gui.settings.testcase.TestCaseTable