From 8189116ea4b5db4675e31dfd04a5687d55e29262 Mon Sep 17 00:00:00 2001 From: Eduardo Pedroni Date: Tue, 6 May 2014 14:29:37 +0100 Subject: Added javadocs, made minor changes to the comments --- doc/jcgp/gui/console/GUIConsole.html | 458 +++++++++++++++++++++++++ doc/jcgp/gui/console/class-use/GUIConsole.html | 124 +++++++ doc/jcgp/gui/console/package-frame.html | 20 ++ doc/jcgp/gui/console/package-summary.html | 144 ++++++++ doc/jcgp/gui/console/package-tree.html | 157 +++++++++ doc/jcgp/gui/console/package-use.html | 124 +++++++ 6 files changed, 1027 insertions(+) create mode 100644 doc/jcgp/gui/console/GUIConsole.html create mode 100644 doc/jcgp/gui/console/class-use/GUIConsole.html create mode 100644 doc/jcgp/gui/console/package-frame.html create mode 100644 doc/jcgp/gui/console/package-summary.html create mode 100644 doc/jcgp/gui/console/package-tree.html create mode 100644 doc/jcgp/gui/console/package-use.html (limited to 'doc/jcgp/gui/console') diff --git a/doc/jcgp/gui/console/GUIConsole.html b/doc/jcgp/gui/console/GUIConsole.html new file mode 100644 index 0000000..7737d5e --- /dev/null +++ b/doc/jcgp/gui/console/GUIConsole.html @@ -0,0 +1,458 @@ + + + + + +GUIConsole + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
jcgp.gui.console
+

Class GUIConsole

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    javafx.css.Styleable, javafx.event.EventTarget, Console
    +
    +
    +
    +
    public class GUIConsole
+extends javafx.scene.layout.AnchorPane
+implements Console
    +
    Console pane used by the GUI to display CGP output messages. + This class realises Console. It consists of a JavaFX + TextArea and a StringBuffer. The buffer is filled + as print messages are queued. Calling flush() writes the + contents of the buffer to the TextArea and empties the buffer.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    See Also:
    +
    Console
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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
      GUIConsole() +
      Creates a new instance of this class.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidflush() +
      Outputs all buffered messages to the console.
      +
      voidprint(java.lang.String s) +
      Prints a string without line break at the end (unless the string + itself specifies one).
      +
      voidprintln(java.lang.String s) +
      Prints a string and automatically adds a line break at the end.
      +
      +
        +
      • + + +

        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

      + + + +
        +
      • +

        GUIConsole

        +
        public GUIConsole()
        +
        Creates a new instance of this class.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        println

        +
        public void println(java.lang.String s)
        +
        Description copied from interface: Console
        +
        Prints a string and automatically adds a line break at the end.
        +
        +
        Specified by:
        +
        println in interface Console
        +
        Parameters:
        +
        s - the string to print.
        +
        +
        • +
      + + + +
        +
      • +

        print

        +
        public void print(java.lang.String s)
        +
        Description copied from interface: Console
        +
        Prints a string without line break at the end (unless the string + itself specifies one).
        +
        +
        Specified by:
        +
        print in interface Console
        +
        Parameters:
        +
        s - the string to print.
        +
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
        +
        Description copied from interface: Console
        +
        Outputs all buffered messages to the console. Only necessary + if concurrent accesses must be avoided.
        +
        +
        Specified by:
        +
        flush in interface Console
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/jcgp/gui/console/class-use/GUIConsole.html b/doc/jcgp/gui/console/class-use/GUIConsole.html new file mode 100644 index 0000000..180634c --- /dev/null +++ b/doc/jcgp/gui/console/class-use/GUIConsole.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.gui.console.GUIConsole + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
jcgp.gui.console.GUIConsole

+
+
No usage of jcgp.gui.console.GUIConsole
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/gui/console/package-frame.html b/doc/jcgp/gui/console/package-frame.html new file mode 100644 index 0000000..05d367d --- /dev/null +++ b/doc/jcgp/gui/console/package-frame.html @@ -0,0 +1,20 @@ + + + + + +jcgp.gui.console + + + + + +

jcgp.gui.console

+
+

Classes

+ +
+ + diff --git a/doc/jcgp/gui/console/package-summary.html b/doc/jcgp/gui/console/package-summary.html new file mode 100644 index 0000000..220f8cf --- /dev/null +++ b/doc/jcgp/gui/console/package-summary.html @@ -0,0 +1,144 @@ + + + + + +jcgp.gui.console + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package jcgp.gui.console

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/gui/console/package-tree.html b/doc/jcgp/gui/console/package-tree.html new file mode 100644 index 0000000..068223e --- /dev/null +++ b/doc/jcgp/gui/console/package-tree.html @@ -0,0 +1,157 @@ + + + + + +jcgp.gui.console Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package jcgp.gui.console

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/gui/console/package-use.html b/doc/jcgp/gui/console/package-use.html new file mode 100644 index 0000000..f419778 --- /dev/null +++ b/doc/jcgp/gui/console/package-use.html @@ -0,0 +1,124 @@ + + + + + +Uses of Package jcgp.gui.console + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
jcgp.gui.console

+
+
No usage of jcgp.gui.console
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3