changeset 7976:7f04dcd38b16

[SCENEBUILDER]Fix for DTL-6848: Kit javadoc for com.oracle.javafx.scenebuilder.kit.editor.panel.css deserves some filtering
author Jerome Cambon
date Thu, 04 Sep 2014 15:59:55 +0200
parents 21adc0871793
children e43736c57ec8
files apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssContentMaker.java apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssPanelController.java apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssUtils.java apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssValueConverter.java apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssValuePresenterFactory.java apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/NodeCssState.java apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/SelectionPath.java
diffstat 7 files changed, 120 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssContentMaker.java	Thu Sep 04 14:51:49 2014 +0200
+++ b/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssContentMaker.java	Thu Sep 04 15:59:55 2014 +0200
@@ -57,6 +57,7 @@
 /**
  * This class construct the model exposed by the CSS Panel.
  *
+ * @treatAsPrivate
  */
 public class CssContentMaker {
 
@@ -387,10 +388,11 @@
 //        System.out.println("--> css url = " + style.getDeclaration().getRule().getStylesheet().getUrl());
 //    }
 
-    /*
+    /**
      *
-     * Public classes
+     * Public classes.
      *
+     * @treatAsPrivate
      */
     public static abstract class PropertyState implements Comparable<PropertyState> {
 
@@ -445,6 +447,10 @@
         }
     }
 
+/**
+ *
+ * @treatAsPrivate
+ */
     public static class BeanPropertyState extends PropertyState {
 
         PropertyMetadata propMeta;
@@ -473,6 +479,10 @@
         }
     }
 
+/**
+ *
+ * @treatAsPrivate
+ */
     public static class CssPropertyState extends PropertyState {
 
         protected final StyleableProperty<?> value;
@@ -503,6 +513,10 @@
             return value.getValue();
         }
 
+        /**
+         *
+         * @treatAsPrivate
+         */
         public static class CssStyle {
 
             private final Style style;
@@ -592,10 +606,11 @@
         }
     }
 
-    /*
+    /**
      *
-     * Private classes
+     * Private classes.
      *
+     * @treatAsPrivate
      */
     protected static class CssSubPropertyState extends CssPropertyState {
 
--- a/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssPanelController.java	Thu Sep 04 14:51:49 2014 +0200
+++ b/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssPanelController.java	Thu Sep 04 15:59:55 2014 +0200
@@ -177,8 +177,10 @@
     private final Delegate applicationDelegate;
     private final ObjectProperty<NodeCssState> cssStateProperty = new SimpleObjectProperty<>();
 
-    /*
-     * Should be implemented by the application
+    /**
+     * Should be implemented by the application.
+     *
+     * @treatAsPrivate
      */
     public static abstract class Delegate {
 
@@ -228,8 +230,9 @@
         }
     }
 
-    /*
-     * AbstractFxmlPanelController
+    /**
+     * AbstractFxmlPanelController.
+     *
      */
     @Override
     protected void controllerDidLoadFxml() {
@@ -395,18 +398,36 @@
         searchPatternDidChange();
     }
 
+    /**
+     * 
+     * @param selectionListener selection listener.
+     * @treatAsPrivate
+     */
     public void addSelectionListener(ChangeListener<Item> selectionListener) {
         selectionPath.selected().addListener(selectionListener);
     }
 
+    /**
+     * 
+     * @param path path.
+     * @treatAsPrivate
+     */
     public void setSelectionPath(Path path) {
         selectionPath.setSelectionPath(path);
     }
 
+    /**
+     * @treatAsPrivate
+     */
     public void resetSelectionPath() {
         selectionPath.setSelectionPath(new Path(new ArrayList<>()));
     }
 
+    /**
+     * 
+     * @param mess message.
+     * @treatAsPrivate
+     */
     public void viewMessage(String mess) {
         root.getChildren().removeAll(messagePane, header, table, rulesPane, textPane);
 //        mainMenu.setDisable(true);
@@ -415,20 +436,40 @@
         root.getChildren().add(messagePane);
     }
 
+    /**
+     *
+     * @return node.
+     * @treatAsPrivate
+     */
     public final Node getRulesPane() {
         return rulesPane;
     }
 
+    /**
+     *
+     * @return node.
+     * @treatAsPrivate
+     */
     public final Node getTextPane() {
         return textPane;
     }
 
+    /**
+     *
+     * @param model model.
+     * @param state state.
+     * @treatAsPrivate
+     */
     public void setContent(ObservableList<CssProperty> model, NodeCssState state) {
         changeView(currentView);
         initializeRulesTextPanes(state);
         this.model = FXCollections.observableArrayList(model);
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     public void clearContent() {
         table.getItems().clear();
         resetSelectionPath();
@@ -452,6 +493,15 @@
         updateTable(filtered);
     }
 
+    /**
+     *
+     * @param parent parent.
+     * @param cssProp css property.
+     * @param style css style.
+     * @param applied applied.
+     * @param isLookup lookup.
+     * @treatAsPrivate
+     */
     public static void attachStyleProperty(TreeItem<Node> parent, CssPropertyState cssProp, CssStyle style,
             boolean applied, boolean isLookup) {
         if (isLookup) {
@@ -484,6 +534,10 @@
         currentView = view;
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     public void copyStyleablePath() {
         final ClipboardContent content = new ClipboardContent();
         content.putString(selectionPath.toString());
@@ -528,8 +582,9 @@
 
     /*
      *
-     * FXML methods
+     * FXML methods.
      *
+     * @treatAsPrivate
      */
     public void initialize() {
 
@@ -1651,6 +1706,14 @@
         }
     }
 
+    /**
+     *
+     * @param component component.
+     * @param css css property state.
+     * @param lookupRoot root css style.
+     * @param parent parent.
+     * @treatAsPrivate
+     */
     public static void attachLookupStyles(Object component, CssPropertyState css, CssStyle lookupRoot, TreeItem<Node> parent) {
         // Some lookup that comes from the SB itself, skip them.
         // This is expected, these lookups are superceeded by the 
@@ -1724,6 +1787,10 @@
         }
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     public void copyRules() {
         CopyHandler.copy(rulesTree);
     }
--- a/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssUtils.java	Thu Sep 04 14:51:49 2014 +0200
+++ b/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssUtils.java	Thu Sep 04 15:59:55 2014 +0200
@@ -50,6 +50,7 @@
 /**
  * CSS support for Scene Builder.
  *
+ * @treatAsPrivate
  */
 public class CssUtils {
 
--- a/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssValueConverter.java	Thu Sep 04 14:51:49 2014 +0200
+++ b/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssValueConverter.java	Thu Sep 04 15:59:55 2014 +0200
@@ -69,6 +69,7 @@
 
 /**
  *
+ * @treatAsPrivate
  */
 public class CssValueConverter {
 
--- a/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssValuePresenterFactory.java	Thu Sep 04 14:51:49 2014 +0200
+++ b/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/CssValuePresenterFactory.java	Thu Sep 04 15:59:55 2014 +0200
@@ -41,6 +41,7 @@
 
 /**
  *
+ * @treatAsPrivate
  */
 public class CssValuePresenterFactory {
 
--- a/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/NodeCssState.java	Thu Sep 04 14:51:49 2014 +0200
+++ b/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/NodeCssState.java	Thu Sep 04 15:59:55 2014 +0200
@@ -59,6 +59,7 @@
 
 /**
  *
+ * @treatAsPrivate
  */
 public class NodeCssState {
 
@@ -95,6 +96,10 @@
         getAllStyleables();
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     @SuppressWarnings("rawtypes")
     public static class CssProperty implements Comparable<CssProperty> {
 
@@ -415,6 +420,10 @@
         return userAgent;
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     public static class RuleComparator implements Comparator<MatchingRule> {
 
         @Override
@@ -451,6 +460,10 @@
         return count;
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     public static class MatchingRule {
 
         private final Rule rule;
@@ -500,6 +513,10 @@
         }
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     public static class MatchingDeclaration {
 
         private final CssContentMaker.CssPropertyState.CssStyle style;
--- a/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/SelectionPath.java	Thu Sep 04 14:51:49 2014 +0200
+++ b/apps/scenebuilder/SceneBuilderKit/src/com/oracle/javafx/scenebuilder/kit/editor/panel/css/SelectionPath.java	Thu Sep 04 15:59:55 2014 +0200
@@ -51,6 +51,7 @@
 /**
  * CSS panel selection path handling.
  *
+ * @treatAsPrivate
  */
 // TODO : should have its UI defined in an fxml file.
 public class SelectionPath extends HBox {
@@ -261,6 +262,10 @@
         }
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     public static class Item {
 
         private final Object item;
@@ -303,6 +308,10 @@
         }
     }
 
+    /**
+     *
+     * @treatAsPrivate
+     */
     public static class Path {
 
         private final List<Item> items;