diff options
| author | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
|---|---|---|
| committer | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
| commit | 8189116ea4b5db4675e31dfd04a5687d55e29262 (patch) | |
| tree | c1815021452a888f8838f1628d8fb4689777e73e /doc/jcgp/gui/settings/parameters/GUIParameter.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/gui/settings/parameters/GUIParameter.html')
| -rw-r--r-- | doc/jcgp/gui/settings/parameters/GUIParameter.html | 575 |
1 files changed, 575 insertions, 0 deletions
diff --git a/doc/jcgp/gui/settings/parameters/GUIParameter.html b/doc/jcgp/gui/settings/parameters/GUIParameter.html new file mode 100644 index 0000000..62e9ffe --- /dev/null +++ b/doc/jcgp/gui/settings/parameters/GUIParameter.html @@ -0,0 +1,575 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_05) on Tue May 06 14:28:06 BST 2014 --> +<title>GUIParameter</title> +<meta name="date" content="2014-05-06"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="GUIParameter"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GUIParameter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../jcgp/gui/settings/parameters/GUIIntegerParameter.html" title="class in jcgp.gui.settings.parameters"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?jcgp/gui/settings/parameters/GUIParameter.html" target="_top">Frames</a></li> +<li><a href="GUIParameter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">jcgp.gui.settings.parameters</div> +<h2 title="Class GUIParameter" class="title">Class GUIParameter<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>javafx.scene.Node</li> +<li> +<ul class="inheritance"> +<li>javafx.scene.Parent</li> +<li> +<ul class="inheritance"> +<li>javafx.scene.layout.Region</li> +<li> +<ul class="inheritance"> +<li>javafx.scene.layout.Pane</li> +<li> +<ul class="inheritance"> +<li>javafx.scene.layout.HBox</li> +<li> +<ul class="inheritance"> +<li>jcgp.gui.settings.parameters.GUIParameter<T></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the parameter data type</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>javafx.css.Styleable, javafx.event.EventTarget</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../jcgp/gui/settings/parameters/GUIBooleanParameter.html" title="class in jcgp.gui.settings.parameters">GUIBooleanParameter</a>, <a href="../../../../jcgp/gui/settings/parameters/GUIDoubleParameter.html" title="class in jcgp.gui.settings.parameters">GUIDoubleParameter</a>, <a href="../../../../jcgp/gui/settings/parameters/GUIIntegerParameter.html" title="class in jcgp.gui.settings.parameters">GUIIntegerParameter</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">GUIParameter<T></span> +extends javafx.scene.layout.HBox</pre> +<div class="block">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. + <br><br> + 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. + <br><br> + 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.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Eduardo Pedroni</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters"><code>Parameter</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== PROPERTY SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="property.summary"> +<!-- --> +</a> +<h3>Property Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="properties.inherited.from.class.javafx.scene.layout.HBox"> +<!-- --> +</a> +<h3>Properties inherited from class javafx.scene.layout.HBox</h3> +<code>alignmentProperty, fillHeightProperty, spacingProperty</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="properties.inherited.from.class.javafx.scene.layout.Region"> +<!-- --> +</a> +<h3>Properties inherited from class javafx.scene.layout.Region</h3> +<code>backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="properties.inherited.from.class.javafx.scene.Parent"> +<!-- --> +</a> +<h3>Properties inherited from class javafx.scene.Parent</h3> +<code>impl_traversalEngineProperty, needsLayoutProperty</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="properties.inherited.from.class.javafx.scene.Node"> +<!-- --> +</a> +<h3>Properties inherited from class javafx.scene.Node</h3> +<code>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</code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#BASE_CHECKBOX_STYLE">BASE_CHECKBOX_STYLE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#BASE_TEXT_STYLE">BASE_TEXT_STYLE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#INVALID_PARAMETER_STYLE">INVALID_PARAMETER_STYLE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#VALID_PARAMETER_STYLE">VALID_PARAMETER_STYLE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#WARNING_PARAMETER_STYLE">WARNING_PARAMETER_STYLE</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.javafx.scene.layout.Region"> +<!-- --> +</a> +<h3>Fields inherited from class javafx.scene.layout.Region</h3> +<code>USE_COMPUTED_SIZE, USE_PREF_SIZE</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.javafx.scene.Node"> +<!-- --> +</a> +<h3>Fields inherited from class javafx.scene.Node</h3> +<code>BASELINE_OFFSET_SAME_AS_HEIGHT</code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#applyValue--">applyValue</a></span>()</code> +<div class="block">Set the current parameter value as the reference value of the @code{GUIParameter}.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a><?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#create-jcgp.backend.parameters.Parameter-jcgp.gui.settings.SettingsPane-">create</a></span>(<a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a><?> parameter, + <a href="../../../../jcgp/gui/settings/SettingsPane.html" title="class in jcgp.gui.settings">SettingsPane</a> sp)</code> +<div class="block">Factory method to create @code{GUIParameter}s from @code{Parameter}s.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#isValid--">isValid</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#requiresReset--">requiresReset</a></span>()</code> +<div class="block">Certain parameter changes might require the experiment to be reset, either + because the parameter is critical or because its status requires a reset.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#validate--">validate</a></span>()</code> +<div class="block">Force the parameter to validate its current value, and apply the associated + style to the @code{GUIParameter}.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.javafx.scene.layout.HBox"> +<!-- --> +</a> +<h3>Methods inherited from class javafx.scene.layout.HBox</h3> +<code>alignmentProperty, clearConstraints, fillHeightProperty, getAlignment, getBaselineOffset, getClassCssMetaData, getContentBias, getCssMetaData, getHgrow, getMargin, getSpacing, isFillHeight, requestLayout, setAlignment, setFillHeight, setHgrow, setMargin, setSpacing, spacingProperty</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.javafx.scene.layout.Pane"> +<!-- --> +</a> +<h3>Methods inherited from class javafx.scene.layout.Pane</h3> +<code>getChildren</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.javafx.scene.layout.Region"> +<!-- --> +</a> +<h3>Methods inherited from class javafx.scene.layout.Region</h3> +<code>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</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.javafx.scene.Parent"> +<!-- --> +</a> +<h3>Methods inherited from class javafx.scene.Parent</h3> +<code>getChildrenUnmodifiable, getImpl_traversalEngine, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, setImpl_traversalEngine</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.javafx.scene.Node"> +<!-- --> +</a> +<h3>Methods inherited from class javafx.scene.Node</h3> +<code>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</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="BASE_TEXT_STYLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BASE_TEXT_STYLE</h4> +<pre>public static final java.lang.String BASE_TEXT_STYLE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#jcgp.gui.settings.parameters.GUIParameter.BASE_TEXT_STYLE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="BASE_CHECKBOX_STYLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BASE_CHECKBOX_STYLE</h4> +<pre>public static final java.lang.String BASE_CHECKBOX_STYLE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#jcgp.gui.settings.parameters.GUIParameter.BASE_CHECKBOX_STYLE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="INVALID_PARAMETER_STYLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INVALID_PARAMETER_STYLE</h4> +<pre>public static final java.lang.String INVALID_PARAMETER_STYLE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#jcgp.gui.settings.parameters.GUIParameter.INVALID_PARAMETER_STYLE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="WARNING_PARAMETER_STYLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WARNING_PARAMETER_STYLE</h4> +<pre>public static final java.lang.String WARNING_PARAMETER_STYLE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#jcgp.gui.settings.parameters.GUIParameter.WARNING_PARAMETER_STYLE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="VALID_PARAMETER_STYLE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>VALID_PARAMETER_STYLE</h4> +<pre>public static final java.lang.String VALID_PARAMETER_STYLE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#jcgp.gui.settings.parameters.GUIParameter.VALID_PARAMETER_STYLE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create-jcgp.backend.parameters.Parameter-jcgp.gui.settings.SettingsPane-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a><?> create(<a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a><?> parameter, + <a href="../../../../jcgp/gui/settings/SettingsPane.html" title="class in jcgp.gui.settings">SettingsPane</a> sp)</pre> +<div class="block">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.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parameter</code> - a parameter for which to generate a @code{GUIParameter}.</dd> +<dd><code>sp</code> - a reference to the @code{SettingsPane}.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an appropriate instance of @code{GUIParameter}.</dd> +</dl> +</li> +</ul> +<a name="isValid--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isValid</h4> +<pre>public boolean isValid()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the current value of the parameter does not prevent the + experiment from running.</dd> +</dl> +</li> +</ul> +<a name="validate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validate</h4> +<pre>public void validate()</pre> +<div class="block">Force the parameter to validate its current value, and apply the associated + style to the @code{GUIParameter}.</div> +</li> +</ul> +<a name="requiresReset--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresReset</h4> +<pre>public boolean requiresReset()</pre> +<div class="block">Certain parameter changes might require the experiment to be reset, either + because the parameter is critical or because its status requires a reset.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if an experiment reset is required due to this parameter changing.</dd> +</dl> +</li> +</ul> +<a name="applyValue--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>applyValue</h4> +<pre>public void applyValue()</pre> +<div class="block">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.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GUIParameter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../jcgp/gui/settings/parameters/GUIIntegerParameter.html" title="class in jcgp.gui.settings.parameters"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?jcgp/gui/settings/parameters/GUIParameter.html" target="_top">Frames</a></li> +<li><a href="GUIParameter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |