You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by gb...@apache.org on 2010/03/02 14:48:35 UTC

svn commit: r918035 - in /pivot/trunk/wtk/src/org/apache/pivot/wtk: ./ text/

Author: gbrown
Date: Tue Mar  2 13:48:34 2010
New Revision: 918035

URL: http://svn.apache.org/viewvc?rev=918035&view=rev
Log:
Deprecate org.apache.pivot.wtk.text package.

Modified:
    pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Block.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedList.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Document.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNode.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNodeListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/List.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedList.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Paragraph.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/PlainTextSerializer.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Span.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/package.html

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java Tue Mar  2 13:48:34 2010
@@ -214,10 +214,26 @@
         super.setSkin(skin);
     }
 
+    /**
+     * Returns the document that backs the text area.
+     *
+     * @deprecated
+     * This method will be removed in a future release. Callers should use
+     * {@link #getText()} instead.
+     */
     public Document getDocument() {
         return document;
     }
 
+    /**
+     * Sets the document that backs the text area.
+     *
+     * @param document
+     *
+     * @deprecated
+     * This method will be removed in a future release. Callers should use
+     * {@link #setText(String)} instead.
+     */
     public void setDocument(Document document) {
         Document previousDocument = this.document;
 

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java Tue Mar  2 13:48:34 2010
@@ -44,6 +44,9 @@
      *
      * @param textArea
      * @param previousDocument
+     *
+     * @deprecated
+     * This method will be removed in a future release.
      */
     public void documentChanged(TextArea textArea, Document previousDocument);
 

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java Tue Mar  2 13:48:34 2010
@@ -262,10 +262,26 @@
         super.setSkin(skin);
     }
 
+    /**
+     * Returns the text node that backs the text input's content.
+     *
+     * @deprecated
+     * This method will be removed in a future release. Callers should use
+     * {@link #getText()} instead.
+     */
     public TextNode getTextNode() {
         return textNode;
     }
 
+    /**
+     * Sets the text node that backs the text input's content.
+     *
+     * @param textNode
+     *
+     * @deprecated
+     * This method will be removed in a future release. Callers should use
+     * {@link #setText(String)} instead.
+     */
     public void setTextNode(TextNode textNode) {
         if (textNode != null
             && textNode.getCharacterCount() > maximumLength) {
@@ -747,9 +763,10 @@
             && JSONSerializer.containsKey(context, textKey)) {
             Object value = JSONSerializer.get(context, textKey);
 
-            if (textBindMapping == null
-                && value != null) {
-                value = value.toString();
+            if (textBindMapping == null) {
+                if (value != null) {
+                    value = value.toString();
+                }
             } else {
                 value = textBindMapping.toString(value);
             }

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java Tue Mar  2 13:48:34 2010
@@ -66,8 +66,12 @@
 
     /**
      * Called when a text input's text node has changed.
+     *
      * @param textInput
      * @param previousTextNode
+     *
+     * @deprecated
+     * This method will be removed in a future release.
      */
     public void textNodeChanged(TextInput textInput, TextNode previousTextNode);
 

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Block.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Block.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Block.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Block.java Tue Mar  2 13:48:34 2010
@@ -20,6 +20,9 @@
  * Abstract base class for block elements.
  * <p>
  * TODO Add horizontal alignment, margin, and line spacing properties.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public abstract class Block extends Element {
     public Block() {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedList.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedList.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedList.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedList.java Tue Mar  2 13:48:34 2010
@@ -18,6 +18,9 @@
 
 /**
  * Element representing a bulleted list.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public class BulletedList extends List {
     /**

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Document.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Document.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Document.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Document.java Tue Mar  2 13:48:34 2010
@@ -18,6 +18,9 @@
 
 /**
  * Node representing the root of an element hierarchy.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public class Document extends Block {
     public Document() {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java Tue Mar  2 13:48:34 2010
@@ -29,6 +29,9 @@
  * TODO Add style properties.
  * <p>
  * TODO Add style class property.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public abstract class Element extends Node
     implements Sequence<Node>, Iterable<Node> {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java Tue Mar  2 13:48:34 2010
@@ -20,6 +20,9 @@
 
 /**
  * Element listener interface.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public interface ElementListener {
     /**

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNode.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNode.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNode.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNode.java Tue Mar  2 13:48:34 2010
@@ -29,6 +29,9 @@
  * Node representing an image.
  * <p>
  * TODO Add a URL setter for the image property.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public class ImageNode extends Node {
     private static class ImageNodeListenerList extends ListenerList<ImageNodeListener>

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNodeListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNodeListener.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNodeListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ImageNodeListener.java Tue Mar  2 13:48:34 2010
@@ -20,6 +20,9 @@
 
 /**
  * Image node listener interface.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public interface ImageNodeListener {
     public void imageChanged(ImageNode imageNode, Image previousImage);

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/List.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/List.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/List.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/List.java Tue Mar  2 13:48:34 2010
@@ -20,6 +20,9 @@
  * Abstract base class for list elements.
  * <p>
  * TODO Add indent and item spacing properties.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public abstract class List extends Block {
     /**

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java Tue Mar  2 13:48:34 2010
@@ -20,7 +20,10 @@
 
 /**
  * Abstract base class for document nodes.
- */
+ *
+ * @deprecated
+ * This class will be removed in a future release.
+*/
 public abstract class Node {
     private static class NodeListenerList extends ListenerList<NodeListener>
         implements NodeListener {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java Tue Mar  2 13:48:34 2010
@@ -18,6 +18,9 @@
 
 /**
  * Node listener interface.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public interface NodeListener {
     /**

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedList.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedList.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedList.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedList.java Tue Mar  2 13:48:34 2010
@@ -18,6 +18,9 @@
 
 /**
  * Element representing a numbered list.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public class NumberedList extends List {
     /**

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Paragraph.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Paragraph.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Paragraph.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Paragraph.java Tue Mar  2 13:48:34 2010
@@ -23,6 +23,9 @@
  * Element representing a paragraph.
  * <p>
  * TODO Add indent property.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public class Paragraph extends Block {
     public Paragraph() {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/PlainTextSerializer.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/PlainTextSerializer.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/PlainTextSerializer.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/PlainTextSerializer.java Tue Mar  2 13:48:34 2010
@@ -34,6 +34,9 @@
 /**
  * Implementation of the {@link Serializer} interface that reads and writes
  * a plain text document.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public class PlainTextSerializer implements Serializer<Document> {
     private Charset charset = null;

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Span.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Span.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Span.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Span.java Tue Mar  2 13:48:34 2010
@@ -20,6 +20,9 @@
  * Element representing an inline range of styled characters.
  * <p>
  * TODO Add text alignment enum/property.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public class Span extends Element {
     public Span() {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java Tue Mar  2 13:48:34 2010
@@ -22,6 +22,9 @@
 
 /**
  * Node representing a sequence of characters.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public final class TextNode extends Node {
     private class TextNodeCharacterIterator implements CharacterIterator {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java Tue Mar  2 13:48:34 2010
@@ -18,6 +18,9 @@
 
 /**
  * Text node listener interface.
+ *
+ * @deprecated
+ * This class will be removed in a future release.
  */
 public interface TextNodeListener {
     /**

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/package.html
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/package.html?rev=918035&r1=918034&r2=918035&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/package.html (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/package.html Tue Mar  2 13:48:34 2010
@@ -19,5 +19,7 @@
 <head></head>
 <body>
 <p>Contains classes representing a text object model.</p>
+<p><b>NOTE</b> This package has been deprecated and will be removed in a
+future release.</p>
 </body>
 </html>