trim-whitespace
git-svn-id: https://svn.apache.org/repos/asf/pivot/trunk@1529353 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/charts/src/org/apache/pivot/charts/ChartView.java b/charts/src/org/apache/pivot/charts/ChartView.java
index e2f3411..3da60f0 100644
--- a/charts/src/org/apache/pivot/charts/ChartView.java
+++ b/charts/src/org/apache/pivot/charts/ChartView.java
@@ -115,7 +115,7 @@
/**
* Returns the element's series index.
- *
+ *
* @return The element's series index.
*/
public int getSeriesIndex() {
@@ -127,7 +127,7 @@
* the element index represents the index of the category in the
* category sequence. Otherwise, it represents the index of the item
* within the series.
- *
+ *
* @return The element index.
*/
public int getElementIndex() {
diff --git a/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java b/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java
index d7382b0..77de0eb 100644
--- a/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java
+++ b/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java
@@ -24,7 +24,7 @@
public interface ChartViewCategoryListener {
/**
* Fired when a category is inserted into a chart view.
- *
+ *
* @param chartView
* @param index
*/
@@ -32,7 +32,7 @@
/**
* Fired when a category is removed from a chart view.
- *
+ *
* @param chartView
* @param index
* @param categories
@@ -42,7 +42,7 @@
/**
* Fired when a chart view's category key changes.
- *
+ *
* @param chartView
* @param index
* @param previousKey
@@ -51,7 +51,7 @@
/**
* Fired when a chart view's category label changes.
- *
+ *
* @param chartView
* @param index
* @param previousLabel
diff --git a/charts/src/org/apache/pivot/charts/ChartViewListener.java b/charts/src/org/apache/pivot/charts/ChartViewListener.java
index b11ef65..29ae695 100644
--- a/charts/src/org/apache/pivot/charts/ChartViewListener.java
+++ b/charts/src/org/apache/pivot/charts/ChartViewListener.java
@@ -24,7 +24,7 @@
public interface ChartViewListener {
/**
* Fired when a chart view's data changes.
- *
+ *
* @param chartView
* @param previousChartData
*/
@@ -32,7 +32,7 @@
/**
* Fired when a chart view's series name key changes.
- *
+ *
* @param chartView
* @param previousSeriesNameKey
*/
@@ -40,7 +40,7 @@
/**
* Fired when a chart view's title changes.
- *
+ *
* @param chartView
* @param previousTitle
*/
@@ -48,7 +48,7 @@
/**
* Fired when a chart view's horizontal axis label changes.
- *
+ *
* @param chartView
* @param previousHorizontalAxisLabel
*/
@@ -56,7 +56,7 @@
/**
* Fired when a chart view's vertical axis label changes.
- *
+ *
* @param chartView
* @param previousVerticalAxisLabel
*/
@@ -64,7 +64,7 @@
/**
* Fired when a chart view's "show legend" flag changes.
- *
+ *
* @param chartView
*/
public void showLegendChanged(ChartView chartView);
diff --git a/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java b/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java
index d4c482a..87afdcc 100644
--- a/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java
+++ b/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java
@@ -22,7 +22,7 @@
public interface ChartViewSeriesListener {
/**
* Fired when a series is inserted into a chart view's data set.
- *
+ *
* @param chartView
* @param index
*/
@@ -30,7 +30,7 @@
/**
* Fired when a series is removed from a chart view's data set.
- *
+ *
* @param chartView
* @param index
* @param count
@@ -39,14 +39,14 @@
/**
* Fired when a chart view's series data is cleared.
- *
+ *
* @param chartView
*/
public void seriesCleared(ChartView chartView);
/**
* Fired when a series is updated in a chart view's data set.
- *
+ *
* @param chartView
* @param index
*/
@@ -54,7 +54,7 @@
/**
* Fired when a chart view's series data is sorted.
- *
+ *
* @param chartView
*/
public void seriesSorted(ChartView chartView);
diff --git a/core/src/org/apache/pivot/beans/BXMLSerializer.java b/core/src/org/apache/pivot/beans/BXMLSerializer.java
index cf31f6b..990d77a 100644
--- a/core/src/org/apache/pivot/beans/BXMLSerializer.java
+++ b/core/src/org/apache/pivot/beans/BXMLSerializer.java
@@ -399,7 +399,7 @@
* properties via a call to {@link #setLocation(URL)} or
* {@link #setResources(Resources)}, respectively, before calling this
* method.
- *
+ *
* @return The deserialized object hierarchy.
*/
@Override
@@ -536,7 +536,7 @@
/**
* Deserializes an object hierarchy from a BXML resource.
- *
+ *
* @see #readObject(Class, String, boolean)
*/
public final Object readObject(Class<?> baseType, String resourceName) throws IOException,
@@ -550,7 +550,7 @@
* {@link Class#getResource(String)} on the given base type, passing the
* given resource name as an argument. If the resources is localized, the
* base type is also used as the base name of the resource bundle.
- *
+ *
* @param baseType The base type.
* @param resourceName The name of the BXML resource.
* @param localize If <tt>true</tt>, the deserialized resource will be
@@ -583,7 +583,7 @@
* use this version of the method to load BXML that uses resource resolution
* must manually set this property via a call to
* {@link #setResources(Resources)} before calling this method.
- *
+ *
* @param locationArgument The location of the BXML resource.
* @see #readObject(URL, Resources)
*/
@@ -593,7 +593,7 @@
/**
* Deserializes an object hierarchy from a BXML resource.
- *
+ *
* @param locationArgument The location of the BXML resource.
* @param resourcesArgument The resources that will be used to localize the
* deserialized resource. #see readObject(InputStream)
@@ -1437,7 +1437,7 @@
/**
* Retrieves the root of the object hierarchy most recently processed by
* this serializer.
- *
+ *
* @return The root object, or <tt>null</tt> if this serializer has not yet
* read an object from an input stream.
*/
@@ -1481,7 +1481,7 @@
/**
* Applies BXML binding annotations to an object.
- *
+ *
* @param object
* @see #bind(Object, Class)
*/
@@ -1497,7 +1497,7 @@
* Applies BXML binding annotations to an object. <p> NOTE This method uses
* reflection to set internal member variables. As a result, it may only be
* called from trusted code.
- *
+ *
* @param object
* @param type
* @throws BindException If an error occurs during binding
@@ -1558,7 +1558,7 @@
* implementation simply calls {@code Class.newInstance()}. Subclasses may
* override this method to provide an alternate instantiation mechanism,
* such as dependency-injected construction.
- *
+ *
* @param type The type of serializer being requested.
*/
protected Serializer<?> newIncludeSerializer(Class<? extends Serializer<?>> type)
@@ -1571,7 +1571,7 @@
* base implementation simply calls {@code Class.newInstance()}. Subclasses
* may override this method to provide an alternate instantiation mechanism,
* such as dependency-injected construction.
- *
+ *
* @param type The type of object being requested.
*/
protected Object newTypedObject(Class<?> type) throws InstantiationException,
@@ -1607,7 +1607,7 @@
* Returns the file extension/MIME type map. This map associates file
* extensions with MIME types, which are used to automatically determine an
* appropriate serializer to use for an include based on file extension.
- *
+ *
* @see #getMimeTypes()
*/
public static Map<String, String> getFileExtensions() {
diff --git a/core/src/org/apache/pivot/beans/BeanAdapter.java b/core/src/org/apache/pivot/beans/BeanAdapter.java
index ac8e317..77e009e 100644
--- a/core/src/org/apache/pivot/beans/BeanAdapter.java
+++ b/core/src/org/apache/pivot/beans/BeanAdapter.java
@@ -159,7 +159,7 @@
/**
* Creates a new bean dictionary.
- *
+ *
* @param bean The bean object to wrap.
*/
public BeanAdapter(Object bean) {
@@ -170,7 +170,7 @@
* Creates a new bean dictionary which can ignore readonly fields (that is,
* straight fields marked as <code>final</code> or bean properties where
* there is a "get" method but no corresponding "set" method).
- *
+ *
* @param bean The bean object to wrap.
*/
public BeanAdapter(Object bean, boolean ignoreReadOnlyProperties) {
@@ -184,7 +184,7 @@
/**
* Returns the bean object this dictionary wraps.
- *
+ *
* @return The bean object, or <tt>null</tt> if no bean has been set.
*/
public Object getBean() {
@@ -193,7 +193,7 @@
/**
* Invokes the getter method for the given property.
- *
+ *
* @param key The property name.
* @return The value returned by the method, or <tt>null</tt> if no such
* method exists.
@@ -244,7 +244,7 @@
* Invokes the setter method for the given property. The method signature is
* determined by the type of the value. If the value is <tt>null</tt>, the
* return type of the getter method is used.
- *
+ *
* @param key The property name.
* @param value The new property value.
* @return Returns <tt>null</tt>, since returning the previous value would
@@ -328,7 +328,7 @@
* in the map. The method signatures are determined by the type of the
* values. If any value is <tt>null</tt>, the return type of the getter
* method is used.
- *
+ *
* @param valueMap The map of keys and values to be set.
* @throws PropertyNotFoundException If any of the given properties do not
* exist or are read-only.
@@ -346,7 +346,7 @@
* method is used. There is an option to ignore (that is, not throw)
* exceptions during the process, but to return status if any exceptions
* were caught and ignored.
- *
+ *
* @param valueMap The map of keys and values to be set.
* @param ignoreErrors If <code>true</code> then any
* {@link PropertyNotFoundException} thrown by the {@link #put put()} method
@@ -387,7 +387,7 @@
/**
* Verifies the existence of a property. The property must have a getter
* method; write-only properties are not supported.
- *
+ *
* @param key The property name.
* @return <tt>true</tt> if the property exists; <tt>false</tt>, otherwise.
*/
@@ -441,7 +441,7 @@
/**
* Tests the read-only state of a property.
- *
+ *
* @param key The property name.
* @return <tt>true</tt> if the property is read-only; <tt>false</tt>,
* otherwise.
@@ -452,7 +452,7 @@
/**
* Returns the type of a property.
- *
+ *
* @param key The property name.
* @see #getType(Class, String)
*/
@@ -462,7 +462,7 @@
/**
* Returns the generic type of a property.
- *
+ *
* @param key The property name.
* @see #getGenericType(Class, String)
*/
@@ -472,7 +472,7 @@
/**
* Returns an iterator over the bean's properties.
- *
+ *
* @return A property iterator for this bean.
*/
@Override
@@ -487,7 +487,7 @@
/**
* Returns the getter method for a property.
- *
+ *
* @param key The property name.
* @return The getter method, or <tt>null</tt> if the method does not exist.
*/
@@ -497,7 +497,7 @@
/**
* Returns the setter method for a property.
- *
+ *
* @param key The property name.
* @return The getter method, or <tt>null</tt> if the method does not exist.
*/
@@ -508,7 +508,7 @@
/**
* Returns the public, non-static field for a property. Note that fields
* will only be consulted for bean properties after bean methods.
- *
+ *
* @param fieldName The property name
* @return The field, or <tt>null</tt> if the field does not exist, or is
* non-public or static
@@ -525,7 +525,7 @@
* Tests the read-only state of a property. Note that if no such property
* exists, this method will return <tt>true</tt> (it will <u>not</u> throw
* an exception).
- *
+ *
* @param beanClass The bean class.
* @param key The property name.
* @return <tt>true</tt> if the property is read-only; <tt>false</tt>,
@@ -562,7 +562,7 @@
/**
* Returns the type of a property.
- *
+ *
* @param beanClass The bean class.
* @param key The property name.
* @return The type of the property, or <tt>null</tt> if no such bean
@@ -600,7 +600,7 @@
/**
* Returns the generic type of a property.
- *
+ *
* @param beanClass The bean class.
* @param key The property name.
* @return The generic type of the property, or <tt>null</tt> if no such bean
@@ -641,7 +641,7 @@
/**
* Returns the public, non-static fields for a property. Note that fields
* will only be consulted for bean properties after bean methods.
- *
+ *
* @param beanClass The bean class.
* @param key The property name.
* @return The field, or <tt>null</tt> if the field does not exist, or is
@@ -680,7 +680,7 @@
/**
* Returns the getter method for a property.
- *
+ *
* @param beanClass The bean class.
* @param key The property name.
* @return The getter method, or <tt>null</tt> if the method does not exist.
@@ -721,7 +721,7 @@
/**
* Returns the setter method for a property.
- *
+ *
* @param beanClass The bean class.
* @param key The property name.
* @return The getter method, or <tt>null</tt> if the method does not exist.
@@ -798,7 +798,7 @@
/**
* Coerces a value to a given type.
- *
+ *
* @param value
* @param type
* @return The coerced value.
diff --git a/core/src/org/apache/pivot/beans/BeanMonitor.java b/core/src/org/apache/pivot/beans/BeanMonitor.java
index bdd999e..e85058f 100644
--- a/core/src/org/apache/pivot/beans/BeanMonitor.java
+++ b/core/src/org/apache/pivot/beans/BeanMonitor.java
@@ -151,7 +151,7 @@
/**
* Tests whether a property fires change events.
- *
+ *
* @param key The property name.
* @return <tt>true</tt> if the property fires change events; <tt>false</tt>
* otherwise.
diff --git a/core/src/org/apache/pivot/beans/Bindable.java b/core/src/org/apache/pivot/beans/Bindable.java
index 9914353..5dc38f7 100644
--- a/core/src/org/apache/pivot/beans/Bindable.java
+++ b/core/src/org/apache/pivot/beans/Bindable.java
@@ -29,7 +29,7 @@
/**
* Called to initialize the class after it has been completely processed and
* bound by the serializer.
- *
+ *
* @param namespace The serializer's namespace. The bindable object can use
* this to extract named values defined in the BXML file. Alternatively, the
* {@link BXML} annotation can be used by trusted code to automatically map
diff --git a/core/src/org/apache/pivot/beans/NamespaceBinding.java b/core/src/org/apache/pivot/beans/NamespaceBinding.java
index 6f926cc..d25258a 100644
--- a/core/src/org/apache/pivot/beans/NamespaceBinding.java
+++ b/core/src/org/apache/pivot/beans/NamespaceBinding.java
@@ -33,7 +33,7 @@
public interface BindMapping {
/**
* Transforms a source value during a bind operation.
- *
+ *
* @param value
*/
public Object evaluate(Object value);
@@ -200,7 +200,7 @@
/**
* Returns the bind mapping.
- *
+ *
* @return The bind mapping to use during binding, or <tt>null</tt> if no
* bind mapping is specified.
*/
diff --git a/core/src/org/apache/pivot/beans/PropertyChangeListener.java b/core/src/org/apache/pivot/beans/PropertyChangeListener.java
index 06e2968..338e65d 100644
--- a/core/src/org/apache/pivot/beans/PropertyChangeListener.java
+++ b/core/src/org/apache/pivot/beans/PropertyChangeListener.java
@@ -22,7 +22,7 @@
public interface PropertyChangeListener {
/**
* Called when a Java bean property has changed.
- *
+ *
* @param bean
* @param propertyName
*/
diff --git a/core/src/org/apache/pivot/beans/Resolvable.java b/core/src/org/apache/pivot/beans/Resolvable.java
index ca07439..61883b0 100644
--- a/core/src/org/apache/pivot/beans/Resolvable.java
+++ b/core/src/org/apache/pivot/beans/Resolvable.java
@@ -33,7 +33,7 @@
/**
* Sets the serializer's namespace. This is used for variable resolution.
- *
+ *
* @param namespace
*/
public void setNamespace(Map<String, Object> namespace);
@@ -45,7 +45,7 @@
/**
* Sets the serializer's location. This is used for URL resolution.
- *
+ *
* @param location
*/
public void setLocation(URL location);
@@ -58,7 +58,7 @@
/**
* Sets the serializer's resource bundle. This is used for resource
* resolution.
- *
+ *
* @param resources
*/
public void setResources(Resources resources);
diff --git a/core/src/org/apache/pivot/collections/Collection.java b/core/src/org/apache/pivot/collections/Collection.java
index c55ddfa..ccac78f 100644
--- a/core/src/org/apache/pivot/collections/Collection.java
+++ b/core/src/org/apache/pivot/collections/Collection.java
@@ -30,7 +30,7 @@
/**
* Tests the emptiness of the collection.
- *
+ *
* @return <tt>true</tt> if the collection contains no elements;
* <tt>false</tt>, otherwise.
*/
@@ -38,7 +38,7 @@
/**
* Returns the collection's sort order.
- *
+ *
* @return The comparator used to order elements in the collection, or
* <tt>null</tt> if the sort order is undefined.
* @see #setComparator(Comparator)
@@ -50,7 +50,7 @@
* and ensuring that new entries preserve the sort order. <p> Calling this
* method more than once with the same comparator will re-sort the
* collection.
- *
+ *
* @param comparator The comparator used to order elements in the
* collection, or null if the collection is unsorted.
*/
diff --git a/core/src/org/apache/pivot/collections/Dictionary.java b/core/src/org/apache/pivot/collections/Dictionary.java
index 48617ff..b3fc167 100644
--- a/core/src/org/apache/pivot/collections/Dictionary.java
+++ b/core/src/org/apache/pivot/collections/Dictionary.java
@@ -66,7 +66,7 @@
/**
* Retrieves the value for the given key.
- *
+ *
* @param key The key whose value is to be returned.
* @return The value corresponding to <tt>key</tt>, or null if the key does
* not exist. Will also return null if the key refers to a null value. Use
@@ -77,7 +77,7 @@
/**
* Sets the value of the given key, creating a new entry or replacing the
* existing value.
- *
+ *
* @param key The key whose value is to be set.
* @param value The value to be associated with the given key.
* @return The value previously associated with the key.
@@ -86,7 +86,7 @@
/**
* Removes a key/value pair from the map.
- *
+ *
* @param key The key whose mapping is to be removed.
* @return The value that was removed.
*/
@@ -94,7 +94,7 @@
/**
* Tests the existence of a key in the dictionary.
- *
+ *
* @param key The key whose presence in the dictionary is to be tested.
* @return <tt>true</tt> if the key exists in the dictionary; <tt>false</tt>,
* otherwise.
diff --git a/core/src/org/apache/pivot/collections/Group.java b/core/src/org/apache/pivot/collections/Group.java
index 22d7750..8ae4e72 100644
--- a/core/src/org/apache/pivot/collections/Group.java
+++ b/core/src/org/apache/pivot/collections/Group.java
@@ -22,7 +22,7 @@
public interface Group<E> {
/**
* Adds an element to the group.
- *
+ *
* @param element The element to add to the group.
* @return <tt>true</tt> if the element was added to the group;
* <tt>false</tt>, otherwise.
@@ -31,7 +31,7 @@
/**
* Removes an element from the group.
- *
+ *
* @param element The element to remove from the set.
* @return <tt>true</tt> if the element was removed from the group;
* <tt>false</tt>, otherwise.
@@ -40,7 +40,7 @@
/**
* Tests the existence of an element in the group.
- *
+ *
* @param element The element whose presence in the group is to be tested.
* @return <tt>true</tt> if the element exists in the group; <tt>false</tt>,
* otherwise.
diff --git a/core/src/org/apache/pivot/collections/HashMap.java b/core/src/org/apache/pivot/collections/HashMap.java
index c6c350f..70db94e 100644
--- a/core/src/org/apache/pivot/collections/HashMap.java
+++ b/core/src/org/apache/pivot/collections/HashMap.java
@@ -146,7 +146,7 @@
/**
* {@inheritDoc}
- *
+ *
* @throws IllegalArgumentException If {@code key} is {@literal null}.
*/
@Override
@@ -175,7 +175,7 @@
/**
* {@inheritDoc}
- *
+ *
* @throws IllegalArgumentException If {@code key} is {@literal null}.
*/
@Override
@@ -239,7 +239,7 @@
/**
* {@inheritDoc}
- *
+ *
* @throws IllegalArgumentException If {@code key} is {@literal null}.
*/
@Override
@@ -305,7 +305,7 @@
/**
* {@inheritDoc}
- *
+ *
* @throws IllegalArgumentException If {@code key} is {@literal null}.
*/
@Override
diff --git a/core/src/org/apache/pivot/collections/List.java b/core/src/org/apache/pivot/collections/List.java
index e235833..fd65bfa 100644
--- a/core/src/org/apache/pivot/collections/List.java
+++ b/core/src/org/apache/pivot/collections/List.java
@@ -87,7 +87,7 @@
* Adds an item to the list. If the list is unsorted, the item is appended
* to the end of the list. Otherwise, it is inserted at the appropriate
* index.
- *
+ *
* @see org.apache.pivot.collections.ListListener#itemInserted(List, int)
* @return The index at which the item was added.
*/
@@ -96,7 +96,7 @@
/**
* Inserts an item into the list.
- *
+ *
* @param item The item to be added to the list.
* @param index The index at which the item should be inserted. Must be a
* value between <tt>0</tt> and <tt>getLength()</tt>.
@@ -109,7 +109,7 @@
/**
* Updates the item at the given index.
- *
+ *
* @param index The index of the item to update.
* @param item The item that will replace any existing value at the given
* index.
@@ -134,7 +134,7 @@
/**
* Returns the length of the list.
- *
+ *
* @return The number of items in the list, or -1 if the list's length is
* not known. In this case, the iterator must be used to retrieve the
* contents of the list.
diff --git a/core/src/org/apache/pivot/collections/ListListener.java b/core/src/org/apache/pivot/collections/ListListener.java
index 7633e79..6734968 100644
--- a/core/src/org/apache/pivot/collections/ListListener.java
+++ b/core/src/org/apache/pivot/collections/ListListener.java
@@ -54,7 +54,7 @@
/**
* Called when an item has been inserted into a list.
- *
+ *
* @param list The source of the list event.
* @param index The index at which the item was added.
*/
@@ -62,7 +62,7 @@
/**
* Called when items have been removed from a list.
- *
+ *
* @param list The source of the list event.
* @param index The starting index from which items have been removed.
* @param items The items that were removed from the list.
@@ -71,7 +71,7 @@
/**
* Called when a list item has been updated.
- *
+ *
* @param list The source of the list event.
* @param index The index of the item that was updated.
* @param previousItem The item that was previously stored at <tt>index</tt>.
@@ -80,14 +80,14 @@
/**
* Called when list data has been reset.
- *
+ *
* @param list The source of the list event.
*/
public void listCleared(List<T> list);
/**
* Called when a list's comparator has changed.
- *
+ *
* @param list The source of the event.
* @param previousComparator The previous comparator value.
*/
diff --git a/core/src/org/apache/pivot/collections/Map.java b/core/src/org/apache/pivot/collections/Map.java
index a29dbfb..db66e2c 100644
--- a/core/src/org/apache/pivot/collections/Map.java
+++ b/core/src/org/apache/pivot/collections/Map.java
@@ -68,7 +68,7 @@
/**
* Sets the value of the given key, creating a new entry or replacing the
* existing value, and firing a corresponding event.
- *
+ *
* @param key The key whose value is to be set.
* @param value The value to be associated with the given key.
* @see MapListener#valueAdded(Map, Object)
@@ -85,7 +85,7 @@
/**
* Removes all entries in the map.
- *
+ *
* @see MapListener#mapCleared(Map)
*/
@Override
diff --git a/core/src/org/apache/pivot/collections/MapListener.java b/core/src/org/apache/pivot/collections/MapListener.java
index 1986838..91f762b 100644
--- a/core/src/org/apache/pivot/collections/MapListener.java
+++ b/core/src/org/apache/pivot/collections/MapListener.java
@@ -54,7 +54,7 @@
/**
* Called when a key/value pair has been added to a map.
- *
+ *
* @param map The source of the map event.
* @param key The key that was added to the map.
*/
@@ -62,7 +62,7 @@
/**
* Called when a map value has been updated.
- *
+ *
* @param map The source of the map event.
* @param key The key whose value was updated.
* @param previousValue The value that was previously associated with the
@@ -72,7 +72,7 @@
/**
* Called when a key/value pair has been removed from a map.
- *
+ *
* @param map The source of the map event.
* @param key The key that was removed.
* @param value The value that was removed.
@@ -81,14 +81,14 @@
/**
* Called when map data has been reset.
- *
+ *
* @param map The source of the map event.
*/
public void mapCleared(Map<K, V> map);
/**
* Called when a map's comparator has changed.
- *
+ *
* @param map The source of the event.
* @param previousComparator The previous comparator value.
*/
diff --git a/core/src/org/apache/pivot/collections/Queue.java b/core/src/org/apache/pivot/collections/Queue.java
index 23d920e..fe2af1f 100644
--- a/core/src/org/apache/pivot/collections/Queue.java
+++ b/core/src/org/apache/pivot/collections/Queue.java
@@ -63,7 +63,7 @@
* Enqueues an item. If the queue is unsorted, the item is added at the tail
* of the queue (index <tt>0</tt>). Otherwise, it is inserted at the
* appropriate index.
- *
+ *
* @param item The item to add to the queue.
*/
public void enqueue(T item);
@@ -85,7 +85,7 @@
/**
* Tests the emptiness of the queue.
- *
+ *
* @return <tt>true</tt> if the queue contains no items; <tt>false</tt>,
* otherwise.
*/
diff --git a/core/src/org/apache/pivot/collections/QueueListener.java b/core/src/org/apache/pivot/collections/QueueListener.java
index 0d67453..9a97385 100644
--- a/core/src/org/apache/pivot/collections/QueueListener.java
+++ b/core/src/org/apache/pivot/collections/QueueListener.java
@@ -49,7 +49,7 @@
/**
* Called when an item has been inserted into the tail of a queue.
- *
+ *
* @param queue
* @param item
*/
@@ -57,7 +57,7 @@
/**
* Called when an item has been removed from the head of a queue.
- *
+ *
* @param queue
* @param item
*/
@@ -65,14 +65,14 @@
/**
* Called when a queue has been cleared.
- *
+ *
* @param queue
*/
public void queueCleared(Queue<T> queue);
/**
* Called when a queue's comparator has changed.
- *
+ *
* @param queue
* @param previousComparator
*/
diff --git a/core/src/org/apache/pivot/collections/Sequence.java b/core/src/org/apache/pivot/collections/Sequence.java
index 49d0619..887f5f0 100644
--- a/core/src/org/apache/pivot/collections/Sequence.java
+++ b/core/src/org/apache/pivot/collections/Sequence.java
@@ -28,7 +28,7 @@
/**
* Collection of static utility methods providing path access to nested
* sequence data.
- *
+ *
* @param <T> note that in Tree the type parameter currently it's not used
*/
public static class Tree<T> {
@@ -174,7 +174,7 @@
/**
* Gets the path within the nested sequence to the item most
* recently returned by a call to <tt>next()</tt>.
- *
+ *
* @return The path (from the root sequence) to the current item.
* @throws IllegalStateException If <tt>next()</tt> has not yet been
* called on this iterator.
@@ -267,7 +267,7 @@
/**
* Adds an item to a nested sequence.
- *
+ *
* @param sequence The root sequence.
* @param item The item to be added to the sequence.
* @param path The path of the sequence to which the item should be
@@ -282,7 +282,7 @@
/**
* Inserts an item into a nested sequence.
- *
+ *
* @param sequence The root sequence.
* @param item The item to be inserted into the sequence.
* @param path The path of the sequence into which the item should be
@@ -297,7 +297,7 @@
/**
* Updates an item in a nested sequence.
- *
+ *
* @param sequence The root sequence.
* @param path The path of the item to update.
* @param item The item that will replace any existing value at the given
@@ -325,7 +325,7 @@
/**
* Removes the first occurrence of an item from a nested sequence.
- *
+ *
* @param sequence The root sequence.
* @param item The item to remove.
* @return The path of the item that was removed.
@@ -343,7 +343,7 @@
/**
* Removes an item from a nested sequence.
- *
+ *
* @param sequence The root sequence.
* @param path The path of the item to remove.
*/
@@ -368,7 +368,7 @@
/**
* Retrieves an item from a nested sequence.
- *
+ *
* @param sequence The root sequence.
* @param path The path of the item to retrieve.
* @return The item at the given path, or <tt>null</tt> if the path is
@@ -402,7 +402,7 @@
/**
* Returns the path to an item in a nested sequence.
- *
+ *
* @param sequence The root sequence.
* @param item The item to locate.
* @return The path of first occurrence of the item if it exists in the
@@ -451,7 +451,7 @@
/**
* Determines whether the path represented by the second argument is a
* descendant of the path represented by the first argument.
- *
+ *
* @param ancestorPath The ancestor path to test.
* @param descendantPath The descendant path to test.
*/
@@ -479,7 +479,7 @@
/**
* Adds an item to the sequence.
- *
+ *
* @param item The item to be added to the sequence.
* @return The index at which the item was added, or <tt>-1</tt> if the item
* was not added to the sequence.
@@ -488,7 +488,7 @@
/**
* Inserts an item into the sequence at a specific index.
- *
+ *
* @param item The item to be added to the sequence.
* @param index The index at which the item should be inserted. Must be a
* value between <tt>0</tt> and <tt>getLength()</tt>.
@@ -497,7 +497,7 @@
/**
* Updates the item at the given index.
- *
+ *
* @param index The index of the item to update.
* @param item The item that will replace any existing value at the given
* index.
@@ -507,7 +507,7 @@
/**
* Removes the first occurrence of the given item from the sequence.
- *
+ *
* @param item The item to remove.
* @return The index of the item that was removed, or <tt>-1</tt> if the item
* could not be found.
@@ -517,7 +517,7 @@
/**
* Removes one or more items from the sequence.
- *
+ *
* @param index The starting index to remove.
* @param count The number of items to remove, beginning with <tt>index</tt>.
* @return A sequence containing the items that were removed.
@@ -526,14 +526,14 @@
/**
* Retrieves the item at the given index.
- *
+ *
* @param index The index of the item to retrieve.
*/
public T get(int index);
/**
* Returns the index of an item in the sequence.
- *
+ *
* @param item The item to locate.
* @return The index of first occurrence of the item if it exists in the
* sequence; <tt>-1</tt>, otherwise.
@@ -542,7 +542,7 @@
/**
* Returns the length of the sequence.
- *
+ *
* @return The number of items in the sequence.
*/
public int getLength();
diff --git a/core/src/org/apache/pivot/collections/SetListener.java b/core/src/org/apache/pivot/collections/SetListener.java
index 07df3bc..46b145a 100644
--- a/core/src/org/apache/pivot/collections/SetListener.java
+++ b/core/src/org/apache/pivot/collections/SetListener.java
@@ -49,7 +49,7 @@
/**
* Called when an element is added to a set.
- *
+ *
* @param set The source of the set event.
* @param element The element that was added to the set.
*/
@@ -57,7 +57,7 @@
/**
* Called when an element is removed from the set.
- *
+ *
* @param set The source of the set event.
* @param element The element that was removed from the set.
*/
@@ -65,14 +65,14 @@
/**
* Called when set data has been reset.
- *
+ *
* @param set The source of the set event.
*/
public void setCleared(Set<E> set);
/**
* Called when a set's comparator has changed.
- *
+ *
* @param set The source of the event.
* @param previousComparator The previous comparator value.
*/
diff --git a/core/src/org/apache/pivot/collections/Stack.java b/core/src/org/apache/pivot/collections/Stack.java
index 85b0821..d314ebb 100644
--- a/core/src/org/apache/pivot/collections/Stack.java
+++ b/core/src/org/apache/pivot/collections/Stack.java
@@ -63,14 +63,14 @@
* "Pushes" an item onto the stack. If the stack is unsorted, the item is
* added at the top of the stack (<tt>getLength()</tt>). Otherwise, it is
* inserted at the appropriate index.
- *
+ *
* @param item The item to push onto the stack.
*/
public void push(T item);
/**
* Removes the top item from the stack and returns it.
- *
+ *
* @throws IllegalStateException If the stack contains no items.
*/
public T pop();
@@ -85,7 +85,7 @@
/**
* Tests the emptiness of the stack.
- *
+ *
* @return <tt>true</tt> if the stack contains no items; <tt>false</tt>,
* otherwise.
*/
diff --git a/core/src/org/apache/pivot/collections/StackListener.java b/core/src/org/apache/pivot/collections/StackListener.java
index 21fa8ca..7fe4870 100644
--- a/core/src/org/apache/pivot/collections/StackListener.java
+++ b/core/src/org/apache/pivot/collections/StackListener.java
@@ -49,7 +49,7 @@
/**
* Called when an item has been pushed onto a stack.
- *
+ *
* @param stack
* @param item
*/
@@ -57,7 +57,7 @@
/**
* Called when an item has been popped off of a stack.
- *
+ *
* @param stack
* @param item
*/
@@ -65,14 +65,14 @@
/**
* Called when a stack has been cleared.
- *
+ *
* @param stack
*/
public void stackCleared(Stack<T> stack);
/**
* Called when a stack's comparator has changed.
- *
+ *
* @param stack
* @param previousComparator
*/
diff --git a/core/src/org/apache/pivot/io/FileSerializer.java b/core/src/org/apache/pivot/io/FileSerializer.java
index 02cf1f5..aa30b75 100644
--- a/core/src/org/apache/pivot/io/FileSerializer.java
+++ b/core/src/org/apache/pivot/io/FileSerializer.java
@@ -52,7 +52,7 @@
/**
* Creates a new file serializer that will store temporary files in a
* specific directory.
- *
+ *
* @param tempFileDirectory The directory in which to store temporary
* folders.
*/
diff --git a/core/src/org/apache/pivot/json/JSON.java b/core/src/org/apache/pivot/json/JSON.java
index 3d21055..725d1e6 100644
--- a/core/src/org/apache/pivot/json/JSON.java
+++ b/core/src/org/apache/pivot/json/JSON.java
@@ -37,7 +37,7 @@
public class JSON {
/**
* Returns the value at a given path.
- *
+ *
* @param root The root object.
* @param path The path to the value as a JavaScript path.
* @return The value at the given path.
@@ -50,7 +50,7 @@
/**
* Returns the value at a given path.
- *
+ *
* @param root The root object.
* @param keys The path to the value as a sequence of keys.
* @return The value at the given path.
@@ -122,7 +122,7 @@
/**
* Sets the value at the given path.
- *
+ *
* @param root
* @param path
* @param value
@@ -168,7 +168,7 @@
/**
* Removes the value at the given path.
- *
+ *
* @param root
* @param path
* @return The value that was removed.
@@ -206,7 +206,7 @@
/**
* Tests the existence of a path in a given object.
- *
+ *
* @param root
* @param path
* @return <tt>true</tt> if the path exists; <tt>false</tt>, otherwise.
@@ -253,7 +253,7 @@
/**
* Parses a JSON path into a sequence of string keys.
- *
+ *
* @param path
*/
public static Sequence<String> parse(String path) {
diff --git a/core/src/org/apache/pivot/json/JSONSerializer.java b/core/src/org/apache/pivot/json/JSONSerializer.java
index 4f795e4..97c9190 100644
--- a/core/src/org/apache/pivot/json/JSONSerializer.java
+++ b/core/src/org/apache/pivot/json/JSONSerializer.java
@@ -184,7 +184,7 @@
/**
* Sets a flag indicating that map keys should always be quote-delimited.
- *
+ *
* @param alwaysDelimitMapKeys <tt>true</tt> to bound map keys in double
* quotes; <tt>false</tt> to only quote-delimit keys as necessary.
*/
@@ -202,7 +202,7 @@
/**
* Sets the serializer's verbosity flag. When verbosity is enabled, all data
* read or written will be echoed to the console.
- *
+ *
* @param verbose
*/
public void setVerbose(boolean verbose) {
@@ -211,7 +211,7 @@
/**
* Reads data from a JSON stream.
- *
+ *
* @param inputStream The input stream from which data will be read.
* @see #readObject(Reader)
*/
@@ -232,7 +232,7 @@
/**
* Reads data from a JSON stream.
- *
+ *
* @param reader The reader from which data will be read.
* @return One of the following types, depending on the content of the stream
* and the value of {@link #getType()}: <ul>
@@ -814,7 +814,7 @@
/**
* Writes data to a JSON stream.
- *
+ *
* @param object
* @param outputStream The output stream to which data will be written.
* @see #writeObject(Object, Writer)
@@ -838,7 +838,7 @@
/**
* Writes data to a JSON stream.
- *
+ *
* @param object The object to serialize. Must be one of the following
* types: <ul> <li>pivot.collections.Map</li>
* <li>pivot.collections.List</li> <li>java.lang.String</li>
@@ -992,7 +992,7 @@
/**
* Converts a JSON value to a Java object.
- *
+ *
* @param json The JSON value.
* @return The parsed object.
*/
@@ -1011,7 +1011,7 @@
/**
* Converts a JSON value to a string.
- *
+ *
* @param json The JSON value.
* @return The parsed string.
*/
@@ -1021,7 +1021,7 @@
/**
* Converts a JSON value to a number.
- *
+ *
* @param json The JSON value.
* @return The parsed number.
*/
@@ -1031,7 +1031,7 @@
/**
* Converts a JSON value to a short.
- *
+ *
* @param json The JSON value.
* @return The parsed short.
*/
@@ -1041,7 +1041,7 @@
/**
* Converts a JSON value to a integer.
- *
+ *
* @param json The JSON value.
* @return The parsed integer.
*/
@@ -1051,7 +1051,7 @@
/**
* Converts a JSON value to a long.
- *
+ *
* @param json The JSON value.
* @return The parsed number.
*/
@@ -1061,7 +1061,7 @@
/**
* Converts a JSON value to a float.
- *
+ *
* @param json The JSON value.
* @return The parsed float.
*/
@@ -1071,7 +1071,7 @@
/**
* Converts a JSON value to a double.
- *
+ *
* @param json The JSON value.
* @return The parsed double.
*/
@@ -1081,7 +1081,7 @@
/**
* Converts a JSON value to a boolean.
- *
+ *
* @param json The JSON value.
* @return The parsed boolean.
*/
@@ -1091,7 +1091,7 @@
/**
* Converts a JSON value to a list.
- *
+ *
* @param json The JSON value.
* @return The parsed list.
*/
@@ -1101,7 +1101,7 @@
/**
* Converts a JSON value to a map.
- *
+ *
* @param json The JSON value.
* @return The parsed map.
*/
@@ -1113,7 +1113,7 @@
/**
* Converts a object to a JSON string representation. The map keys will
* always be quote-delimited.
- *
+ *
* @param value The object to convert.
* @return The resulting JSON string.
* @see #toString(Object, boolean)
@@ -1124,7 +1124,7 @@
/**
* Converts a object to a JSON string representation.
- *
+ *
* @param value The object to convert.
* @param alwaysDelimitMapKeys A flag indicating whether or not map keys will
* always be quote-delimited.
diff --git a/core/src/org/apache/pivot/json/JSONSerializerListener.java b/core/src/org/apache/pivot/json/JSONSerializerListener.java
index 0a42c19..3dd373e 100644
--- a/core/src/org/apache/pivot/json/JSONSerializerListener.java
+++ b/core/src/org/apache/pivot/json/JSONSerializerListener.java
@@ -75,7 +75,7 @@
/**
* Called when the serializer has begun reading a dictionary value.
- *
+ *
* @param jsonSerializer
* @param value
*/
@@ -83,14 +83,14 @@
/**
* Called when the serializer has finished reading a dictionary value.
- *
+ *
* @param jsonSerializer
*/
public void endDictionary(JSONSerializer jsonSerializer);
/**
* Called when the serializer has read a dictionary key.
- *
+ *
* @param jsonSerializer
* @param key
*/
@@ -98,7 +98,7 @@
/**
* Called when the serializer has begun reading a sequence value.
- *
+ *
* @param jsonSerializer
* @param value
*/
@@ -106,14 +106,14 @@
/**
* Called when the serializer has finished reading a sequence value.
- *
+ *
* @param jsonSerializer
*/
public void endSequence(JSONSerializer jsonSerializer);
/**
* Called when the serializer has read a string value.
- *
+ *
* @param jsonSerializer
* @param value
*/
@@ -121,7 +121,7 @@
/**
* Called when the serializer has read a numeric value.
- *
+ *
* @param jsonSerializer
* @param value
*/
@@ -129,7 +129,7 @@
/**
* Called when the serializer has read a boolean value.
- *
+ *
* @param jsonSerializer
* @param value
*/
@@ -137,7 +137,7 @@
/**
* Called when the serializer has read a null value.
- *
+ *
* @param jsonSerializer
*/
public void readNull(JSONSerializer jsonSerializer);
diff --git a/core/src/org/apache/pivot/serialization/ByteArraySerializer.java b/core/src/org/apache/pivot/serialization/ByteArraySerializer.java
index f344561..89115ec 100644
--- a/core/src/org/apache/pivot/serialization/ByteArraySerializer.java
+++ b/core/src/org/apache/pivot/serialization/ByteArraySerializer.java
@@ -26,7 +26,7 @@
/**
* Implementation of the {@link Serializer} interface that reads and writes a
* byte array.
- *
+ *
* @see Serializer
*/
public class ByteArraySerializer implements Serializer<byte[]> {
diff --git a/core/src/org/apache/pivot/serialization/CSVSerializer.java b/core/src/org/apache/pivot/serialization/CSVSerializer.java
index a9bd1c1..6641ef1 100644
--- a/core/src/org/apache/pivot/serialization/CSVSerializer.java
+++ b/core/src/org/apache/pivot/serialization/CSVSerializer.java
@@ -138,7 +138,7 @@
/**
* Sets the keys that will be read or written by this serializer.
- *
+ *
* @param keys
*/
public void setKeys(Sequence<String> keys) {
@@ -151,7 +151,7 @@
/**
* Sets the keys that will be read or written by this serializer.
- *
+ *
* @param keys
*/
public void setKeys(String... keys) {
@@ -171,7 +171,7 @@
/**
* Sets the serializer's write keys flag.
- *
+ *
* @param writeKeys If <tt>true</tt>, the first line of the output will
* contain the keys. Otherwise, the first line will contain the first line
* of data.
@@ -190,7 +190,7 @@
/**
* Sets the serializer's verbosity flag. When verbosity is enabled, all data
* read or written will be echoed to the console.
- *
+ *
* @param verbose
*/
public void setVerbose(boolean verbose) {
@@ -199,7 +199,7 @@
/**
* Reads values from a comma-separated value stream.
- *
+ *
* @param inputStream The input stream from which data will be read.
* @see #readObject(Reader)
*/
@@ -220,7 +220,7 @@
/**
* Reads values from a comma-separated value stream.
- *
+ *
* @param reader The reader from which data will be read.
* @return A list containing the data read from the CSV file. The list items
* are instances of Dictionary<String, Object> populated by mapping columns
@@ -420,7 +420,7 @@
/**
* Writes values to a comma-separated value stream.
- *
+ *
* @param items
* @param outputStream The output stream to which data will be written.
* @see #writeObject(List, Writer)
@@ -448,7 +448,7 @@
/**
* Writes values to a comma-separated value stream.
- *
+ *
* @param items A list containing the data to write to the CSV file. List
* items must be instances of Dictionary<String, Object>. The dictionary
* values will be written out in the order specified by the key sequence.
diff --git a/core/src/org/apache/pivot/serialization/CSVSerializerListener.java b/core/src/org/apache/pivot/serialization/CSVSerializerListener.java
index d149466..b17d518 100644
--- a/core/src/org/apache/pivot/serialization/CSVSerializerListener.java
+++ b/core/src/org/apache/pivot/serialization/CSVSerializerListener.java
@@ -44,7 +44,7 @@
/**
* Called when the serializer has begun reading the list.
- *
+ *
* @param csvSerializer
* @param list
*/
@@ -52,14 +52,14 @@
/**
* Called when the serializer has finished reading the list.
- *
+ *
* @param csvSerializer
*/
public void endList(CSVSerializer csvSerializer);
/**
* Called when the serializer has read an item.
- *
+ *
* @param csvSerializer
* @param item
*/
diff --git a/core/src/org/apache/pivot/serialization/PropertiesSerializer.java b/core/src/org/apache/pivot/serialization/PropertiesSerializer.java
index fff2c68..9bde838 100644
--- a/core/src/org/apache/pivot/serialization/PropertiesSerializer.java
+++ b/core/src/org/apache/pivot/serialization/PropertiesSerializer.java
@@ -34,7 +34,7 @@
/**
* Reads data from a properties stream.
- *
+ *
* @param inputStream The input stream from which data will be read.
* @return An instance of {@link Map} containing the data read from the
* properties file. Both keys and values are strings.
@@ -53,7 +53,7 @@
/**
* Writes data to a properties stream.
- *
+ *
* @param object An instance of {@link Map} containing the data to be
* written to the properties file. Keys must be strings, and values will be
* converted to strings.
diff --git a/core/src/org/apache/pivot/serialization/Serializer.java b/core/src/org/apache/pivot/serialization/Serializer.java
index a179fe9..20ff01a 100644
--- a/core/src/org/apache/pivot/serialization/Serializer.java
+++ b/core/src/org/apache/pivot/serialization/Serializer.java
@@ -23,13 +23,13 @@
/**
* Defines an interface for writing objects to and reading objects from a data
* stream.
- *
+ *
* @param <T> The type of data being read and written.
*/
public interface Serializer<T> {
/**
* Reads an object from an input stream.
- *
+ *
* @param inputStream The data stream from which the object will be read.
* @return The deserialized object.
*/
@@ -37,7 +37,7 @@
/**
* Writes an object to an output stream.
- *
+ *
* @param object The object to serialize.
* @param outputStream The data stream to which the object will be written.
*/
@@ -46,7 +46,7 @@
/**
* Returns the MIME type of the data read and written by this serializer.
- *
+ *
* @param object If provided, allows the serializer to attach parameters to
* the returned MIME type containing more detailed information about the
* data. If <tt>null</tt>, the base MIME type is returned.
diff --git a/core/src/org/apache/pivot/serialization/StringSerializer.java b/core/src/org/apache/pivot/serialization/StringSerializer.java
index 9a2c140..709893b 100644
--- a/core/src/org/apache/pivot/serialization/StringSerializer.java
+++ b/core/src/org/apache/pivot/serialization/StringSerializer.java
@@ -54,7 +54,7 @@
/**
* Reads plain text data from an input stream.
- *
+ *
* @param inputStream The input stream from which data will be read.
* @return An instance of {@link String} containing the text read from the
* input stream.
@@ -89,7 +89,7 @@
/**
* Writes plain text data to an output stream.
- *
+ *
* @param text The text to be written to the output stream.
* @param outputStream The output stream to which data will be written.
*/
diff --git a/core/src/org/apache/pivot/text/FileSizeFormat.java b/core/src/org/apache/pivot/text/FileSizeFormat.java
index 2255b74..c8e8302 100644
--- a/core/src/org/apache/pivot/text/FileSizeFormat.java
+++ b/core/src/org/apache/pivot/text/FileSizeFormat.java
@@ -38,7 +38,7 @@
/**
* Formats a file size.
- *
+ *
* @param object A <tt>Number</tt> containing the length of the file, in
* bytes. May be negative to indicate an unknown file size.
* @param stringBuffer The string buffer to which the formatted output will
@@ -76,7 +76,7 @@
/**
* This method is not supported.
- *
+ *
* @throws UnsupportedOperationException
*/
@Override
@@ -86,7 +86,7 @@
/**
* Returns a shared file size format instance.
- *
+ *
* @return A shared file format size instance.
*/
public static FileSizeFormat getInstance() {
diff --git a/core/src/org/apache/pivot/util/Base64.java b/core/src/org/apache/pivot/util/Base64.java
index ec18edc..66c0cae 100644
--- a/core/src/org/apache/pivot/util/Base64.java
+++ b/core/src/org/apache/pivot/util/Base64.java
@@ -73,7 +73,7 @@
/**
* Encodes the specified data into a base64 string.
- *
+ *
* @param bytes The unencoded raw data.
*/
public static String encode(byte[] bytes) {
@@ -101,7 +101,7 @@
/**
* Decodes the specified base64 string back into its raw data.
- *
+ *
* @param encoded The base64 encoded string.
*/
public static byte[] decode(String encoded) {
diff --git a/core/src/org/apache/pivot/util/CalendarDate.java b/core/src/org/apache/pivot/util/CalendarDate.java
index 566bc52..92f08a0 100644
--- a/core/src/org/apache/pivot/util/CalendarDate.java
+++ b/core/src/org/apache/pivot/util/CalendarDate.java
@@ -208,7 +208,7 @@
* Creates a new <tt>CalendarDate</tt> representing the day contained in the
* specified Gregorian calendar (assuming the default locale and the default
* timezone).
- *
+ *
* @param calendar The calendar containing the year, month, and day fields.
*/
public CalendarDate(GregorianCalendar calendar) {
@@ -219,7 +219,7 @@
/**
* Creates a new <tt>CalendarDate</tt> representing the specified year,
* month, and day of month.
- *
+ *
* @param year The year field. (e.g. <tt>2008</tt>)
* @param month The month field, 0-based. (e.g. <tt>2</tt> for March)
* @param day The day of the month, 0-based. (e.g. <tt>14</tt> for the 15th)
@@ -256,7 +256,7 @@
* formally, it is defined that given calendar dates <tt>c1</tt> and
* <tt>c2</tt>, the following will return <tt>true</tt>: <pre>
* c1.add(c2.subtract(c1)).equals(c2); </pre>
- *
+ *
* @param days The number of days to add to (or subtract from if negative)
* this calendar date.
* @return The resulting calendar date.
@@ -276,7 +276,7 @@
* difference will be zero. <p> More formally, it is defined that given
* calendar dates <tt>c1</tt> and <tt>c2</tt>, the following will return
* <tt>true</tt>: <pre> c1.add(c2.subtract(c1)).equals(c2); </pre>
- *
+ *
* @param calendarDate The calendar date to subtract from this calendar
* date.
* @return The number of days in between this calendar date and
@@ -297,7 +297,7 @@
* <tt>GregorianCalendar</tt>, with the <tt>year</tt>, <tt>month</tt>, and
* <tt>dayOfMonth</tt> fields set in the default time zone with the default
* locale.
- *
+ *
* @return This calendar date as a <tt>GregorianCalendar</tt>.
*/
public GregorianCalendar toCalendar() {
@@ -309,7 +309,7 @@
* <tt>GregorianCalendar</tt>, with the <tt>year</tt>, <tt>month</tt>, and
* <tt>dayOfMonth</tt> fields set in the default time zone with the default
* locale.
- *
+ *
* @param time The time of day.
* @return This calendar date as a <tt>GregorianCalendar</tt>.
*/
@@ -323,7 +323,7 @@
/**
* Compares this calendar date with another calendar date.
- *
+ *
* @param calendarDate The calendar date against which to compare.
* @return A negative number, zero, or a positive number if the specified
* calendar date is less than, equal to, or greater than this calendar date,
@@ -348,7 +348,7 @@
* Indicates whether some other object is "equal to" this one. This is the
* case if the object is a calendar date that represents the same day as
* this one.
- *
+ *
* @param o Reference to the object against which to compare.
*/
@Override
@@ -398,7 +398,7 @@
* Creates a new date representing the specified date string. The date
* string must be in the <tt>ISO 8601</tt> "calendar date" format, which is
* <tt>[YYYY]-[MM]-[DD]</tt>.
- *
+ *
* @param value A string in the form of <tt>[YYYY]-[MM]-[DD]</tt> (e.g.
* 2008-07-23).
*/
diff --git a/core/src/org/apache/pivot/util/Filter.java b/core/src/org/apache/pivot/util/Filter.java
index f81c741..acb50a7 100644
--- a/core/src/org/apache/pivot/util/Filter.java
+++ b/core/src/org/apache/pivot/util/Filter.java
@@ -22,7 +22,7 @@
public interface Filter<T> {
/**
* Determines item inclusion.
- *
+ *
* @param item The item to test for inclusion.
* @return <tt>true</tt> if the item should be included; <tt>false</tt>,
* otherwise.
diff --git a/core/src/org/apache/pivot/util/ListenerList.java b/core/src/org/apache/pivot/util/ListenerList.java
index 0f6ba15..2a701b2 100644
--- a/core/src/org/apache/pivot/util/ListenerList.java
+++ b/core/src/org/apache/pivot/util/ListenerList.java
@@ -68,7 +68,7 @@
/**
* Adds a listener to the list, if it has not previously been added.
- *
+ *
* @param listener
*/
public void add(T listener) {
@@ -87,7 +87,7 @@
/**
* Removes a listener from the list, if it has previously been added.
- *
+ *
* @param listener
*/
public void remove(T listener) {
@@ -121,7 +121,7 @@
/**
* Tests the existence of a listener in the list.
- *
+ *
* @param listener
* @return <tt>true</tt> if the listener exists in the list; <tt>false</tt>,
* otherwise.
@@ -132,7 +132,7 @@
/**
* Tests the emptiness of the list.
- *
+ *
* @return <tt>true</tt> if the list contains no listeners; <tt>false</tt>,
* otherwise.
*/
@@ -142,7 +142,7 @@
/**
* Get the number of elements in the list.
- *
+ *
* @return the number of elements.
*/
public int getLength() {
diff --git a/core/src/org/apache/pivot/util/MessageBus.java b/core/src/org/apache/pivot/util/MessageBus.java
index e5cf3d1..ec88d08 100644
--- a/core/src/org/apache/pivot/util/MessageBus.java
+++ b/core/src/org/apache/pivot/util/MessageBus.java
@@ -26,7 +26,7 @@
/**
* Subscribes a listener to a message topic.
- *
+ *
* @param topic
* @param messageListener
*/
@@ -45,7 +45,7 @@
/**
* Unsubscribe a listener from a message topic.
- *
+ *
* @param topic
* @param messageListener
*/
@@ -64,7 +64,7 @@
/**
* Sends a message to subscribed topic listeners.
- *
+ *
* @param message
*/
@SuppressWarnings("unchecked")
diff --git a/core/src/org/apache/pivot/util/MessageBusListener.java b/core/src/org/apache/pivot/util/MessageBusListener.java
index dab370f..60e7291 100644
--- a/core/src/org/apache/pivot/util/MessageBusListener.java
+++ b/core/src/org/apache/pivot/util/MessageBusListener.java
@@ -23,7 +23,7 @@
/**
* Called when a message has been sent via
* {@link MessageBus#sendMessage(Object)}.
- *
+ *
* @param message
*/
public void messageSent(T message);
diff --git a/core/src/org/apache/pivot/util/Resources.java b/core/src/org/apache/pivot/util/Resources.java
index 8c50405..8694026 100644
--- a/core/src/org/apache/pivot/util/Resources.java
+++ b/core/src/org/apache/pivot/util/Resources.java
@@ -69,7 +69,7 @@
/**
* Creates a new resource bundle.
- *
+ *
* @param parent The parent resource defer to if a resource cannot be found
* in this instance or null.
* @param baseName The base name of this resource as a fully qualified class
diff --git a/core/src/org/apache/pivot/util/Service.java b/core/src/org/apache/pivot/util/Service.java
index 5ae712e..184a2ea 100644
--- a/core/src/org/apache/pivot/util/Service.java
+++ b/core/src/org/apache/pivot/util/Service.java
@@ -27,7 +27,7 @@
public class Service {
/**
* Attempts to load a service provider.
- *
+ *
* @param providerName The name of the provider to load. The method first
* looks for a system property with this name. The value of the property is
* expected to be the name of a class that implements the expected provider
diff --git a/core/src/org/apache/pivot/util/Time.java b/core/src/org/apache/pivot/util/Time.java
index 1311f84..695eece 100644
--- a/core/src/org/apache/pivot/util/Time.java
+++ b/core/src/org/apache/pivot/util/Time.java
@@ -265,7 +265,7 @@
* Adds the specified milliseconds of days to this time and returns the
* resulting time. The number of milliseconds may be negative, in which case
* the result will be a time prior to this time.
- *
+ *
* @param milliseconds The number of milliseconds to add to this time.
* @return The resulting time.
*/
@@ -279,7 +279,7 @@
* difference will be positive. If this time represents a time before the
* specified time, the difference will be negative. If the two times
* represent the same time, the difference will be zero.
- *
+ *
* @param time The time to subtract from this time.
* @return The number of milliseconds in between this time and <tt>time</tt>.
*/
@@ -294,7 +294,7 @@
/**
* Returns the number of milliseconds since midnight represented by this
* time.
- *
+ *
* @return The number of milliseconds since midnight represented by this
* time.
*/
@@ -368,7 +368,7 @@
* string must be in the full <tt>ISO 8601</tt> extended "time" format,
* which is <tt>[hh]:[mm]:[ss]</tt>. An optional millisecond suffix of the
* form <tt>.[nnn]</tt> is also supported.
- *
+ *
* @param value A string in the form of <tt>[hh]:[mm]:[ss]</tt> or
* <tt>[hh]:[mm]:[ss].[nnn]</tt> (e.g. 17:19:20 or 17:19:20.412).
*/
diff --git a/core/src/org/apache/pivot/util/TypeLiteral.java b/core/src/org/apache/pivot/util/TypeLiteral.java
index 7fa354e..64bd40e 100644
--- a/core/src/org/apache/pivot/util/TypeLiteral.java
+++ b/core/src/org/apache/pivot/util/TypeLiteral.java
@@ -29,7 +29,7 @@
* <p> This class is a drastically reduced derivation from <a
* href="http://code.google.com/p/google-guice/">Google Guice</a>'s
* {@code TypeLiteral} class, written by Bob Lee and Jesse Wilson.
- *
+ *
* @param <T> note that in Tree the type parameter currently it's not used
*/
public class TypeLiteral<T> {
diff --git a/core/src/org/apache/pivot/util/concurrent/Task.java b/core/src/org/apache/pivot/util/concurrent/Task.java
index 517e13e..d31f4c1 100644
--- a/core/src/org/apache/pivot/util/concurrent/Task.java
+++ b/core/src/org/apache/pivot/util/concurrent/Task.java
@@ -23,7 +23,7 @@
/**
* Abstract base class for "tasks". A task is an asynchronous operation that may
* optionally return a value.
- *
+ *
* @param <V> The type of the value returned by the operation. May be
* {@link Void} to indicate that the task does not return a value.
*/
@@ -126,7 +126,7 @@
/**
* Synchronously executes the task.
- *
+ *
* @return The result of the task's execution.
* @throws TaskExecutionException If an error occurs while executing the
* task.
@@ -138,7 +138,7 @@
* completion via the listener argument. Note that the listener will be
* notified on the task's worker thread, not on the thread that executed the
* task.
- *
+ *
* @param taskListenerArgument The listener to be notified when the task
* completes.
*/
@@ -151,7 +151,7 @@
* completion via the listener argument. Note that the listener will be
* notified on the task's worker thread, not on the thread that executed the
* task.
- *
+ *
* @param taskListenerArgument The listener to be notified when the task
* completes.
* @param executorServiceArgument The service to submit the task to,
@@ -191,7 +191,7 @@
/**
* Returns the result of executing the task.
- *
+ *
* @return The task result, or <tt>null</tt> if the task is still executing
* or has failed. The result itself may also be <tt>null</tt>; callers
* should call {@link #isPending()} and {@link #getFault()} to distinguish
@@ -203,7 +203,7 @@
/**
* Returns the fault that occurred while executing the task.
- *
+ *
* @return The task fault, or <tt>null</tt> if the task is still executing
* or has succeeded. Callers should call {@link #isPending()} to distinguish
* between these cases.
@@ -214,7 +214,7 @@
/**
* Returns the pending state of the task.
- *
+ *
* @return <tt>true</tt> if the task is awaiting execution or currently
* executing; <tt>false</tt>, otherwise.
*/
@@ -224,7 +224,7 @@
/**
* Returns the timeout value for this task.
- *
+ *
* @see #setTimeout(long)
*/
public synchronized long getTimeout() {
@@ -234,7 +234,7 @@
/**
* Sets the timeout value for this task. It is the responsibility of the
* implementing class to respect this value.
- *
+ *
* @param timeout The time by which the task must complete execution. If the
* timeout is exceeded, a {@link TimeoutException} will be thrown.
*/
diff --git a/core/src/org/apache/pivot/util/concurrent/TaskListener.java b/core/src/org/apache/pivot/util/concurrent/TaskListener.java
index d75b346..e49af95 100644
--- a/core/src/org/apache/pivot/util/concurrent/TaskListener.java
+++ b/core/src/org/apache/pivot/util/concurrent/TaskListener.java
@@ -18,20 +18,20 @@
/**
* Task listener interface.
- *
+ *
* @param <V> The return type of the task.
*/
public interface TaskListener<V> {
/**
* Called when the task has completed successfully.
- *
+ *
* @param task The source of the task event.
*/
public void taskExecuted(Task<V> task);
/**
* Called when task execution has failed.
- *
+ *
* @param task The source of the task event.
*/
public void executeFailed(Task<V> task);
diff --git a/core/src/org/apache/pivot/xml/Element.java b/core/src/org/apache/pivot/xml/Element.java
index 1db4c06..f58ad1c 100644
--- a/core/src/org/apache/pivot/xml/Element.java
+++ b/core/src/org/apache/pivot/xml/Element.java
@@ -57,7 +57,7 @@
/**
* Returns the element to which this attribute belongs.
- *
+ *
* @return This attribute's element, or <tt>null</tt> if the attribute
* does not belong to an element.
*/
@@ -67,7 +67,7 @@
/**
* Returns the attribute's namespace prefix.
- *
+ *
* @return The attribute's namespace prefix, or <tt>null</tt> if the
* attribute belongs to the default namespace.
*/
@@ -105,7 +105,7 @@
/**
* Sets the attribute's value.
- *
+ *
* @param value
*/
public void setValue(String value) {
@@ -176,7 +176,7 @@
/**
* Adds an attribute to the sequence.
- *
+ *
* @param attribute
*/
@Override
@@ -189,7 +189,7 @@
/**
* Inserts an attribute into the sequence at a specific location.
- *
+ *
* @param attribute
* @param index
*/
@@ -227,7 +227,7 @@
/**
* Removes an attribute from the sequence.
- *
+ *
* @param attribute
*/
@Override
@@ -242,7 +242,7 @@
/**
* Removes a range of attributes from the sequence.
- *
+ *
* @param index
* @param count
*/
@@ -265,7 +265,7 @@
/**
* Returns the attribute at a given index.
- *
+ *
* @param index
*/
@Override
@@ -275,7 +275,7 @@
/**
* Determines the index of an attribute.
- *
+ *
* @param attribute
* @return The index of the attribute, if found; otherwise, <tt>-1</tt>.
*/
@@ -310,7 +310,7 @@
/**
* Returns the URI of a namespace declared by this element.
- *
+ *
* @param prefix The namespace prefix.
* @return The declared namespace, or <tt>null</tt> if no such namespace
* exists.
@@ -322,7 +322,7 @@
/**
* Sets the URI of a namespace declared by this element.
- *
+ *
* @param prefix The namespace prefix.
* @param uri The namespace URI.
* @return The URI previously associated with the given prefix.
@@ -347,7 +347,7 @@
/**
* Removes a namespace from this element's declared namespaces.
- *
+ *
* @param prefix The namespace prefix.
* @return The URI previously associated with the given prefix.
*/
@@ -365,7 +365,7 @@
/**
* Tests for the existence of a namespace declared by this element.
- *
+ *
* @param prefix
* @return <tt>true</tt> if this element declares a namespace with the
* given prefix; <tt>false</tt>, otherwise.
@@ -445,7 +445,7 @@
/**
* Returns an attribute value.
- *
+ *
* @param attributeName
* @return The value associated with the given attribute, or
* <tt>null</tt>
@@ -458,7 +458,7 @@
/**
* Sets an attribute value.
- *
+ *
* @param attributeName
* @param value
* @return The value previously associated with the given attribute, or
@@ -495,7 +495,7 @@
/**
* Removes an attribute.
- *
+ *
* @param attributeName
* @return The value previously associated with the given attribute.
*/
@@ -511,7 +511,7 @@
/**
* Tests for the existence of an attribute.
- *
+ *
* @param attributeName
* @return <tt>true</tt> if this element defines the given attribute;
* <tt>false<tt>, otherwise.
@@ -553,7 +553,7 @@
/**
* Returns the element's namespace prefix.
- *
+ *
* @return The element's namespace prefix, or <tt>null</tt> if the element
* belongs to the default namespace.
*/
@@ -584,7 +584,7 @@
/**
* Returns the element's default namespace URI.
- *
+ *
* @return The default namespace URI declared by this element, or
* <tt>null</tt> if this element does not declare a default namespace.
*/
@@ -594,7 +594,7 @@
/**
* Sets the element's default namespace URI.
- *
+ *
* @param defaultNamespaceURI The default namespace URI declared by this
* element, or <tt>null</tt> if this element does not declare a default
* namespace.
@@ -618,7 +618,7 @@
/**
* Determines the namespace URI corresponding to the given prefix by
* traversing the element's ancestry.
- *
+ *
* @param prefix The namespace prefix to look up, or <tt>null</tt> to
* determine the default namespace for this element.
* @return The namespace URI corresponding to the given prefix, or
@@ -661,7 +661,7 @@
/**
* Adds a node to this element.
- *
+ *
* @param node
* @return The index at which the node was added.
*/
@@ -679,7 +679,7 @@
/**
* Inserts a node at a specific location within this element.
- *
+ *
* @param node
* @param index
*/
@@ -704,7 +704,7 @@
/**
* Removes a node from this element.
- *
+ *
* @param node
*/
@Override
@@ -719,7 +719,7 @@
/**
* Removes a range of nodes from this element.
- *
+ *
* @param index
* @param count
* @return The removed nodes.
@@ -757,7 +757,7 @@
/**
* Returns the node at the given index.
- *
+ *
* @param index
*/
@Override
@@ -767,7 +767,7 @@
/**
* Determines the index of the given node within this element.
- *
+ *
* @return The index of the node, or <tt>-1</tt> if the node does not exist
* in this element.
*/
@@ -810,7 +810,7 @@
/**
* Determines if this element defines any attributes.
- *
+ *
* @return <tt>true</tt> if this element does not define any attributes;
* <tt>false</tt>, otherwise.
*/
@@ -822,7 +822,7 @@
/**
* Returns the sub-elements of of this element whose tag names match the
* given name.
- *
+ *
* @param name The tag name to match.
* @return A list containing the matching elements. The list will be empty if
* no elements matched the given tag name.
@@ -849,7 +849,7 @@
* Returns the text content of this element. An element is defined to
* contain text when it contains a single child that is an instance of
* {@link TextNode}.
- *
+ *
* @return The text content of the element, or {@code null} if this element
* does not contain text.
*/
diff --git a/core/src/org/apache/pivot/xml/ElementListener.java b/core/src/org/apache/pivot/xml/ElementListener.java
index 2c8ac8f..d8c5b09 100644
--- a/core/src/org/apache/pivot/xml/ElementListener.java
+++ b/core/src/org/apache/pivot/xml/ElementListener.java
@@ -65,7 +65,7 @@
/**
* Called when an element's default namespace URI has changed.
- *
+ *
* @param element
* @param previousDefaultNamespaceURI
*/
@@ -73,7 +73,7 @@
/**
* Called when a namespace has been added to an element.
- *
+ *
* @param element
* @param prefix
*/
@@ -81,7 +81,7 @@
/**
* Called when an element attribute has been updated.
- *
+ *
* @param element
* @param prefix
* @param previousURI
@@ -90,7 +90,7 @@
/**
* Called when a namespace has been removed from an element.
- *
+ *
* @param element
* @param prefix
* @param uri
@@ -99,7 +99,7 @@
/**
* Called when an attribute has been added to an element.
- *
+ *
* @param element
* @param index
*/
@@ -107,7 +107,7 @@
/**
* Called when attributes have been removed from an element.
- *
+ *
* @param element
* @param index
* @param attributes
@@ -116,7 +116,7 @@
/**
* Called when an attribute's value has changed.
- *
+ *
* @param attribute
* @param previousValue
*/
diff --git a/core/src/org/apache/pivot/xml/Node.java b/core/src/org/apache/pivot/xml/Node.java
index 252eb5a..9a0ad24 100644
--- a/core/src/org/apache/pivot/xml/Node.java
+++ b/core/src/org/apache/pivot/xml/Node.java
@@ -45,7 +45,7 @@
/**
* Sets the parent element of the node.
- *
+ *
* @param parent
*/
protected void setParent(Element parent) {
diff --git a/core/src/org/apache/pivot/xml/NodeListener.java b/core/src/org/apache/pivot/xml/NodeListener.java
index fd49d9a..cae1db0 100644
--- a/core/src/org/apache/pivot/xml/NodeListener.java
+++ b/core/src/org/apache/pivot/xml/NodeListener.java
@@ -22,7 +22,7 @@
public interface NodeListener {
/**
* Called when a node's parent has changed.
- *
+ *
* @param node
* @param previousParent
*/
diff --git a/core/src/org/apache/pivot/xml/XML.java b/core/src/org/apache/pivot/xml/XML.java
index 57255a9..f3007c8 100644
--- a/core/src/org/apache/pivot/xml/XML.java
+++ b/core/src/org/apache/pivot/xml/XML.java
@@ -25,7 +25,7 @@
public class XML {
/**
* Returns the element matching a given path.
- *
+ *
* @param root The element from which to begin the search.
* @param path A path of the form: <pre> tag[n]/tag[n]/... </pre> The
* bracketed index values are optional and refer to the <i>n</i>th
@@ -103,7 +103,7 @@
/**
* Returns the sub-elements of a descendant of {@code root} whose tag names
* match the given name.
- *
+ *
* @param root The element from which to begin the search.
* @param path The path to the descendant, relative to {@code root}.
* @param name The tag name to match.
@@ -119,7 +119,7 @@
/**
* Returns the text content of a descendant of {@code root}.
- *
+ *
* @param root The element from which to begin the search.
* @param path The path to the descendant, relative to {@code root}.
* @return The text of the descedant, or {@code null} if no such descendant
diff --git a/core/src/org/apache/pivot/xml/XMLSerializerListener.java b/core/src/org/apache/pivot/xml/XMLSerializerListener.java
index d00b00d..524b05d 100644
--- a/core/src/org/apache/pivot/xml/XMLSerializerListener.java
+++ b/core/src/org/apache/pivot/xml/XMLSerializerListener.java
@@ -42,7 +42,7 @@
/**
* Called when the serializer has begun reading an element.
- *
+ *
* @param xmlSerializer
* @param element
*/
@@ -50,14 +50,14 @@
/**
* Called when the serializer has finished reading an element.
- *
+ *
* @param xmlSerializer
*/
public void endElement(XMLSerializer xmlSerializer);
/**
* Called when the serializer has read a text node.
- *
+ *
* @param xmlSerializer
* @param textNode
*/
diff --git a/core/test/org/apache/pivot/collections/test/HashMapTest.java b/core/test/org/apache/pivot/collections/test/HashMapTest.java
index 8e0d844..3976014 100644
--- a/core/test/org/apache/pivot/collections/test/HashMapTest.java
+++ b/core/test/org/apache/pivot/collections/test/HashMapTest.java
@@ -118,23 +118,23 @@
/*
* // TODO: re-enable this, to make it work even inside latest eclipse ...
- *
+ *
* @Test public void comparatorTest() { Comparator<Character> comparator =
* new Comparator<Character>() {
- *
+ *
* @Override public int compare(Character c1, Character c2) { return
* c1.compareTo(c2); } };
- *
+ *
* HashMap<Character, Integer> map = new HashMap<Character,
* Integer>(comparator); ArrayList<Character> keys = new
* ArrayList<Character>('c', 'a', 'x', 'r', 'd', 'n', 'f');
- *
+ *
* int n = keys.getLength();
- *
+ *
* int i = 0; while (i < n) { map.put(keys.get(i), i++); }
- *
+ *
* keys.setComparator(comparator);
- *
+ *
* int j = 0; for (Character c : keys) { assertEquals(keys.get(j++), c); } }
*/
diff --git a/core/test/org/apache/pivot/json/test/BindTest.java b/core/test/org/apache/pivot/json/test/BindTest.java
index 8401151..454a602 100644
--- a/core/test/org/apache/pivot/json/test/BindTest.java
+++ b/core/test/org/apache/pivot/json/test/BindTest.java
@@ -36,7 +36,7 @@
public class BindTest {
/**
* Tests returning an untyped list.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
@@ -50,7 +50,7 @@
/**
* Tests returning a typed list using
* {@code org.apache.pivot.util.TypeLiteral}.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
@@ -77,7 +77,7 @@
/**
* Tests returning a subclass of a generic
* {@code org.apache.pivot.collections.List}.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
@@ -100,7 +100,7 @@
/**
* Tests returning a class that implements
* {@code org.apache.pivot.collections.Sequence}.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
@@ -123,7 +123,7 @@
/**
* Tests returning an untyped map.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
@@ -139,7 +139,7 @@
/**
* Tests returning a typed map using
* {@code org.apache.pivot.util.TypeLiteral}.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
@@ -161,7 +161,7 @@
/**
* Tests returning a subclass of a generic
* {@code org.apache.pivot.collections.Map}.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
@@ -179,7 +179,7 @@
/**
* Tests returning a class that implements
* {@code org.apache.pivot.collections.Dictionary}.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
@@ -197,7 +197,7 @@
/**
* Tests returning a Java bean value.
- *
+ *
* @throws IOException
* @throws SerializationException
*/
diff --git a/demos/src/org/apache/pivot/demos/dom/DOMInteractionDemo.java b/demos/src/org/apache/pivot/demos/dom/DOMInteractionDemo.java
index 340f429..604c43e 100644
--- a/demos/src/org/apache/pivot/demos/dom/DOMInteractionDemo.java
+++ b/demos/src/org/apache/pivot/demos/dom/DOMInteractionDemo.java
@@ -88,7 +88,7 @@
/**
* Set text of the message, then display it in a Popup. <p> Called by
* JavaScript from the Browser.
- *
+ *
* @param helloText the text of the message
*/
public void sayHello(String helloText) {
diff --git a/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java b/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java
index afc8e9e..8219f97 100644
--- a/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java
+++ b/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java
@@ -113,7 +113,7 @@
/**
* Executes a search.
- *
+ *
* @param term The search term.
* @throws IllegalArgumentException If <tt>term</tt> is <tt>null</tt> or
* empty.
@@ -189,7 +189,7 @@
/**
* Aborts an executing query.
- *
+ *
* @throws IllegalStateException If a query is not currently executing.
*/
public void abortQuery() {
@@ -205,7 +205,7 @@
/**
* Tests whether a query is currently executing.
- *
+ *
* @return <tt>true</tt> if a query is currently executing; <tt>false</tt>,
* otherwise.
*/
diff --git a/tests/src/org/apache/pivot/tests/JavascriptConsoleTest.java b/tests/src/org/apache/pivot/tests/JavascriptConsoleTest.java
index 1a98a4c..954df21 100644
--- a/tests/src/org/apache/pivot/tests/JavascriptConsoleTest.java
+++ b/tests/src/org/apache/pivot/tests/JavascriptConsoleTest.java
@@ -89,7 +89,7 @@
/**
* Utility method to initialize secondary fields/elements during application
* startup.
- *
+ *
* @param serializer the BXMLSerializer instance to use
*/
private void initializeFields(BXMLSerializer serializer) {
@@ -104,7 +104,7 @@
/**
* Load resource files for the given classname, or if null a default will be
* used.
- *
+ *
* @param className the full class name (to use as a base name), for loading
* resources
*/
@@ -131,7 +131,7 @@
* Load (and returns) a Window, given its file name <p> Note that if public
* this method could be called even from JS in a bxml file (but a reference
* to the current application has to be put in serializer namespace).
- *
+ *
* @param fileName the file name for the bxml file to load
* @return the Window instance
* @throws SerializationException in case of error
@@ -144,7 +144,7 @@
/**
* Load (and returns) a Window, given its file name and serializer to use
- *
+ *
* @param fileName the file name for the bxml file to load
* @param bxmlSerializer the serializer to use, or if null a new one will be
* created
@@ -174,7 +174,7 @@
* (but a reference to the current application has to be put in serializer
* namespace). <p> Note that all Exceptions are catched inside this method,
* to not expose them to JS code.
- *
+ *
* @param urlString the URL of the bxml file to load, as a String
* @param bxmlSerializer the serializer to use, or if null a new one will be
* created
@@ -211,7 +211,7 @@
/**
* Return the value for the given label, from the resource file loaded at
* application startup.
- *
+ *
* @param name the label name
* @return the value or the label, or empty string if not found
*/
@@ -239,7 +239,7 @@
* System.out . <p> Note that it has been set public, static, and accepting
* Object (and not String as usual), even to make some tests on it from JS
* code.
- *
+ *
* @param msg the object (or message) to log
*/
public static final void logObject(Object obj) {
@@ -252,7 +252,7 @@
/**
* Application entry point, when run as a Standard (Desktop) Java
* Application.
- *
+ *
* @param args command line arguments
*/
public static void main(String[] args) {
diff --git a/tests/src/org/apache/pivot/tests/LabelAntialiasTest.java b/tests/src/org/apache/pivot/tests/LabelAntialiasTest.java
index 2500509..f258318 100644
--- a/tests/src/org/apache/pivot/tests/LabelAntialiasTest.java
+++ b/tests/src/org/apache/pivot/tests/LabelAntialiasTest.java
@@ -55,7 +55,7 @@
/**
* Write to console some details of Desktop Hints, for Font Rendering.
- *
+ *
* @see org.apache.pivot.wtk.Platform#initializeFontRenderContext
*/
private void showFontDesktopHints() {
diff --git a/tests/src/org/apache/pivot/tests/SplashScreenTest.java b/tests/src/org/apache/pivot/tests/SplashScreenTest.java
index 2502711..85fdd9c 100644
--- a/tests/src/org/apache/pivot/tests/SplashScreenTest.java
+++ b/tests/src/org/apache/pivot/tests/SplashScreenTest.java
@@ -57,7 +57,7 @@
* -splash:bin/org/apache/pivot/tests/splash.png
* org.apache.pivot.tests.SplashScreenTest --preserveSplashScreen=true
* --fullScreen=false </pre>
- *
+ *
* @see SplashScreen
* @see DesktopApplicationContext#replaceSplashScreen(Display)
* @see DesktopApplicationContext#PRESERVE_SPLASH_SCREEN_ARGUMENT
diff --git a/tests/src/org/apache/pivot/tests/issues/pivot859/Pivot859.java b/tests/src/org/apache/pivot/tests/issues/pivot859/Pivot859.java
index 8da1de8..6aac942 100644
--- a/tests/src/org/apache/pivot/tests/issues/pivot859/Pivot859.java
+++ b/tests/src/org/apache/pivot/tests/issues/pivot859/Pivot859.java
@@ -73,7 +73,7 @@
/**
* Set the Applet name. <p> Called by JavaScript from the Browser.
- *
+ *
* @param name the name
*/
public void setAppletName(String name) {
@@ -83,7 +83,7 @@
/**
* Get the Applet name. <p> Called by JavaScript from the Browser.
- *
+ *
* @return the name
*/
public String getAppletName() {
diff --git a/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/FakeWindowListener.java b/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/FakeWindowListener.java
index c5267c0..a01e8ed 100644
--- a/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/FakeWindowListener.java
+++ b/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/FakeWindowListener.java
@@ -54,7 +54,7 @@
/**
* Called when a window's title has changed.
- *
+ *
* @param window
* @param previousTitle
*/
@@ -62,7 +62,7 @@
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param addedIcon
*/
@@ -70,7 +70,7 @@
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param addedIcon
*/
@@ -78,7 +78,7 @@
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param index
* @param removed
@@ -87,7 +87,7 @@
/**
* Called when a window's content component has changed.
- *
+ *
* @param window
* @param previousContent
*/
diff --git a/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/tools/ComponentInspectorListener.java b/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/tools/ComponentInspectorListener.java
index db1fb14..2e57595 100644
--- a/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/tools/ComponentInspectorListener.java
+++ b/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/tools/ComponentInspectorListener.java
@@ -24,7 +24,7 @@
public interface ComponentInspectorListener {
/**
* Called when an component inspector's source component has changed.
- *
+ *
* @param componentInspector
* @param previousSource
*/
diff --git a/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/tools/ComponentInspectorSkin.java b/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/tools/ComponentInspectorSkin.java
index 26bc26e..147692f 100644
--- a/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/tools/ComponentInspectorSkin.java
+++ b/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/tools/ComponentInspectorSkin.java
@@ -102,7 +102,7 @@
/**
* Adds a new control component to the specified form section. The component
* will control the specified property.
- *
+ *
* @param dictionary The property dictionary
* @param key The property key
* @param type The type of the property
@@ -170,7 +170,7 @@
/**
* Updates the control component associated with the specified property to
* the appropriate state based on the property value.
- *
+ *
* @param dictionary The property dictionary
* @param key The property key
* @param type The type of the property
diff --git a/tutorials/src/org/apache/pivot/tutorials/explorer/tools/ComponentInspectorListener.java b/tutorials/src/org/apache/pivot/tutorials/explorer/tools/ComponentInspectorListener.java
index 407b091..26fb244 100644
--- a/tutorials/src/org/apache/pivot/tutorials/explorer/tools/ComponentInspectorListener.java
+++ b/tutorials/src/org/apache/pivot/tutorials/explorer/tools/ComponentInspectorListener.java
@@ -24,7 +24,7 @@
public interface ComponentInspectorListener {
/**
* Called when an component inspector's source component has changed.
- *
+ *
* @param componentInspector
* @param previousSource
*/
diff --git a/tutorials/src/org/apache/pivot/tutorials/explorer/tools/ComponentInspectorSkin.java b/tutorials/src/org/apache/pivot/tutorials/explorer/tools/ComponentInspectorSkin.java
index c1f7a3a..f30cf20 100644
--- a/tutorials/src/org/apache/pivot/tutorials/explorer/tools/ComponentInspectorSkin.java
+++ b/tutorials/src/org/apache/pivot/tutorials/explorer/tools/ComponentInspectorSkin.java
@@ -102,7 +102,7 @@
/**
* Adds a new control component to the specified form section. The component
* will control the specified property.
- *
+ *
* @param dictionary The property dictionary
* @param key The property key
* @param type The type of the property
@@ -170,7 +170,7 @@
/**
* Updates the control component associated with the specified property to
* the appropriate state based on the property value.
- *
+ *
* @param dictionary The property dictionary
* @param key The property key
* @param type The type of the property
diff --git a/tutorials/src/org/apache/pivot/tutorials/explorer/tools/EventLogger.java b/tutorials/src/org/apache/pivot/tutorials/explorer/tools/EventLogger.java
index a72ee42..cc4a4b8 100644
--- a/tutorials/src/org/apache/pivot/tutorials/explorer/tools/EventLogger.java
+++ b/tutorials/src/org/apache/pivot/tutorials/explorer/tools/EventLogger.java
@@ -49,7 +49,7 @@
/**
* Select/Deselect all Events to log.
- *
+ *
* @param select if true, all events will be selected for the log,
* otherwise all events will be deselected
*/
@@ -221,7 +221,7 @@
/**
* Gets this event logger's source component.
- *
+ *
* @return The source component, or <tt>null</tt> if no source has been set.
*/
public Component getSource() {
@@ -230,7 +230,7 @@
/**
* Sets this event logger's source component.
- *
+ *
* @param source The source component, or <tt>null</tt> to clear the source.
*/
public void setSource(Component source) {
@@ -257,7 +257,7 @@
/**
* Gets the declared event group, a read-only group that includes the
* complete list of events that this event logger's source declares.
- *
+ *
* @return the declared events group.
*/
public DeclaredEventGroup getDeclaredEvents() {
@@ -270,7 +270,7 @@
* group is guaranteed to be a subset of the declared event group (attempts
* to add events to this group that are not included in the declared event
* group will fail).
- *
+ *
* @return The include events group.
*/
public IncludeEventGroup getIncludeEvents() {
@@ -287,7 +287,7 @@
/**
* Select/Deselect all Events to log.
- *
+ *
* @param select if true, all events will be selected for the log, otherwise
* all events will be deselected
*/
diff --git a/tutorials/src/org/apache/pivot/tutorials/explorer/tools/EventLoggerListener.java b/tutorials/src/org/apache/pivot/tutorials/explorer/tools/EventLoggerListener.java
index 7ef2eee..7d25a70 100644
--- a/tutorials/src/org/apache/pivot/tutorials/explorer/tools/EventLoggerListener.java
+++ b/tutorials/src/org/apache/pivot/tutorials/explorer/tools/EventLoggerListener.java
@@ -51,7 +51,7 @@
/**
* Called when an event logger's source has changed.
- *
+ *
* @param eventLogger
* @param previousSource
*/
@@ -60,7 +60,7 @@
/**
* Called when a declared event has been included in the list of logged
* events.
- *
+ *
* @param eventLogger
* @param event
*/
@@ -69,7 +69,7 @@
/**
* Called when a declared event has been excluded from the list of logged
* events.
- *
+ *
* @param eventLogger
* @param event
*/
@@ -78,7 +78,7 @@
/**
* Called when an included event has been fired by the event logger's
* source.
- *
+ *
* @param eventLogger
* @param event
* @param arguments
diff --git a/web-server/src/org/apache/pivot/web/server/QueryServlet.java b/web-server/src/org/apache/pivot/web/server/QueryServlet.java
index ff09a13..170d02b 100644
--- a/web-server/src/org/apache/pivot/web/server/QueryServlet.java
+++ b/web-server/src/org/apache/pivot/web/server/QueryServlet.java
@@ -227,7 +227,7 @@
* Prepares a servlet for request execution. This method is called
* immediately prior to the {@link #validate(Query.Method, Path)} method.
* <p> The default implementation is a no-op.
- *
+ *
* @throws ServletException
*/
protected void prepare() throws ServletException {
@@ -238,7 +238,7 @@
* Disposes any resources allocated in {@link #prepare()}. This method is
* guaranteed to be called even if the HTTP handler method throws. <p> The
* default implementation is a no-op.
- *
+ *
* @throws ServletException
*/
protected void dispose() throws ServletException {
@@ -249,7 +249,7 @@
* Validates a servlet for request execution. This method is called
* immediately prior to the HTTP handler method. <p> The default
* implementation is a no-op.
- *
+ *
* @param method
* @param path
* @throws QueryException
@@ -261,7 +261,7 @@
/**
* Handles an HTTP GET request. The default implementation throws an HTTP
* 405 query exception.
- *
+ *
* @param path
* @return The result of the GET.
* @throws QueryException
@@ -273,7 +273,7 @@
/**
* Handles an HTTP POST request. The default implementation throws an HTTP
* 405 query exception.
- *
+ *
* @param path
* @param value
* @return A URL containing the location of the created resource, or
@@ -287,7 +287,7 @@
/**
* Handles an HTTP GET request. The default implementation throws an HTTP
* 405 query exception.
- *
+ *
* @param path
* @param value
* @return <tt>true</tt> if the operation resulted in the creation of a
@@ -301,7 +301,7 @@
/**
* Handles an HTTP GET request. The default implementation throws an HTTP
* 405 query exception.
- *
+ *
* @param path
* @throws QueryException
*/
@@ -312,7 +312,7 @@
/**
* Creates a serializer that will be used to serialize the current request
* data.
- *
+ *
* @param method
* @param path
* @throws QueryException
diff --git a/web/src/org/apache/pivot/web/GetQuery.java b/web/src/org/apache/pivot/web/GetQuery.java
index 9a24425..15fbecb 100644
--- a/web/src/org/apache/pivot/web/GetQuery.java
+++ b/web/src/org/apache/pivot/web/GetQuery.java
@@ -44,7 +44,7 @@
/**
* Synchronously executes the GET operation.
- *
+ *
* @return The result of the operation, deserialized using the query's
* serializer.
*/
diff --git a/web/src/org/apache/pivot/web/PostQuery.java b/web/src/org/apache/pivot/web/PostQuery.java
index f84cccf..36cfda4 100644
--- a/web/src/org/apache/pivot/web/PostQuery.java
+++ b/web/src/org/apache/pivot/web/PostQuery.java
@@ -57,7 +57,7 @@
/**
* Sets the value that will be POSTed to the server when the query is
* executed.
- *
+ *
* @param value The value to POST to the server.
*/
public void setValue(Object value) {
@@ -66,7 +66,7 @@
/**
* Synchronously executes the POST operation.
- *
+ *
* @return A URL that uniquely identifies the location of the resource
* created on the server by the operation, or <tt>null</tt> if the server
* did not return a location.
diff --git a/web/src/org/apache/pivot/web/PutQuery.java b/web/src/org/apache/pivot/web/PutQuery.java
index f4564bb..2637218 100644
--- a/web/src/org/apache/pivot/web/PutQuery.java
+++ b/web/src/org/apache/pivot/web/PutQuery.java
@@ -54,7 +54,7 @@
/**
* Sets the value that will be PUT to the server when the query is executed.
- *
+ *
* @param value The value to PUT to the server.
*/
public void setValue(Object value) {
@@ -63,7 +63,7 @@
/**
* Synchronously executes the PUT operation.
- *
+ *
* @return <tt>true</tt> if the operation resulted in the creation of a
* server resource; <tt>false</tt>, otherwise.
*/
diff --git a/web/src/org/apache/pivot/web/Query.java b/web/src/org/apache/pivot/web/Query.java
index 6c8998d..fc058b2 100644
--- a/web/src/org/apache/pivot/web/Query.java
+++ b/web/src/org/apache/pivot/web/Query.java
@@ -40,7 +40,7 @@
* Abstract base class for web queries. A web query is an asynchronous operation
* that executes one of the following HTTP methods: <ul> <li>GET</li>
* <li>POST</li> <li>PUT</li> <li>DELETE</li> </ul>
- *
+ *
* @param <V> The type of the value retrieved or sent via the query. For GET
* operations, it is {@link Object}; for POST operations, the type is
* {@link URL}. For PUT and DELETE, it is {@link Void}.
@@ -158,7 +158,7 @@
/**
* Creates a new web query.
- *
+ *
* @param hostname
* @param port
* @param path
@@ -204,7 +204,7 @@
/**
* Gets the proxy associated with this query.
- *
+ *
* @return This query's proxy, or <tt>null</tt> if the query is using the
* default JVM proxy settings
*/
@@ -214,7 +214,7 @@
/**
* Sets the proxy associated with this query.
- *
+ *
* @param proxy This query's proxy, or <tt>null</tt> to use the default JVM
* proxy settings
*/
@@ -280,7 +280,7 @@
/**
* Returns the status of the most recent execution.
- *
+ *
* @return An HTTP code representing the most recent execution status.
*/
public int getStatus() {
@@ -298,7 +298,7 @@
/**
* Sets the serializer used to stream the value passed to or from the web
* query.
- *
+ *
* @param serializer The serializer (must be non-null).
*/
public void setSerializer(Serializer<?> serializer) {
diff --git a/web/src/org/apache/pivot/web/QueryException.java b/web/src/org/apache/pivot/web/QueryException.java
index 68913d3..c560c2e 100644
--- a/web/src/org/apache/pivot/web/QueryException.java
+++ b/web/src/org/apache/pivot/web/QueryException.java
@@ -42,7 +42,7 @@
/**
* Returns the HTTP status code corresponding to the exception.
- *
+ *
* @return An HTTP status code reflecting the nature of the exception, or
* <tt>0</tt> if the HTTP status is not known.
*/
diff --git a/web/src/org/apache/pivot/web/QueryListener.java b/web/src/org/apache/pivot/web/QueryListener.java
index d010f04..8c58834 100644
--- a/web/src/org/apache/pivot/web/QueryListener.java
+++ b/web/src/org/apache/pivot/web/QueryListener.java
@@ -48,7 +48,7 @@
/**
* Called when a query has connected to the server but the request has not
* yet been sent.
- *
+ *
* @param query
*/
public void connected(Query<V> query);
@@ -56,21 +56,21 @@
/**
* Called when the request has been sent to the server but the response has
* not yet been received.
- *
+ *
* @param query
*/
public void requestSent(Query<V> query);
/**
* Called when a response has been received from the server.
- *
+ *
* @param query
*/
public void responseReceived(Query<V> query);
/**
* Called when an error has occurred
- *
+ *
* @param query
*/
public void failed(Query<V> query);
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraAccordionSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraAccordionSkin.java
index c5a2f17..9ae1e48 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraAccordionSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraAccordionSkin.java
@@ -785,7 +785,7 @@
* {@link KeyCode#UP UP} Select the next enabled panel.<br>
* {@link Modifier#ALT ALT} + {@link KeyCode#DOWN DOWN} Select the previous
* enabled panel.
- *
+ *
* @see Platform#getCommandModifier()
*/
@Override
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraExpanderSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraExpanderSkin.java
index de8e579..2b8b48c 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraExpanderSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraExpanderSkin.java
@@ -635,7 +635,7 @@
/**
* Listener for expander button events.
- *
+ *
* @param button The source of the button event.
*/
@Override
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java
index e5f8058..dae42db 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java
@@ -130,7 +130,7 @@
/**
* Obtains the icon to display for a given file.
- *
+ *
* @param file
*/
public static Image getIcon(File file) {
@@ -1017,7 +1017,7 @@
/**
* CommandModifier + {@link KeyCode#F F} Transfers focus to the search
* TextInput.
- *
+ *
* @see Platform#getCommandModifier()
*/
@Override
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraMeterSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraMeterSkin.java
index e59ecd5..133dc52 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraMeterSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraMeterSkin.java
@@ -374,7 +374,7 @@
/**
* Listener for meter percentage changes.
- *
+ *
* @param meter The source of the event.
* @param previousPercentage The previous percentage value.
*/
@@ -385,7 +385,7 @@
/**
* Listener for meter text changes.
- *
+ *
* @param meter The source of the event.
* @param previousText The previous text value.
*/
@@ -396,7 +396,7 @@
/**
* Listener for meter orientation changes.
- *
+ *
* @param meter The source of the event.
*/
@Override
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraPaletteSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraPaletteSkin.java
index cad5f26..41bf6bd 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraPaletteSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraPaletteSkin.java
@@ -446,7 +446,7 @@
/**
* Sets the font used in rendering the titlebar text
- *
+ *
* @param font A
* {@link org.apache.pivot.wtk.skin.ComponentSkin#decodeFont(String) font
* specification}
@@ -461,7 +461,7 @@
/**
* Sets the font used in rendering the titlebar text
- *
+ *
* @param font A dictionary {@link Theme#deriveFont describing a font}
*/
public final void setTitleFont(Dictionary<String, ?> font) {
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java
index b54aad8..dcd04db 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java
@@ -58,7 +58,7 @@
/**
* Starts scrolling this skin's scroll bar, stopping the scroll when the
* specified value has been reached.
- *
+ *
* @param directionArgument <tt>1</tt> to adjust the scroll bar's value
* larger; <tt>-1</tt> to adjust it smaller
* @param incrementTypeArgument Determines whether we'll use the scroll
@@ -984,7 +984,7 @@
* Initiates automatic block scrolling. This only happens if the handle is
* visible since whether the user clicked before or after the handle
* determines the direction of the scrolling.
- *
+ *
* @param component The scroll bar.
* @param button The button that was pressed.
* @param x The x-coordinate of the event in the scroll bar's coordinate
@@ -1043,7 +1043,7 @@
/**
* Cancels automatic block scrolling.
- *
+ *
* @param component The scroll bar.
* @param button The button that was released.
* @param x The x-coordinate of the event in the scroll bar's coordinate
@@ -1064,7 +1064,7 @@
/**
* Updates the scroll bar's value.
- *
+ *
* @param component The scroll bar.
* @param scrollType Unit or block scrolling.
* @param scrollAmount The amount of scrolling.
@@ -1114,7 +1114,7 @@
* <tt>handle</tt>. <p> To map from scroll bar values (<i>real values</i>)
* to pixel values, you multiply by the value scale. To map from pixel
* values back to real values, you divide by the value scale.
- *
+ *
* @return <tt><number of legal pixel values> / <number of legal
* real values></tt>
*/
@@ -1149,7 +1149,7 @@
/**
* Propagates the scroll bar's enabled state to the scroll buttons.
- *
+ *
* @param component The scroll bar.
*/
@Override
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
index ffc8be0..8cf4cd9 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
@@ -59,7 +59,7 @@
/**
* Starts spinning the specified spinner.
- *
+ *
* @param spinnerArgument The spinner to spin
* @param directionArgument <tt>1</tt> to adjust the spinner's selected
* index larger; <tt>-1</tt> to adjust it smaller
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java
index 11ac935..8f79f27 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java
@@ -1457,7 +1457,7 @@
* {@link KeyCode#KEYPAD_9 KEYPAD_9}<br>or CommandModifier +
* {@link KeyCode#N1 1} to {@link KeyCode#N9 9} Select the (enabled) tab at
* index 0 to 8 respectively<p>
- *
+ *
* @see Platform#getCommandModifier()
*/
@Override
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
index 80c656c..854dfb5 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
@@ -1141,7 +1141,7 @@
* clipboard (if not a password TextInput).<br> CommandModifier +
* {@link KeyCode#V V} Paste from clipboard.<br> CommandModifier +
* {@link KeyCode#Z Z} Undo.
- *
+ *
* @see Platform#getCommandModifier()
*/
@Override
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
index 6411357..491240c 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
@@ -323,7 +323,7 @@
/**
* Gets a value from the theme's color palette.
- *
+ *
* @param index
*/
public Color getColor(int index) {
@@ -332,7 +332,7 @@
/**
* Sets a value in the theme's color palette.
- *
+ *
* @param index
* @param color
*/
@@ -346,7 +346,7 @@
/**
* Gets a base color from the theme's color palette.
- *
+ *
* @param index
*/
public Color getBaseColor(int index) {
@@ -355,7 +355,7 @@
/**
* Sets a base color in the theme's color palette.
- *
+ *
* @param index
* @param baseColor
*/
@@ -372,7 +372,7 @@
/**
* Gets the number of Palette Colors
- *
+ *
* @return the number
*/
// @Override // TODO: re-enable this override for PIVOT-689
@@ -382,7 +382,7 @@
/**
* Gets the total number of Colors
- *
+ *
* @return the number
*/
// @Override // TODO: re-enable this override for PIVOT-689
@@ -393,7 +393,7 @@
/**
* Gets the image that this theme uses to represent messages of the
* specified type.
- *
+ *
* @param messageType
*/
public Image getMessageIcon(MessageType messageType) {
@@ -403,7 +403,7 @@
/**
* Sets the image that this theme uses to represent messages of the
* specified type.
- *
+ *
* @param messageType
* @param messageIcon
*/
@@ -418,7 +418,7 @@
/**
* Gets the small image that this theme uses to represent messages of the
* specified type.
- *
+ *
* @param messageType
*/
public Image getSmallMessageIcon(MessageType messageType) {
@@ -428,7 +428,7 @@
/**
* Sets the small image that this theme uses to represent messages of the
* specified type.
- *
+ *
* @param messageType
* @param smallMessageIcon
*/
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
index 83aba07..a3614c7 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
@@ -67,7 +67,7 @@
protected interface NodeInfoVisitor {
/**
* Visits the specified node info.
- *
+ *
* @param nodeInfo The object to visit
*/
public void visit(NodeInfo nodeInfo);
@@ -93,7 +93,7 @@
/**
* Creates a new visible node iterator that will iterate over a portion
* of the visible nodes list (useful during painting).
- *
+ *
* @param start The start index, inclusive
* @param end The end index, inclusive
*/
@@ -149,7 +149,7 @@
/**
* This operation is not supported by this iterator.
- *
+ *
* @throws UnsupportedOperationException
*/
@Override
@@ -162,7 +162,7 @@
* , as seen in the current visible nodes list. Note that as branches
* are expanded and collapsed, the row index of any given node in the
* tree will change.
- *
+ *
* @return The row index of the current node, or <tt>-1</tt> if
* <tt>next()</tt> has not yet been called.
*/
@@ -172,7 +172,7 @@
/**
* Gets the path of the node last returned by a call to {@link #next()}.
- *
+ *
* @return The path to the node, or <tt>null</tt> if <tt>next()</tt> has
* not yet been called.
*/
@@ -1295,7 +1295,7 @@
/**
* Accepts the specified visitor on all node info objects that exist in this
* skin's node info hierarchy.
- *
+ *
* @param visitor The callback to execute on each node info object
*/
protected final void accept(NodeInfoVisitor visitor) {
@@ -1376,7 +1376,7 @@
* Adds the specified child of the specified branch to the visible node
* list. It is assumed that the child in question is not an expanded branch.
* Invalidates the component only if necessary.
- *
+ *
* @param parentBranchInfo The branch info of the parent node.
* @param index The index of the child within its parent.
*/
@@ -1423,7 +1423,7 @@
* Removes the specified children of the specified branch from the visible
* node list if necessary. If they are not already in the visible node list,
* nothing happens. Invalidates the component only if necessary.
- *
+ *
* @param parentBranchInfo The branch info of the parent node.
* @param index The index of the first child node to remove from the visible
* nodes sequence.
@@ -1492,7 +1492,7 @@
/**
* Clears our <tt>NodeInfo</tt> hierarchy of the specified cached field.
- *
+ *
* @param mask The bitmask specifying which field to clear.
*/
private void clearFields(final byte mask) {
diff --git a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java
index 7d264ca..ab04422 100644
--- a/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java
+++ b/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java
@@ -137,7 +137,7 @@
/**
* Obtains the icon to display for a given file.
- *
+ *
* @param file
*/
public static Image getIcon(FileObject file) {
@@ -1157,7 +1157,7 @@
/**
* CommandModifier + {@link KeyCode#F F} Transfers focus to the search
* TextInput.
- *
+ *
* @see Platform#getCommandModifier()
*/
@Override
diff --git a/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java b/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java
index fa043d8..0523ea9 100644
--- a/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java
+++ b/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java
@@ -39,7 +39,7 @@
/**
* Called when a panel's header data attribute has changed.
- *
+ *
* @param accordion
* @param component
* @param previousHeaderData
@@ -49,7 +49,7 @@
/**
* Called when a panel's tooltip text has changed.
- *
+ *
* @param accordion
* @param component
* @param previousTooltipText
diff --git a/wtk/src/org/apache/pivot/wtk/AccordionListener.java b/wtk/src/org/apache/pivot/wtk/AccordionListener.java
index 4c33a4a..bab7435 100644
--- a/wtk/src/org/apache/pivot/wtk/AccordionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/AccordionListener.java
@@ -45,7 +45,7 @@
/**
* Called when a panel has been inserted into a accordion's panel sequence.
- *
+ *
* @param accordion
* @param index
*/
@@ -53,7 +53,7 @@
/**
* Called when a panel has been removed from an accordion's panel sequence.
- *
+ *
* @param accordion
* @param index
* @param removed
@@ -62,7 +62,7 @@
/**
* Called when an accordion's header data renderer has changed.
- *
+ *
* @param accordion
* @param previousHeaderDataRenderer
*/
diff --git a/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java b/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java
index 87d7180..ddc758e 100644
--- a/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java
@@ -44,7 +44,7 @@
/**
* Called to preview a selected index change.
- *
+ *
* @param accordion The source of the event.
* @param selectedIndex The index that will be selected.
*/
@@ -52,7 +52,7 @@
/**
* Called when a selected index change has been vetoed.
- *
+ *
* @param accordion The source of the event.
* @param reason The reason the event was vetoed.
*/
@@ -60,7 +60,7 @@
/**
* Called when an accordion's selected index has changed.
- *
+ *
* @param accordion The source of the event.
* @param previousSelectedIndex If the selection changed directly, contains
* the index that was previously selected. Otherwise, contains the current
diff --git a/wtk/src/org/apache/pivot/wtk/Action.java b/wtk/src/org/apache/pivot/wtk/Action.java
index daa4f0c..d3b5d5f 100644
--- a/wtk/src/org/apache/pivot/wtk/Action.java
+++ b/wtk/src/org/apache/pivot/wtk/Action.java
@@ -143,7 +143,7 @@
/**
* Performs the action.
- *
+ *
* @param source The component that initiated the action.
*/
public abstract void perform(Component source);
diff --git a/wtk/src/org/apache/pivot/wtk/ActionClassListener.java b/wtk/src/org/apache/pivot/wtk/ActionClassListener.java
index 20332db..171fb42 100644
--- a/wtk/src/org/apache/pivot/wtk/ActionClassListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ActionClassListener.java
@@ -42,14 +42,14 @@
/**
* Called when an action has been added to the named action dictionary.
- *
+ *
* @param id
*/
public void actionAdded(String id);
/**
* Called when an action has been updated in the named action dictionary.
- *
+ *
* @param id
* @param previousAction
*/
@@ -57,7 +57,7 @@
/**
* Called when an action has been removed from the named action dictionary.
- *
+ *
* @param id
* @param action
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ActionListener.java b/wtk/src/org/apache/pivot/wtk/ActionListener.java
index 4102aa4..1801aa0 100644
--- a/wtk/src/org/apache/pivot/wtk/ActionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ActionListener.java
@@ -22,7 +22,7 @@
public interface ActionListener {
/**
* Called when an action's enabled state has changed.
- *
+ *
* @param action
*/
public void enabledChanged(Action action);
diff --git a/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java b/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java
index 3681255..c5e2f86 100644
--- a/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java
@@ -22,7 +22,7 @@
public interface ActivityIndicatorListener {
/**
* Called when an activity indicator's active state has changed.
- *
+ *
* @param activityIndicator
*/
public void activeChanged(ActivityIndicator activityIndicator);
diff --git a/wtk/src/org/apache/pivot/wtk/AlertListener.java b/wtk/src/org/apache/pivot/wtk/AlertListener.java
index c7492d7..95f2064 100644
--- a/wtk/src/org/apache/pivot/wtk/AlertListener.java
+++ b/wtk/src/org/apache/pivot/wtk/AlertListener.java
@@ -59,7 +59,7 @@
/**
* Called when an alert's message type has changed.
- *
+ *
* @param alert
* @param previousMessageType
*/
@@ -67,7 +67,7 @@
/**
* Called when an alert's message has changed.
- *
+ *
* @param alert
* @param previousMessage
*/
@@ -75,7 +75,7 @@
/**
* Called when an alert's body has changed.
- *
+ *
* @param alert
* @param previousBody
*/
@@ -83,7 +83,7 @@
/**
* Called when an option has been inserted into an alert's option sequence.
- *
+ *
* @param alert
* @param index
*/
@@ -91,7 +91,7 @@
/**
* Called when options have been removed from an alert's option sequence.
- *
+ *
* @param alert
* @param index
* @param removed
@@ -100,7 +100,7 @@
/**
* Called when an alert's selected option has changed.
- *
+ *
* @param alert
* @param previousSelectedOption
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Application.java b/wtk/src/org/apache/pivot/wtk/Application.java
index 8e1435b..8410fe2 100644
--- a/wtk/src/org/apache/pivot/wtk/Application.java
+++ b/wtk/src/org/apache/pivot/wtk/Application.java
@@ -107,7 +107,7 @@
/**
* Called when the application is starting up.
- *
+ *
* @param display The display on which this application was started.
* @param properties Initialization properties passed to the application.
*/
@@ -115,7 +115,7 @@
/**
* Called when the application is being shut down.
- *
+ *
* @param optional If <tt>true</tt>, the shutdown may be cancelled by
* returning a value of <tt>true</tt>.
* @return <tt>true</tt> to cancel shutdown, <tt>false</tt> to continue.
diff --git a/wtk/src/org/apache/pivot/wtk/ApplicationContext.java b/wtk/src/org/apache/pivot/wtk/ApplicationContext.java
index f0be49f..06224c9 100644
--- a/wtk/src/org/apache/pivot/wtk/ApplicationContext.java
+++ b/wtk/src/org/apache/pivot/wtk/ApplicationContext.java
@@ -524,7 +524,7 @@
/**
* Attempts to paint the display using an offscreen buffer.
- *
+ *
* @param graphics The source graphics context.
* @return <tt>true</tt> if the display was painted using the offscreen
* buffer; <tt>false</tt>, otherwise.
@@ -565,7 +565,7 @@
/**
* Attempts to paint the display using a volatile offscreen buffer.
- *
+ *
* @param graphics The source graphics context.
* @return <tt>true</tt> if the display was painted using the offscreen
* buffer; <tt>false</tt>, otherwise.
@@ -619,7 +619,7 @@
/**
* Paints the display including any decorators.
- *
+ *
* @param graphics
*/
private void paintDisplay(Graphics2D graphics) {
@@ -1652,7 +1652,7 @@
/**
* Returns this application's origin (the URL of it's originating server).
- *
+ *
* @return The application's origin, or <tt>null</tt> if the origin cannot
* be determined.
*/
@@ -1670,7 +1670,7 @@
/**
* Adds the styles from a named stylesheet to the named or typed style
* collections.
- *
+ *
* @param resourceName
*/
@SuppressWarnings("unchecked")
@@ -1727,7 +1727,7 @@
/**
* Returns the current JVM version.
- *
+ *
* @return The current JVM version, or <tt>null</tt> if the version can't be
* determined.
*/
@@ -1737,7 +1737,7 @@
/**
* Returns the current Pivot version.
- *
+ *
* @return The current Pivot version (determined at build time), or
* <tt>null</tt> if the version can't be determined.
*/
@@ -1748,7 +1748,7 @@
/**
* Schedules a task for one-time execution. The task will be executed on the
* UI thread.
- *
+ *
* @param callback The task to execute.
* @param delay The length of time to wait before executing the task (in
* milliseconds).
@@ -1774,7 +1774,7 @@
/**
* Schedules a task for repeated execution. The task will be executed on the
* UI thread and will begin executing immediately.
- *
+ *
* @param callback The task to execute.
* @param period The interval at which the task will be repeated (in
* milliseconds).
@@ -1786,7 +1786,7 @@
/**
* Schedules a task for repeated execution. The task will be executed on the
* UI thread.
- *
+ *
* @param callback The task to execute.
* @param delay The length of time to wait before the first execution of the
* task (milliseconds).
@@ -1815,7 +1815,7 @@
/**
* Queues a task to execute after all pending events have been processed and
* returns without waiting for the task to complete.
- *
+ *
* @param callback The task to execute.
*/
public static QueuedCallback queueCallback(Runnable callback) {
@@ -1825,7 +1825,7 @@
/**
* Queues a task to execute after all pending events have been processed and
* optionally waits for the task to complete.
- *
+ *
* @param callback The task to execute.
* @param wait If <tt>true</tt>, does not return until the task has executed.
* Otherwise, returns immediately.
diff --git a/wtk/src/org/apache/pivot/wtk/Border.java b/wtk/src/org/apache/pivot/wtk/Border.java
index 212c735..84b9cb6 100644
--- a/wtk/src/org/apache/pivot/wtk/Border.java
+++ b/wtk/src/org/apache/pivot/wtk/Border.java
@@ -58,7 +58,7 @@
/**
* Returns the border's title.
- *
+ *
* @return The border's title, or <tt>null</tt> if no title is set.
*/
public String getTitle() {
@@ -67,7 +67,7 @@
/**
* Sets the border's title.
- *
+ *
* @param title The new title, or <tt>null</tt> for no title.
*/
public void setTitle(String title) {
@@ -81,7 +81,7 @@
/**
* Returns the border's content component.
- *
+ *
* @return The border's content component, or <tt>null</tt> if the border
* does not have a content component.
*/
@@ -91,7 +91,7 @@
/**
* Sets the border's content component.
- *
+ *
* @param content The border's content component, or <tt>null</tt> for no
* content.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/BorderListener.java b/wtk/src/org/apache/pivot/wtk/BorderListener.java
index 609fdc5..4f8e31a 100644
--- a/wtk/src/org/apache/pivot/wtk/BorderListener.java
+++ b/wtk/src/org/apache/pivot/wtk/BorderListener.java
@@ -37,7 +37,7 @@
/**
* Called when a border's title has changed.
- *
+ *
* @param border
* @param previousTitle
*/
@@ -45,7 +45,7 @@
/**
* Called when a border's content component has changed.
- *
+ *
* @param border
* @param previousContent
*/
diff --git a/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java b/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java
index 85460d5..8d7a8a7 100644
--- a/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java
@@ -22,7 +22,7 @@
public interface BoxPaneListener {
/**
* Called when a box pane's orientation has changed.
- *
+ *
* @param boxPane
*/
public void orientationChanged(BoxPane boxPane);
diff --git a/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java b/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java
index 155d05d..6191eb8 100644
--- a/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java
+++ b/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java
@@ -349,7 +349,7 @@
/**
* Retrieves a named application.
- *
+ *
* @param name The name of the applet hosting the application.
*/
public static Application getApplication(String name) {
@@ -370,7 +370,7 @@
/**
* Evaluates a script in the page context and returns the result.
- *
+ *
* @param script
* @param application
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Button.java b/wtk/src/org/apache/pivot/wtk/Button.java
index 9c3dd82..bf64ab3 100644
--- a/wtk/src/org/apache/pivot/wtk/Button.java
+++ b/wtk/src/org/apache/pivot/wtk/Button.java
@@ -39,7 +39,7 @@
public interface DataRenderer extends Renderer {
/**
* Prepares the renderer for layout or paint.
- *
+ *
* @param data The data to render, or <tt>null</tt> if called to
* calculate preferred height for skins that assume a fixed renderer
* height.
@@ -50,7 +50,7 @@
/**
* Converts button data to a string representation.
- *
+ *
* @param data
* @return The data's string representation, or <tt>null</tt> if the data
* does not have a string representation. <p> Note that this method may
@@ -67,7 +67,7 @@
/**
* Converts a context value to a selection state during a
* {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public boolean isSelected(Object value);
@@ -75,7 +75,7 @@
/**
* Converts a selection state to a context value during a
* {@link Component#store(Object)} operation.
- *
+ *
* @param selected
*/
public Object valueOf(boolean selected);
@@ -88,7 +88,7 @@
/**
* Converts a context value to a button state during a
* {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public State toState(Object value);
@@ -96,7 +96,7 @@
/**
* Converts a button state to a context value during a
* {@link Component#store(Object)} operation.
- *
+ *
* @param state
*/
public Object valueOf(State state);
@@ -110,7 +110,7 @@
/**
* Converts a context value to button data during a
* {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public Object toButtonData(Object value);
@@ -118,7 +118,7 @@
/**
* Converts button data to a context value during a
* {@link Component#store(Object)} operation.
- *
+ *
* @param buttonData
*/
public Object valueOf(Object buttonData);
@@ -333,7 +333,7 @@
/**
* Returns the action associated with this button.
- *
+ *
* @return The button's action, or <tt>null</tt> if no action is defined.
*/
public Action getAction() {
@@ -342,7 +342,7 @@
/**
* Sets this button's action.
- *
+ *
* @param action The action to be triggered when this button is pressed, or
* <tt>null</tt> for no action.
*/
@@ -367,7 +367,7 @@
/**
* Sets this button's action.
- *
+ *
* @param actionID The ID of the action to be triggered when this button is
* pressed.
* @throws IllegalArgumentException If an action with the given ID does not
@@ -416,7 +416,7 @@
/**
* Sets the button's selected state.
- *
+ *
* @param selected
*/
public void setSelected(boolean selected) {
@@ -432,7 +432,7 @@
/**
* Sets the button's selection state.
- *
+ *
* @param state
*/
public void setState(State state) {
@@ -477,7 +477,7 @@
/**
* Sets the button's toggle state.
- *
+ *
* @param toggleButton
*/
public void setToggleButton(boolean toggleButton) {
@@ -505,7 +505,7 @@
/**
* Sets the button's tri-state state.
- *
+ *
* @param triState
*/
public void setTriState(boolean triState) {
@@ -525,7 +525,7 @@
/**
* Returns the button's button group.
- *
+ *
* @return The group to which the button belongs, or <tt>null</tt> if the
* button does not belong to a group.
*/
@@ -535,7 +535,7 @@
/**
* Sets the button's button group.
- *
+ *
* @param buttonGroup The group to which the button will belong, or
* <tt>null</tt> if the button will not belong to a group.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java b/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java
index a9edc59..31e1a7a 100644
--- a/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java
@@ -75,7 +75,7 @@
/**
* Called when a button's buttonData key has changed.
- *
+ *
* @param button
* @param previousButtonDataKey
*/
@@ -83,7 +83,7 @@
/**
* Called when a button's buttonData bind type has changed.
- *
+ *
* @param button
* @param previousButtonDataBindType
*/
@@ -91,7 +91,7 @@
/**
* Called when a button's buttonData bind mapping has changed.
- *
+ *
* @param button
* @param previousButtonDataBindMapping
*/
@@ -100,7 +100,7 @@
/**
* Called when a button's selected key has changed.
- *
+ *
* @param button
* @param previousSelectedKey
*/
@@ -108,7 +108,7 @@
/**
* Called when a button's selected bind type has changed.
- *
+ *
* @param button
* @param previousSelectedBindType
*/
@@ -116,7 +116,7 @@
/**
* Called when a button's selected bind mapping has changed.
- *
+ *
* @param button
* @param previousSelectedBindMapping
*/
@@ -125,7 +125,7 @@
/**
* Called when a button's state key has changed.
- *
+ *
* @param button
* @param previousStateKey
*/
@@ -133,7 +133,7 @@
/**
* Called when a button's state bind type has changed.
- *
+ *
* @param button
* @param previousStateBindType
*/
@@ -141,7 +141,7 @@
/**
* Called when a button's state bind mapping has changed.
- *
+ *
* @param button
* @param previousStateBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java b/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java
index f20641c..30813e6 100644
--- a/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java
@@ -42,7 +42,7 @@
/**
* Called when a button has been added to a button group.
- *
+ *
* @param buttonGroup
* @param button
*/
@@ -50,7 +50,7 @@
/**
* Called when a button has been removed from a button group.
- *
+ *
* @param buttonGroup
* @param button
*/
@@ -58,7 +58,7 @@
/**
* Called when a button group's selection has changed.
- *
+ *
* @param buttonGroup
* @param previousSelection
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ButtonListener.java b/wtk/src/org/apache/pivot/wtk/ButtonListener.java
index a41f787..e05b03b 100644
--- a/wtk/src/org/apache/pivot/wtk/ButtonListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ButtonListener.java
@@ -57,7 +57,7 @@
/**
* Called when a button's data has changed.
- *
+ *
* @param button
* @param previousButtonData
*/
@@ -65,7 +65,7 @@
/**
* Called when a button's data renderer has changed.
- *
+ *
* @param button
* @param previousDataRenderer
*/
@@ -73,7 +73,7 @@
/**
* Called when a button's action has changed.
- *
+ *
* @param button
* @param previousAction
*/
@@ -81,21 +81,21 @@
/**
* Called when a button's toggle button flag has changed.
- *
+ *
* @param button
*/
public void toggleButtonChanged(Button button);
/**
* Called when a button's tri-state flag has changed.
- *
+ *
* @param button
*/
public void triStateChanged(Button button);
/**
* Called when a button's button group has changed.
- *
+ *
* @param button
* @param previousButtonGroup
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java b/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java
index 1a14efb..e7e0298 100644
--- a/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java
@@ -22,7 +22,7 @@
public interface ButtonPressListener {
/**
* Called when a button is pressed.
- *
+ *
* @param button
*/
public void buttonPressed(Button button);
diff --git a/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java b/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java
index 3bd9e05..85542d3 100644
--- a/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java
@@ -22,7 +22,7 @@
public interface ButtonStateListener {
/**
* Called when a button's state has changed.
- *
+ *
* @param button
* @param previousState
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Calendar.java b/wtk/src/org/apache/pivot/wtk/Calendar.java
index 3816bfe..11e41b8 100644
--- a/wtk/src/org/apache/pivot/wtk/Calendar.java
+++ b/wtk/src/org/apache/pivot/wtk/Calendar.java
@@ -36,14 +36,14 @@
public interface SelectedDateBindMapping {
/**
* Converts a context value to a calendar date.
- *
+ *
* @param value
*/
public CalendarDate toDate(Object value);
/**
* Converts a calendar date to a context value.
- *
+ *
* @param calendarDate
*/
public Object valueOf(CalendarDate calendarDate);
@@ -200,7 +200,7 @@
/**
* Sets the currently selected date.
- *
+ *
* @param selectedDate The selected date, or <tt>null</tt> to specify no
* selection
*/
@@ -217,7 +217,7 @@
* Sets the selected date to the date represented by the specified date
* string. The date string must be in the <tt>ISO 8601</tt> "calendar date"
* format, which is <tt>[YYYY]-[MM]-[DD]</tt>.
- *
+ *
* @param selectedDate A string in the form of <tt>[YYYY]-[MM]-[DD]</tt>
* (e.g. 2008-07-23)
*/
@@ -238,7 +238,7 @@
/**
* Sets the locale used to present calendar data.
- *
+ *
* @param locale
*/
public void setLocale(Locale locale) {
@@ -255,7 +255,7 @@
/**
* Sets the locale used to present calendar data.
- *
+ *
* @param locale An dictionary containing values for language, country, and
* variant. Country and variant are optional but the must adhere to the
* following rules: <ul> <li>If variant is specified, language and country
@@ -282,7 +282,7 @@
/**
* Sets the locale used to present calendar data.
- *
+ *
* @param locale A JSON map containing values for language, country, and
* variant.
* @see #setLocale(Dictionary)
diff --git a/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java b/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java
index 8d7bb8f..fa09096 100644
--- a/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java
@@ -44,7 +44,7 @@
/**
* Called when a calendar's selected date key has changed.
- *
+ *
* @param calendar
* @param previousSelectedDateKey
*/
@@ -52,7 +52,7 @@
/**
* Called when a calendar's selected date bind type has changed.
- *
+ *
* @param calendar
* @param previousSelectedDateBindType
*/
@@ -60,7 +60,7 @@
/**
* Called when a calendar's selected date bind mapping has changed.
- *
+ *
* @param calendar
* @param previousSelectedDateBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/CalendarButton.java b/wtk/src/org/apache/pivot/wtk/CalendarButton.java
index 56a0d64..fd7c70f 100644
--- a/wtk/src/org/apache/pivot/wtk/CalendarButton.java
+++ b/wtk/src/org/apache/pivot/wtk/CalendarButton.java
@@ -218,7 +218,7 @@
/**
* Returns the currently selected date.
- *
+ *
* @return The currently selected date, or <tt>null</tt> if nothing is
* selected.
*/
@@ -228,7 +228,7 @@
/**
* Sets the selected date.
- *
+ *
* @param selectedDate The date to select, or <tt>null</tt> to clear the
* selection.
*/
@@ -245,7 +245,7 @@
* Sets the selected date to the date represented by the specified date
* string. The date string must be in the <tt>ISO 8601</tt> "calendar date"
* format, which is <tt>[YYYY]-[MM]-[DD]</tt>.
- *
+ *
* @param selectedDate A string in the form of <tt>[YYYY]-[MM]-[DD]</tt>
* (e.g. 2008-07-23)
*/
@@ -266,7 +266,7 @@
/**
* Sets the locale used to present calendar data.
- *
+ *
* @param locale
*/
public void setLocale(Locale locale) {
@@ -283,7 +283,7 @@
/**
* Sets the locale used to present calendar data.
- *
+ *
* @param locale An dictionary containing values for language, country, and
* variant. Country and variant are optional but the must adhere to the
* following rules: <ul> <li>If variant is specified, language and country
@@ -310,7 +310,7 @@
/**
* Sets the locale used to present calendar data.
- *
+ *
* @param locale A JSON map containing values for language, country, and
* variant.
* @see #setLocale(Dictionary)
diff --git a/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java b/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java
index d762444..2902bc1 100644
--- a/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java
@@ -45,7 +45,7 @@
/**
* Called when a calendar button's selected date key has changed.
- *
+ *
* @param calendarButton
* @param previousSelectedDateKey
*/
@@ -53,7 +53,7 @@
/**
* Called when a calendar button's selected date bind type has changed.
- *
+ *
* @param calendarButton
* @param previousSelectedDateBindType
*/
@@ -62,7 +62,7 @@
/**
* Called when a calendar button's selected date bind mapping has changed.
- *
+ *
* @param calendarButton
* @param previousSelectedDateBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java b/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java
index a11dc74..a650374 100644
--- a/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java
+++ b/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java
@@ -53,7 +53,7 @@
/**
* Called when a calendar button's year value has changed.
- *
+ *
* @param calendarButton
* @param previousYear
*/
@@ -61,7 +61,7 @@
/**
* Called when a calendar button's month value has changed.
- *
+ *
* @param calendarButton
* @param previousMonth
*/
@@ -69,7 +69,7 @@
/**
* Called when a calendar button's locale has changed.
- *
+ *
* @param calendarButton
* @param previousLocale
*/
@@ -77,7 +77,7 @@
/**
* Called when a calendar button's disabled date filter has changed.
- *
+ *
* @param calendarButton
* @param previousDisabledDateFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java b/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java
index 702bc9b..3c04e61 100644
--- a/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java
@@ -24,7 +24,7 @@
public interface CalendarButtonSelectionListener {
/**
* Called when a calendar button's selected date has changed.
- *
+ *
* @param calendarButton
* @param previousSelectedDate
*/
diff --git a/wtk/src/org/apache/pivot/wtk/CalendarListener.java b/wtk/src/org/apache/pivot/wtk/CalendarListener.java
index 8218bce..8e3bb3b 100644
--- a/wtk/src/org/apache/pivot/wtk/CalendarListener.java
+++ b/wtk/src/org/apache/pivot/wtk/CalendarListener.java
@@ -53,7 +53,7 @@
/**
* Called when a calendar's year value has changed.
- *
+ *
* @param calendar
* @param previousYear
*/
@@ -61,7 +61,7 @@
/**
* Called when a calendar's month value has changed.
- *
+ *
* @param calendar
* @param previousMonth
*/
@@ -69,7 +69,7 @@
/**
* Called when a calendar's locale has changed.
- *
+ *
* @param calendar
* @param previousLocale
*/
@@ -77,7 +77,7 @@
/**
* Called when a calendar's disabled date filter has changed.
- *
+ *
* @param calendar
* @param previousDisabledDateFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java b/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java
index d1d1079..5393d42 100644
--- a/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java
@@ -24,7 +24,7 @@
public interface CalendarSelectionListener {
/**
* Called when a calendar's selected date has changed.
- *
+ *
* @param calendar
* @param previousSelectedDate
*/
diff --git a/wtk/src/org/apache/pivot/wtk/CardPane.java b/wtk/src/org/apache/pivot/wtk/CardPane.java
index cbc04d7..9ba0974 100644
--- a/wtk/src/org/apache/pivot/wtk/CardPane.java
+++ b/wtk/src/org/apache/pivot/wtk/CardPane.java
@@ -62,7 +62,7 @@
/**
* Returns the currently selected card index.
- *
+ *
* @return The selected card index, or <tt>-1</tt> if no card is selected.
*/
public int getSelectedIndex() {
@@ -71,7 +71,7 @@
/**
* Sets the selected card index.
- *
+ *
* @param selectedIndex The selected card index, or <tt>-1</tt> for no
* selection.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/CardPaneListener.java b/wtk/src/org/apache/pivot/wtk/CardPaneListener.java
index 54b97f7..ded695a 100644
--- a/wtk/src/org/apache/pivot/wtk/CardPaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/CardPaneListener.java
@@ -44,7 +44,7 @@
/**
* Called to preview a selected index change.
- *
+ *
* @param cardPane The source of the event.
* @param selectedIndex The index that will be selected.
*/
@@ -52,7 +52,7 @@
/**
* Called when a selected index change has been vetoed.
- *
+ *
* @param cardPane The source of the event.
* @param reason The reason the event was vetoed.
*/
@@ -60,7 +60,7 @@
/**
* Called when a card pane's selected index has changed.
- *
+ *
* @param cardPane The source of the event.
* @param previousSelectedIndex If the selection changed directly, contains
* the index that was previously selected. Otherwise, contains the current
diff --git a/wtk/src/org/apache/pivot/wtk/Clipboard.java b/wtk/src/org/apache/pivot/wtk/Clipboard.java
index 534cf95..ff023de 100644
--- a/wtk/src/org/apache/pivot/wtk/Clipboard.java
+++ b/wtk/src/org/apache/pivot/wtk/Clipboard.java
@@ -48,7 +48,7 @@
/**
* Places content on the clipboard.
- *
+ *
* @param content
*/
public static void setContent(LocalManifest content) {
@@ -57,7 +57,7 @@
/**
* Places content on the clipboard.
- *
+ *
* @param content
*/
public static void setContent(LocalManifest content,
diff --git a/wtk/src/org/apache/pivot/wtk/ColorChooser.java b/wtk/src/org/apache/pivot/wtk/ColorChooser.java
index d67465e..86c148c 100644
--- a/wtk/src/org/apache/pivot/wtk/ColorChooser.java
+++ b/wtk/src/org/apache/pivot/wtk/ColorChooser.java
@@ -31,14 +31,14 @@
public interface SelectedColorBindMapping {
/**
* Converts a context value to a color.
- *
+ *
* @param value
*/
public Color toColor(Object value);
/**
* Converts a color to a context value.
- *
+ *
* @param color
*/
public Object valueOf(Color color);
@@ -112,7 +112,7 @@
/**
* Sets the selected color.
- *
+ *
* @param selectedColor The color to select, or <tt>null</tt> to clear the
* selection.
*/
@@ -128,7 +128,7 @@
/**
* Sets the selected color.
- *
+ *
* @param selectedColor The color to select, or <tt>null</tt> to clear the
* selection.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java b/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java
index b534c46..3874a6c 100644
--- a/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java
@@ -45,7 +45,7 @@
/**
* Called when a color chooser's selected color key has changed.
- *
+ *
* @param colorChooser
* @param previousSelectedColorKey
*/
@@ -53,7 +53,7 @@
/**
* Called when a color chooser's selected color bind type has changed.
- *
+ *
* @param colorChooser
* @param previousSelectedColorBindType
*/
@@ -62,7 +62,7 @@
/**
* Called when a color chooser's selected color bind mapping has changed.
- *
+ *
* @param colorChooser
* @param previousSelectedColorBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ColorChooserButton.java b/wtk/src/org/apache/pivot/wtk/ColorChooserButton.java
index 3a15acf..db493f3 100644
--- a/wtk/src/org/apache/pivot/wtk/ColorChooserButton.java
+++ b/wtk/src/org/apache/pivot/wtk/ColorChooserButton.java
@@ -135,7 +135,7 @@
/**
* Returns the currently selected color.
- *
+ *
* @return The currently selected color, or <tt>null</tt> if nothing is
* selected.
*/
@@ -145,7 +145,7 @@
/**
* Sets the selected color.
- *
+ *
* @param selectedColor The color to select, or <tt>null</tt> to clear the
* selection.
*/
@@ -161,7 +161,7 @@
/**
* Sets the selected color.
- *
+ *
* @param selectedColor A string representing a color.
*/
public final void setSelectedColor(String selectedColor) {
diff --git a/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java b/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java
index 1fd2eb2..b853e4e 100644
--- a/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java
@@ -45,7 +45,7 @@
/**
* Called when a color chooser button's selected color key has changed.
- *
+ *
* @param colorChooserButton
* @param previousSelectedColorKey
*/
@@ -55,7 +55,7 @@
/**
* Called when a color chooser button's selected color bind type has
* changed.
- *
+ *
* @param colorChooserButton
* @param previousSelectedColorBindType
*/
@@ -65,7 +65,7 @@
/**
* Called when a color chooser button's selected color bind mapping has
* changed.
- *
+ *
* @param colorChooserButton
* @param previousSelectedColorBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java b/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java
index 2f1ca27..43ac838 100644
--- a/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java
@@ -24,7 +24,7 @@
public interface ColorChooserButtonSelectionListener {
/**
* Called when a color chooser button's selected color has changed.
- *
+ *
* @param colorChooserButton
* @param previousSelectedColor
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java b/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java
index fb5257f..fb738fa 100644
--- a/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java
@@ -24,7 +24,7 @@
public interface ColorChooserSelectionListener {
/**
* Called when a color chooser's selected color has changed.
- *
+ *
* @param colorChooser
* @param previousSelectedColor
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Component.java b/wtk/src/org/apache/pivot/wtk/Component.java
index 8437ccf..549cc26 100644
--- a/wtk/src/org/apache/pivot/wtk/Component.java
+++ b/wtk/src/org/apache/pivot/wtk/Component.java
@@ -69,7 +69,7 @@
* executed, regardless of whether the new value differs from the old
* value or not.<br/><br/> This behaviour may change in the future so
* should not be relied upon.
- *
+ *
* @param key Style whose value will be overwritten
* @param value Value to be stored
* @return The previous value of the specified style (See note above)
@@ -697,7 +697,7 @@
/**
* Returns the component's automation ID.
- *
+ *
* @return The component's automation ID, or <tt>null</tt> if the component
* does not have an automation ID.
*/
@@ -709,7 +709,7 @@
* Sets the component's automation ID. This value can be used to obtain a
* reference to the component via {@link Automation#get(String)} when the
* component is attached to a component hierarchy.
- *
+ *
* @param automationID The automation ID to use for the component, or
* <tt>null</tt> to clear the automation ID.
*/
@@ -730,7 +730,7 @@
/**
* Returns the currently installed skin.
- *
+ *
* @return The currently installed skin.
*/
protected Skin getSkin() {
@@ -739,7 +739,7 @@
/**
* Sets the skin, replacing any previous skin.
- *
+ *
* @param skin The new skin.
*/
@SuppressWarnings("unchecked")
@@ -780,7 +780,7 @@
/**
* Installs the skin for the given component class, as defined by the
* current theme.
- *
+ *
* @param componentClass
*/
@SuppressWarnings("unchecked")
@@ -908,7 +908,7 @@
/**
* NOTE This method should only be called during layout. Callers should use
* {@link #setPreferredSize(int, int)}.
- *
+ *
* @param width
* @param height
*/
@@ -958,7 +958,7 @@
/**
* Returns the component's constrained preferred width.
- *
+ *
* @param height The height value by which the preferred width should be
* constrained, or <tt>-1</tt> for no constraint.
* @return The constrained preferred width.
@@ -987,7 +987,7 @@
/**
* Sets the component's preferred width.
- *
+ *
* @param preferredWidth The preferred width value, or <tt>-1</tt> to use
* the default value determined by the skin.
*/
@@ -998,7 +998,7 @@
/**
* Returns a flag indicating whether the preferred width was explicitly set
* by the caller or is the default value determined by the skin.
- *
+ *
* @return <tt>true</tt> if the preferred width was explicitly set;
* <tt>false</tt>, otherwise.
*/
@@ -1015,7 +1015,7 @@
/**
* Returns the component's constrained preferred height.
- *
+ *
* @param width The width value by which the preferred height should be
* constrained, or <tt>-1</tt> for no constraint.
* @return The constrained preferred height.
@@ -1044,7 +1044,7 @@
/**
* Sets the component's preferred height.
- *
+ *
* @param preferredHeight The preferred height value, or <tt>-1</tt> to use
* the default value determined by the skin.
*/
@@ -1055,7 +1055,7 @@
/**
* Returns a flag indicating whether the preferred height was explicitly set
* by the caller or is the default value determined by the skin.
- *
+ *
* @return <tt>true</tt> if the preferred height was explicitly set;
* <tt>false</tt>, otherwise.
*/
@@ -1112,7 +1112,7 @@
/**
* Sets the component's preferred size.
- *
+ *
* @param preferredWidth The preferred width value, or <tt>-1</tt> to use
* the default value determined by the skin.
* @param preferredHeight The preferred height value, or <tt>-1</tt> to use
@@ -1146,7 +1146,7 @@
/**
* Returns a flag indicating whether the preferred size was explicitly set
* by the caller or is the default value determined by the skin.
- *
+ *
* @return <tt>true</tt> if the preferred size was explicitly set;
* <tt>false</tt>, otherwise.
*/
@@ -1163,7 +1163,7 @@
/**
* Sets the minimum width of this component.
- *
+ *
* @param minimumWidth
*/
public void setMinimumWidth(int minimumWidth) {
@@ -1179,7 +1179,7 @@
/**
* Sets the maximum width of this component.
- *
+ *
* @param maximumWidth
*/
public void setMaximumWidth(int maximumWidth) {
@@ -1195,7 +1195,7 @@
/**
* Sets the width limits for this component.
- *
+ *
* @param minimumWidth
* @param maximumWidth
*/
@@ -1223,7 +1223,7 @@
/**
* Sets the width limits for this component.
- *
+ *
* @param widthLimits
*/
public final void setWidthLimits(Limits widthLimits) {
@@ -1243,7 +1243,7 @@
/**
* Sets the minimum height of this component.
- *
+ *
* @param minimumHeight
*/
public void setMinimumHeight(int minimumHeight) {
@@ -1259,7 +1259,7 @@
/**
* Sets the maximum height of this component.
- *
+ *
* @param maximumHeight
*/
public void setMaximumHeight(int maximumHeight) {
@@ -1275,7 +1275,7 @@
/**
* Sets the height limits for this component.
- *
+ *
* @param minimumHeight
* @param maximumHeight
*/
@@ -1304,7 +1304,7 @@
/**
* Sets the height limits for this component.
- *
+ *
* @param heightLimits
*/
public final void setHeightLimits(Limits heightLimits) {
@@ -1317,7 +1317,7 @@
/**
* Returns the component's x-coordinate.
- *
+ *
* @return The component's horizontal position relative to the origin of the
* parent container.
*/
@@ -1327,7 +1327,7 @@
/**
* Sets the component's x-coordinate.
- *
+ *
* @param x The component's horizontal position relative to the origin of
* the parent container.
*/
@@ -1337,7 +1337,7 @@
/**
* Returns the component's y-coordinate.
- *
+ *
* @return The component's vertical position relative to the origin of the
* parent container.
*/
@@ -1347,7 +1347,7 @@
/**
* Sets the component's y-coordinate.
- *
+ *
* @param y The component's vertical position relative to the origin of the
* parent container.
*/
@@ -1357,7 +1357,7 @@
/**
* Returns the component's location.
- *
+ *
* @return A point value containing the component's horizontal and vertical
* position relative to the origin of the parent container.
*/
@@ -1370,7 +1370,7 @@
* when performing layout. However, since some containers do not reposition
* components during layout, it is valid for callers to invoke this method
* directly when such containers.
- *
+ *
* @param x The component's horizontal position relative to the origin of
* the parent container.
* @param y The component's vertical position relative to the origin of the
@@ -1401,7 +1401,7 @@
/**
* Sets the component's location.
- *
+ *
* @param location A point value containing the component's horizontal and
* vertical position relative to the origin of the parent container.
* @see #setLocation(int, int)
@@ -1416,7 +1416,7 @@
/**
* Returns the component's baseline.
- *
+ *
* @return The baseline relative to the origin of this component, or
* <tt>-1</tt> if this component does not have a baseline.
*/
@@ -1431,7 +1431,7 @@
/**
* Returns the component's baseline for a given width and height.
- *
+ *
* @return The baseline relative to the origin of this component, or
* <tt>-1</tt> if this component does not have a baseline.
*/
@@ -1442,7 +1442,7 @@
/**
* Returns the component's bounding area.
- *
+ *
* @return The component's bounding area. The <tt>x</tt> and <tt>y</tt>
* values are relative to the parent container.
*/
@@ -1452,7 +1452,7 @@
/**
* Returns the component's bounding area including decorators.
- *
+ *
* @return The decorated bounding area. The <tt>x</tt> and <tt>y</tt> values
* are relative to the parent container.
*/
@@ -1470,7 +1470,7 @@
/**
* Determines if the component contains a given location. This method
* facilitates mouse interaction with non-rectangular components.
- *
+ *
* @param xArgument
* @param yArgument
* @return <tt>true</tt> if the component's shape contains the given
@@ -1485,7 +1485,7 @@
/**
* Returns the component's visibility.
- *
+ *
* @return <tt>true</tt> if the component will be painted; <tt>false</tt>,
* otherwise.
*/
@@ -1495,7 +1495,7 @@
/**
* Sets the component's visibility.
- *
+ *
* @param visible <tt>true</tt> if the component should be painted;
* <tt>false</tt>, otherwise.
*/
@@ -1542,7 +1542,7 @@
/**
* Returns the component's decorator sequence.
- *
+ *
* @return The component's decorator sequence
*/
public DecoratorSequence getDecorators() {
@@ -1552,7 +1552,7 @@
/**
* Maps a point in this component's coordinate system to the specified
* ancestor's coordinate space.
- *
+ *
* @param xArgument The x-coordinate in this component's coordinate space
* @param yArgument The y-coordinate in this component's coordinate space
* @return A point containing the translated coordinates, or <tt>null</tt> if
@@ -1587,7 +1587,7 @@
/**
* Maps a point in this component's coordinate system to the specified
* ancestor's coordinate space.
- *
+ *
* @param location The coordinates in this component's coordinate space
* @return A point containing the translated coordinates, or <tt>null</tt> if
* the component is not a descendant of the specified ancestor.
@@ -1603,7 +1603,7 @@
/**
* Maps a point in the specified ancestor's coordinate space to this
* component's coordinate system.
- *
+ *
* @param xArgument The x-coordinate in the ancestors's coordinate space.
* @param yArgument The y-coordinate in the ancestor's coordinate space.
* @return A point containing the translated coordinates, or <tt>null</tt> if
@@ -1645,7 +1645,7 @@
/**
* Determines if this component is showing. To be showing, the component and
* all of its ancestors must be visible and attached to a display.
- *
+ *
* @return <tt>true</tt> if this component is showing; <tt>false</tt>
* otherwise.
*/
@@ -1663,7 +1663,7 @@
* Determines the visible area of a component. The visible area is defined
* as the intersection of the component's area with the visible area of its
* ancestors, or, in the case of a Viewport, the viewport bounds.
- *
+ *
* @return The visible area of the component in the component's coordinate
* space, or <tt>null</tt> if the component is either not showing or not
* part of the component hierarchy.
@@ -1676,7 +1676,7 @@
* Determines the visible area of a component. The visible area is defined
* as the intersection of the component's area with the visible area of its
* ancestors, or, in the case of a Viewport, the viewport bounds.
- *
+ *
* @param area
* @return The visible area of the component in the component's coordinate
* space, or <tt>null</tt> if the component is either not showing or not
@@ -1694,7 +1694,7 @@
* Determines the visible area of a component. The visible area is defined
* as the intersection of the component's area with the visible area of its
* ancestors, or, in the case of a Viewport, the viewport bounds.
- *
+ *
* @param xArgument
* @param yArgument
* @param width
@@ -1753,7 +1753,7 @@
/**
* Ensures that the given area of a component is visible within the
* viewports of all applicable ancestors.
- *
+ *
* @param area
*/
public void scrollAreaToVisible(Bounds area) {
@@ -1767,7 +1767,7 @@
/**
* Ensures that the given area of a component is visible within the
* viewports of all applicable ancestors.
- *
+ *
* @param xArgument
* @param yArgument
* @param width
@@ -1915,7 +1915,7 @@
/**
* Flags the entire component as needing to be repainted.
- *
+ *
* @param immediate
*/
public final void repaint(boolean immediate) {
@@ -1924,7 +1924,7 @@
/**
* Flags an area as needing to be repainted.
- *
+ *
* @param area
*/
public final void repaint(Bounds area) {
@@ -1934,7 +1934,7 @@
/**
* Flags an area as needing to be repainted or repaints the rectangle
* immediately.
- *
+ *
* @param area
* @param immediate
*/
@@ -1948,7 +1948,7 @@
/**
* Flags an area as needing to be repainted.
- *
+ *
* @param xArgument
* @param yArgument
* @param width
@@ -1960,7 +1960,7 @@
/**
* Flags an area as needing to be repainted.
- *
+ *
* @param xArgument
* @param yArgument
* @param width
@@ -2026,7 +2026,7 @@
* Creates a graphics context for this component. This graphics context will
* not be double buffered. In other words, drawing operations on it will
* operate directly on the video RAM.
- *
+ *
* @return A graphics context for this component, or <tt>null</tt> if this
* component is not showing.
* @see #isShowing()
@@ -2064,7 +2064,7 @@
/**
* Returns the component's enabled state.
- *
+ *
* @return <tt>true</tt> if the component is enabled; <tt>false</tt>,
* otherwise.
*/
@@ -2075,7 +2075,7 @@
/**
* Sets the component's enabled state. Enabled components respond to user
* input events; disabled components do not.
- *
+ *
* @param enabled <tt>true</tt> if the component is enabled; <tt>false</tt>,
* otherwise.
*/
@@ -2102,7 +2102,7 @@
/**
* Determines if this component is blocked. A component is blocked if the
* component or any of its ancestors is disabled.
- *
+ *
* @return <tt>true</tt> if the component is blocked; <tt>false</tt>,
* otherwise.
*/
@@ -2121,7 +2121,7 @@
/**
* Determines if the mouse is positioned over this component.
- *
+ *
* @return <tt>true</tt> if the mouse is currently located over this
* component; <tt>false</tt>, otherwise.
*/
@@ -2131,7 +2131,7 @@
/**
* Returns the current mouse location in the component's coordinate space.
- *
+ *
* @return The current mouse location, or <tt>null</tt> if the mouse is not
* currently positioned over this component.
*/
@@ -2142,7 +2142,7 @@
/**
* Returns the cursor that is displayed when the mouse pointer is over this
* component.
- *
+ *
* @return The cursor that is displayed over the component.
*/
public Cursor getCursor() {
@@ -2152,7 +2152,7 @@
/**
* Sets the cursor that is displayed when the mouse pointer is over this
* component.
- *
+ *
* @param cursor The cursor to display over the component, or <tt>null</tt>
* to inherit the cursor of the parent container.
*/
@@ -2172,7 +2172,7 @@
/**
* Returns the component's tooltip text.
- *
+ *
* @return The component's tooltip text, or <tt>null</tt> if no tooltip is
* specified.
*/
@@ -2182,7 +2182,7 @@
/**
* Sets the component's tooltip text.
- *
+ *
* @param tooltipText The component's tooltip text, or <tt>null</tt> for no
* tooltip.
*/
@@ -2197,7 +2197,7 @@
/**
* Returns the component's tooltip delay.
- *
+ *
* @return The tooltip delay, in milliseconds.
*/
public int getTooltipDelay() {
@@ -2206,7 +2206,7 @@
/**
* Sets the component's tooltip delay.
- *
+ *
* @param tooltipDelay The tooltip delay, in milliseconds.
*/
public void setTooltipDelay(int tooltipDelay) {
@@ -2220,7 +2220,7 @@
/**
* Returns the tooltip's mode for wrapping its text.
- *
+ *
* @return <tt>true</tt> if the tooltip text wrap mode is enabled;
* </tt>false</tt> if not.
*/
@@ -2230,7 +2230,7 @@
/**
* Sets the tooltip's text wrapping mode.
- *
+ *
* @param tooltipWrapText The component's tooltip text wrap mode.
*/
public void setTooltipWrapText(boolean tooltipWrapText) {
@@ -2245,7 +2245,7 @@
/**
* Tells whether or not this component is fully opaque when painted.
- *
+ *
* @return <tt>true</tt> if this component is opaque; </tt>false</tt> if any
* part of it is transparent or translucent.
*/
@@ -2257,7 +2257,7 @@
* Returns this component's focusability. A focusable component is capable
* of receiving the focus only when it is showing, unblocked, and its window
* is not closing.
- *
+ *
* @return <tt>true</tt> if the component is capable of receiving the focus;
* <tt>false</tt>, otherwise.
*/
@@ -2290,7 +2290,7 @@
/**
* Returns the component's focused state.
- *
+ *
* @return <tt>true</tt> if the component has the input focus;
* <tt>false</tt> otherwise.
*/
@@ -2300,7 +2300,7 @@
/**
* Called to notify a component that its focus state has changed.
- *
+ *
* @param focused <tt>true</tt> if the component has received the input
* focus; <tt>false</tt> if the component has lost the focus.
* @param obverseComponent If <tt>focused</tt> is true, the component that
@@ -2318,7 +2318,7 @@
/**
* Requests that focus be given to this component.
- *
+ *
* @return <tt>true</tt> if the component gained the focus; <tt>false</tt>
* otherwise.
*/
@@ -2337,7 +2337,7 @@
/**
* Transfers focus to the next focusable component.
- *
+ *
* @param direction The direction in which to transfer focus.
*/
public Component transferFocus(FocusTraversalDirection direction) {
@@ -2353,7 +2353,7 @@
/**
* Returns the currently focused component.
- *
+ *
* @return The component that currently has the focus, or <tt>null</tt> if
* no component is focused.
*/
@@ -2363,7 +2363,7 @@
/**
* Sets the focused component.
- *
+ *
* @param focusedComponent The component to focus, or <tt>null</tt> to clear
* the focus.
*/
@@ -2396,7 +2396,7 @@
* Copies bound values from the bind context to the component. This
* functionality must be provided by the subclass; the base implementation
* is a no-op.
- *
+ *
* @param context
*/
public void load(Object context) {
@@ -2407,7 +2407,7 @@
* Copies bound values from the component to the bind context. This
* functionality must be provided by the subclass; the base implementation
* is a no-op.
- *
+ *
* @param context
*/
public void store(Object context) {
@@ -2469,7 +2469,7 @@
/**
* Sets the component's name.
- *
+ *
* @param name
*/
public void setName(String name) {
@@ -2490,7 +2490,7 @@
/**
* Applies a set of styles.
- *
+ *
* @param styles A map containing the styles to apply.
*/
public void setStyles(Map<String, ?> styles) {
@@ -2505,7 +2505,7 @@
/**
* Applies a set of styles.
- *
+ *
* @param styles The styles encoded as a JSON map.
*/
public void setStyles(String styles) throws SerializationException {
@@ -2532,7 +2532,7 @@
/**
* Applies a set of named styles.
- *
+ *
* @param styleName
*/
public void setStyleName(String styleName) {
@@ -2551,7 +2551,7 @@
/**
* Applies a set of named styles.
- *
+ *
* @param styleNames
*/
public void setStyleNames(Sequence<String> styleNames) {
@@ -2566,7 +2566,7 @@
/**
* Applies a set of named styles.
- *
+ *
* @param styleNames
*/
public void setStyleNames(String styleNames) {
@@ -2593,7 +2593,7 @@
* Gets the specified component attribute. While attributes can be used to
* store arbitrary data, they are intended to be used by containers to store
* layout-related metadata in their child components.
- *
+ *
* @param key The attribute key
* @return The attribute value, or <tt>null</tt> if no such attribute exists
*/
@@ -2612,7 +2612,7 @@
* Sets the specified component attribute. While attributes can be used to
* store arbitrary data, they are intended to be used by containers to store
* layout-related metadata in their child components.
- *
+ *
* @param key The attribute key
* @param value The attribute value, or <tt>null</tt> to clear the attribute
* @return The previous value of the attribute, or <tt>null</tt> if the
@@ -2847,7 +2847,7 @@
/**
* Provide a nice exception message for out of range values.
- *
+ *
* @throws IndexOutOfBoundsException if index is out of range.
*/
protected static final void indexBoundsCheck(String indexName, int index, int min, int max)
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java b/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java
index 6649d59..1de3738 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java
@@ -22,7 +22,7 @@
public interface ComponentClassListener {
/**
* Called when the focused component changes.
- *
+ *
* @param previousFocusedComponent
*/
public void focusedComponentChanged(Component previousFocusedComponent);
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java b/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java
index 4b567fa..d13dcb9 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java
@@ -42,7 +42,7 @@
/**
* Called when a value has been added to a component's user data dictionary.
- *
+ *
* @param component
* @param key
*/
@@ -51,7 +51,7 @@
/**
* Called when a value has been updated in a component's user data
* dictionary.
- *
+ *
* @param component
* @param key
* @param previousValue
@@ -61,7 +61,7 @@
/**
* Called when a value has been removed from a component's user data
* dictionary.
- *
+ *
* @param component
* @param key
* @param value
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java b/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java
index 6fb602a..af0af88 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java
@@ -46,7 +46,7 @@
/**
* Called when a decorator has been inserted into a component's decorator
* sequence.
- *
+ *
* @param component
* @param index
*/
@@ -55,7 +55,7 @@
/**
* Called when a decorator has been updated in a component's decorator
* sequence.
- *
+ *
* @param component
* @param index
* @param previousDecorator
@@ -65,7 +65,7 @@
/**
* Called when decorators have been removed from a component's decorator
* sequence.
- *
+ *
* @param component
* @param index
* @param decorators
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java b/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java
index d46b704..d59fd8c 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java
@@ -43,7 +43,7 @@
/**
* Called when a key has been typed.
- *
+ *
* @param component
* @param character
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
@@ -53,7 +53,7 @@
/**
* Called when a key has been pressed.
- *
+ *
* @param component
* @param keyCode
* @param keyLocation
@@ -64,7 +64,7 @@
/**
* Called when a key has been released.
- *
+ *
* @param component
* @param keyCode
* @param keyLocation
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentListener.java b/wtk/src/org/apache/pivot/wtk/ComponentListener.java
index e4a7af6..77b8ce7 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentListener.java
@@ -101,7 +101,7 @@
/**
* Called when a component's parent has changed (when the component is
* either added to or removed from a container).
- *
+ *
* @param component
* @param previousParent
*/
@@ -109,7 +109,7 @@
/**
* Called when a component's size has changed.
- *
+ *
* @param component
* @param previousWidth
* @param previousHeight
@@ -118,7 +118,7 @@
/**
* Called when a component's preferred size has changed.
- *
+ *
* @param component
* @param previousPreferredWidth
* @param previousPreferredHeight
@@ -128,7 +128,7 @@
/**
* Called when a component's preferred width limits have changed.
- *
+ *
* @param component
* @param previousMinimumWidth
* @param previousMaximumWidth
@@ -138,7 +138,7 @@
/**
* Called when a component's preferred height limits have changed.
- *
+ *
* @param component
* @param previousMinimumHeight
* @param previousMaximumHeight
@@ -148,7 +148,7 @@
/**
* Called when a component's location has changed.
- *
+ *
* @param component
* @param previousX
* @param previousY
@@ -157,14 +157,14 @@
/**
* Called when a component's visible flag has changed.
- *
+ *
* @param component
*/
public void visibleChanged(Component component);
/**
* Called when a component's cursor has changed.
- *
+ *
* @param component
* @param previousCursor
*/
@@ -172,7 +172,7 @@
/**
* Called when a component's tooltip text has changed.
- *
+ *
* @param component
* @param previousTooltipText
*/
@@ -180,7 +180,7 @@
/**
* Called when a component's tooltip delay has changed.
- *
+ *
* @param component
* @param previousTooltipDelay
*/
@@ -188,7 +188,7 @@
/**
* Called when a component's drag source has changed.
- *
+ *
* @param component
* @param previousDragSource
*/
@@ -196,7 +196,7 @@
/**
* Called when a component's drop target has changed.
- *
+ *
* @param component
* @param previousDropTarget
*/
@@ -204,7 +204,7 @@
/**
* Called when a component's context menu handler has changed.
- *
+ *
* @param component
* @param previousMenuHandler
*/
@@ -212,7 +212,7 @@
/**
* Called when a component's name has changed.
- *
+ *
* @param component
* @param previousName
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java b/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java
index 61193a9..84f6059 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java
@@ -42,7 +42,7 @@
/**
* Called when a mouse button is pressed over a component.
- *
+ *
* @param component
* @param button
* @param x
@@ -54,7 +54,7 @@
/**
* Called when a mouse button is released over a component.
- *
+ *
* @param component
* @param button
* @param x
@@ -66,7 +66,7 @@
/**
* Called when a mouse button is clicked over a component.
- *
+ *
* @param component
* @param button
* @param x
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java b/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java
index a7012fe..43beba2 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java
@@ -43,7 +43,7 @@
/**
* Called when the mouse is moved over a component.
- *
+ *
* @param component
* @param x
* @param y
@@ -54,14 +54,14 @@
/**
* Called when the mouse enters a component.
- *
+ *
* @param component
*/
public void mouseOver(Component component);
/**
* Called when the mouse exits a component.
- *
+ *
* @param component
*/
public void mouseOut(Component component);
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java b/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java
index c58c0bd..faf262e 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java
@@ -22,7 +22,7 @@
public interface ComponentMouseWheelListener {
/**
* Called when the mouse wheel is scrolled over a component.
- *
+ *
* @param component
* @param scrollType
* @param scrollAmount
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentStateListener.java b/wtk/src/org/apache/pivot/wtk/ComponentStateListener.java
index 1f7390a..734ab7b 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentStateListener.java
@@ -41,7 +41,7 @@
* <code>enabled</code> flag has already been set when this method is called
* so the new state can be determined by calling the
* {@link Component#isEnabled} method.
- *
+ *
* @param component The component whose enabled state is changing.
*/
public void enabledChanged(Component component);
@@ -52,7 +52,7 @@
* currently focused component has already been set when this method is
* called, so that the new state of the component can be determined by
* calling the {@link Component#isFocused} method.
- *
+ *
* @param component The component that is either gaining focus or the one
* that previously had focus and is now losing it.
* @param obverseComponent If the component is gaining focus, this is the
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentStyleListener.java b/wtk/src/org/apache/pivot/wtk/ComponentStyleListener.java
index 4bf1a6d..b33e9a1 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentStyleListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentStyleListener.java
@@ -22,7 +22,7 @@
public interface ComponentStyleListener {
/**
* Called when a component style has been updated.
- *
+ *
* @param component Component the style belongs to
* @param styleKey The name of the style
* @param previousValue The previous value for this style
diff --git a/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java b/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java
index 0f09ca4..8e8b861 100644
--- a/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java
@@ -22,7 +22,7 @@
public interface ComponentTooltipListener {
/**
* Called when a tooltip has been triggered over a component.
- *
+ *
* @param component
* @param x
* @param y
diff --git a/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java b/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java
index eaefe07..6c03fdf 100644
--- a/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java
+++ b/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java
@@ -22,7 +22,7 @@
public interface ConstrainedVisual extends Visual {
/**
* Sets the visual's render size.
- *
+ *
* @param width
* @param height
*/
@@ -31,7 +31,7 @@
/**
* Returns the visual's preferred width given the provided height
* constraint.
- *
+ *
* @param height The height by which to constrain the preferred width, or
* <tt>-1</tt> for no constraint.
*/
@@ -40,7 +40,7 @@
/**
* Returns the visual's preferred height given the provided width
* constraint.
- *
+ *
* @param width The width by which to constrain the preferred height, or
* <tt>-1</tt> for no constraint.
*/
@@ -53,7 +53,7 @@
/**
* Returns the baseline for a given width and height.
- *
+ *
* @param width
* @param height
* @return The baseline relative to the origin of this visual, or <tt>-1</tt>
diff --git a/wtk/src/org/apache/pivot/wtk/Container.java b/wtk/src/org/apache/pivot/wtk/Container.java
index 72815ef..2169953 100644
--- a/wtk/src/org/apache/pivot/wtk/Container.java
+++ b/wtk/src/org/apache/pivot/wtk/Container.java
@@ -219,7 +219,7 @@
/**
* Moves a component within the component sequence.
- *
+ *
* @param from
* @param to
*/
@@ -458,7 +458,7 @@
/**
* Tests if this container is an ancestor of a given component. A container
* is considered to be its own ancestor.
- *
+ *
* @param component The component to test.
* @return <tt>true</tt> if this container is an ancestor of
* <tt>component</tt>; <tt>false</tt> otherwise.
@@ -483,7 +483,7 @@
* Requests that focus be given to this container. If this container is not
* focusable, this requests that focus be set to the first focusable
* descendant in this container.
- *
+ *
* @return The component that got the focus, or <tt>null</tt> if the focus
* request was denied
*/
@@ -518,7 +518,7 @@
/**
* Transfers focus to the next focusable component.
- *
+ *
* @param component The component from which focus will be transferred.
* @param direction The direction in which to transfer focus.
*/
@@ -562,7 +562,7 @@
/**
* Sets this container's focus traversal policy.
- *
+ *
* @param focusTraversalPolicy The focus traversal policy to use with this
* container.
*/
@@ -578,7 +578,7 @@
/**
* Tests whether this container is an ancestor of the currently focused
* component.
- *
+ *
* @return <tt>true</tt> if a component is focused and this container is an
* ancestor of the component; <tt>false</tt>, otherwise.
*/
@@ -621,7 +621,7 @@
/**
* Propagates binding to subcomponents.
- *
+ *
* @param context
*/
@Override
@@ -633,7 +633,7 @@
/**
* Propagates binding to subcomponents.
- *
+ *
* @param context
*/
@Override
diff --git a/wtk/src/org/apache/pivot/wtk/ContainerListener.java b/wtk/src/org/apache/pivot/wtk/ContainerListener.java
index d1ca731..add514e 100644
--- a/wtk/src/org/apache/pivot/wtk/ContainerListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ContainerListener.java
@@ -51,7 +51,7 @@
/**
* Called when a component has been inserted into a container's component
* sequence.
- *
+ *
* @param container
* @param index
*/
@@ -60,7 +60,7 @@
/**
* Called when components have been removed from a container's component
* sequence.
- *
+ *
* @param container
* @param index
* @param removed
@@ -70,7 +70,7 @@
/**
* Called when a component has moved from one z-index to another within a
* container.
- *
+ *
* @param container
* @param from
* @param to
@@ -79,7 +79,7 @@
/**
* Called when a container's focus traversal policy has changed.
- *
+ *
* @param container
* @param previousFocusTraversalPolicy
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java b/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java
index 69dd454..e37d7c5 100644
--- a/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java
@@ -49,7 +49,7 @@
/**
* Called when the mouse is moved over a container.
- *
+ *
* @param container
* @param x
* @param y
@@ -60,7 +60,7 @@
/**
* Called when the mouse is pressed over a container.
- *
+ *
* @param container
* @param button
* @param x
@@ -72,7 +72,7 @@
/**
* Called when the mouse is released over a container.
- *
+ *
* @param container
* @param button
* @param x
@@ -84,7 +84,7 @@
/**
* Called when the mouse wheel is scrolled over a container.
- *
+ *
* @param container
* @param scrollType
* @param scrollAmount
diff --git a/wtk/src/org/apache/pivot/wtk/CornerRadii.java b/wtk/src/org/apache/pivot/wtk/CornerRadii.java
index fd05f20..c3cea33 100644
--- a/wtk/src/org/apache/pivot/wtk/CornerRadii.java
+++ b/wtk/src/org/apache/pivot/wtk/CornerRadii.java
@@ -100,7 +100,7 @@
/**
* Construct a {@link CornerRadii} object from a dictionary specifying
* values for each of the four corners
- *
+ *
* @param cornerRadii A dictionary with keys {@value #TOP_LEFT_KEY},
* {@value #TOP_RIGHT_KEY}, {@value #BOTTOM_LEFT_KEY},
* {@value #BOTTOM_RIGHT_KEY}, all with numeric values. Omitted values are
diff --git a/wtk/src/org/apache/pivot/wtk/DesktopApplicationContext.java b/wtk/src/org/apache/pivot/wtk/DesktopApplicationContext.java
index 7086e65..dd4feb2 100644
--- a/wtk/src/org/apache/pivot/wtk/DesktopApplicationContext.java
+++ b/wtk/src/org/apache/pivot/wtk/DesktopApplicationContext.java
@@ -65,14 +65,14 @@
/**
* Called when the host window for secondary display has been opened.
- *
+ *
* @param display
*/
public void hostWindowOpened(Display display);
/**
* Called when the host window for secondary display has been closed.
- *
+ *
* @param display
*/
public void hostWindowClosed(Display display);
@@ -403,7 +403,7 @@
/**
* Terminates the application context.
- *
+ *
* @param optional If <tt>true</tt>, shutdown is optional and may be
* cancelled. If <tt>false</tt>, shutdown cannot be cancelled.
*/
@@ -454,7 +454,7 @@
/**
* Primary application entry point.
- *
+ *
* @param args
*/
public static void main(String[] args) {
@@ -715,7 +715,7 @@
/**
* Sets the full-screen mode flag.
- *
+ *
* @param fullScreen
*/
public static void setFullScreen(boolean fullScreen) {
@@ -771,7 +771,7 @@
* its UI and the SplashScreen is ready to be dismissed, but can be safely
* called regardless of whether there is now, or used to be, a visible
* SplashScreen.
- *
+ *
* @param display Display to make visible
* @see java.awt.SplashScreen
*/
@@ -786,7 +786,7 @@
/**
* Sizes the window's native host frame to match its preferred size.
- *
+ *
* @param window
*/
public static void sizeHostToFit(Window window) {
@@ -807,7 +807,7 @@
/**
* Creates a new secondary display.
- *
+ *
* @param width
* @param height
* @param x
@@ -846,7 +846,7 @@
* into applications. For example: <code> public class MyApp implements
* Application { public static void main(String[] args) throws Exception {
* DesktopApplicationContext.main(MyApp.class, args); } } </code>
- *
+ *
* @param applicationClass
* @param applicationArgs
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Dialog.java b/wtk/src/org/apache/pivot/wtk/Dialog.java
index a884073..710d16e 100644
--- a/wtk/src/org/apache/pivot/wtk/Dialog.java
+++ b/wtk/src/org/apache/pivot/wtk/Dialog.java
@@ -120,7 +120,7 @@
/**
* Opens the dialog.
- *
+ *
* @param display The display on which the dialog will be opened.
* @param owner The window's owner. The dialog will be modal over this
* window.
@@ -132,7 +132,7 @@
/**
* Opens the dialog.
- *
+ *
* @param display The display on which the dialog will be opened.
* @param dialogCloseListenerArgument A listener that will be called when the
* dialog is closed.
@@ -143,7 +143,7 @@
/**
* Opens the dialog.
- *
+ *
* @param owner The window's owner. The dialog will be modal over this
* window.
* @param dialogCloseListenerArgument A listener that will be called when the
@@ -159,7 +159,7 @@
/**
* Opens the dialog.
- *
+ *
* @param display The display on which the dialog will be opened.
* @param owner The window's owner, or <tt>null</tt> if the window has no
* owner. Required if the dialog is modal.
diff --git a/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java b/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java
index 6ec50e2..276c951 100644
--- a/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java
+++ b/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java
@@ -22,7 +22,7 @@
public interface DialogCloseListener {
/**
* Called when a dialog has closed.
- *
+ *
* @param dialog
*/
public void dialogClosed(Dialog dialog, boolean modal);
diff --git a/wtk/src/org/apache/pivot/wtk/DialogListener.java b/wtk/src/org/apache/pivot/wtk/DialogListener.java
index 6be5ade..4f6b23d 100644
--- a/wtk/src/org/apache/pivot/wtk/DialogListener.java
+++ b/wtk/src/org/apache/pivot/wtk/DialogListener.java
@@ -22,7 +22,7 @@
public interface DialogListener {
/**
* Called when a dialog's modal flag has changed.
- *
+ *
* @param dialog
*/
public void modalChanged(Dialog dialog);
diff --git a/wtk/src/org/apache/pivot/wtk/DialogStateListener.java b/wtk/src/org/apache/pivot/wtk/DialogStateListener.java
index 3ef8dec..113f943 100644
--- a/wtk/src/org/apache/pivot/wtk/DialogStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/DialogStateListener.java
@@ -44,7 +44,7 @@
/**
* Called to preview a dialog close event.
- *
+ *
* @param dialog
* @param result
*/
@@ -52,7 +52,7 @@
/**
* Called when a dialog close event has been vetoed.
- *
+ *
* @param dialog
* @param reason
*/
diff --git a/wtk/src/org/apache/pivot/wtk/DragSource.java b/wtk/src/org/apache/pivot/wtk/DragSource.java
index 777621b..6c6ba92 100644
--- a/wtk/src/org/apache/pivot/wtk/DragSource.java
+++ b/wtk/src/org/apache/pivot/wtk/DragSource.java
@@ -22,7 +22,7 @@
public interface DragSource {
/**
* Called by the framework to initiate a drag operation.
- *
+ *
* @param component
* @param x
* @param y
@@ -32,7 +32,7 @@
/**
* Called by the framework to terminate a drag operation.
- *
+ *
* @param component
* @param dropAction
*/
@@ -40,7 +40,7 @@
/**
* Returns the drag source's native flag.
- *
+ *
* @return If <tt>true</tt>, the drag will be executed via the native OS.
* Otherwise, it will be executed locally.
*/
@@ -53,7 +53,7 @@
/**
* Returns a visual representing the drag content.
- *
+ *
* @return The drag visual, or <tt>null</tt> for no visual.
*/
public Visual getRepresentation();
@@ -61,7 +61,7 @@
/**
* Returns the offset of the mouse pointer within the drag visual. Not
* required unless a representation is specified.
- *
+ *
* @return The mouse offset within the drag visual, or <tt>null</tt> if no
* visual is specified.
*/
@@ -69,7 +69,7 @@
/**
* Returns the drop actions supported by this drag source.
- *
+ *
* @return A bitfield of the supported drop actions.
*/
public int getSupportedDropActions();
diff --git a/wtk/src/org/apache/pivot/wtk/DropTarget.java b/wtk/src/org/apache/pivot/wtk/DropTarget.java
index 11b2284..d554597 100644
--- a/wtk/src/org/apache/pivot/wtk/DropTarget.java
+++ b/wtk/src/org/apache/pivot/wtk/DropTarget.java
@@ -22,7 +22,7 @@
public interface DropTarget {
/**
* Called when the mouse first enters a drop target during a drag operation.
- *
+ *
* @param component
* @param dragContent
* @param supportedDropActions
@@ -35,7 +35,7 @@
/**
* Called when the mouse leaves a drop target during a drag operation.
- *
+ *
* @param component
*/
public void dragExit(Component component);
@@ -43,7 +43,7 @@
/**
* Called when the mouse is moved while positioned over a drop target during
* a drag operation.
- *
+ *
* @param component
* @param dragContent
* @param supportedDropActions
@@ -59,7 +59,7 @@
/**
* Called when the user drop action changes while the mouse is positioned
* over a drop target during a drag operation.
- *
+ *
* @param component
* @param dragContent
* @param supportedDropActions
@@ -74,7 +74,7 @@
/**
* Called to drop the drag content.
- *
+ *
* @param component
* @param dragContent
* @param supportedDropActions
diff --git a/wtk/src/org/apache/pivot/wtk/Editor.java b/wtk/src/org/apache/pivot/wtk/Editor.java
index 6bba94f..5a85c34 100644
--- a/wtk/src/org/apache/pivot/wtk/Editor.java
+++ b/wtk/src/org/apache/pivot/wtk/Editor.java
@@ -29,7 +29,7 @@
* Saves an edit that is in progress by updating the appropriate data
* object. It is up to implementations to define the behavior when
* <tt>isEditing() == false</tt>.
- *
+ *
* @return <tt>true</tt> if the changes were successfully saved;
* <tt>false</tt> otherwise.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Expander.java b/wtk/src/org/apache/pivot/wtk/Expander.java
index 2cdd2dc..da9dcbe 100644
--- a/wtk/src/org/apache/pivot/wtk/Expander.java
+++ b/wtk/src/org/apache/pivot/wtk/Expander.java
@@ -89,7 +89,7 @@
/**
* Returns the expander's title.
- *
+ *
* @return The pane's title, or <tt>null</tt> if no title is set.
*/
public String getTitle() {
@@ -98,7 +98,7 @@
/**
* Sets the expander's title.
- *
+ *
* @param title The new title, or <tt>null</tt> for no title.
*/
public void setTitle(String title) {
@@ -112,7 +112,7 @@
/**
* Returns the expander's collapsible flag.
- *
+ *
* @return The collapsible flag
*/
public boolean isCollapsible() {
@@ -121,7 +121,7 @@
/**
* Sets the expander's collapsible flag.
- *
+ *
* @param collapsible The collapsible flag
*/
public void setCollapsible(boolean collapsible) {
diff --git a/wtk/src/org/apache/pivot/wtk/ExpanderListener.java b/wtk/src/org/apache/pivot/wtk/ExpanderListener.java
index 34ca818..bcf41d2 100644
--- a/wtk/src/org/apache/pivot/wtk/ExpanderListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ExpanderListener.java
@@ -59,7 +59,7 @@
/**
* Called when an expander's title has changed.
- *
+ *
* @param expander
* @param previousTitle
*/
@@ -67,21 +67,21 @@
/**
* Called when an expander's collapsible flag has changed.
- *
+ *
* @param expander
*/
public void collapsibleChanged(Expander expander);
/**
* Called to preview an expanded change event.
- *
+ *
* @param expander
*/
public Vote previewExpandedChange(Expander expander);
/**
* Called when an expanded change event has been vetoed.
- *
+ *
* @param expander
* @param reason
*/
@@ -89,14 +89,14 @@
/**
* Called when an expander's expanded state has changed.
- *
+ *
* @param expander
*/
public void expandedChanged(Expander expander);
/**
* Called when an expander's content component has changed.
- *
+ *
* @param expander
* @param previousContent
*/
diff --git a/wtk/src/org/apache/pivot/wtk/FileBrowser.java b/wtk/src/org/apache/pivot/wtk/FileBrowser.java
index 59f976c..e7f7bb1 100644
--- a/wtk/src/org/apache/pivot/wtk/FileBrowser.java
+++ b/wtk/src/org/apache/pivot/wtk/FileBrowser.java
@@ -103,7 +103,7 @@
/**
* Creates a new FileBrowser <p> Note that this version of the constructor
* must be used when a custom root folder has to be set.
- *
+ *
* @param rootFolder The root folder full name.
*/
public FileBrowser(String rootFolder) {
@@ -121,7 +121,7 @@
/**
* Returns the current root directory.
- *
+ *
* @return The current root directory.
*/
public File getRootDirectory() {
@@ -130,7 +130,7 @@
/**
* Sets the root directory. Clears any existing file selection.
- *
+ *
* @param rootDirectory
*/
public void setRootDirectory(File rootDirectory) {
@@ -153,7 +153,7 @@
/**
* Adds a file to the file selection.
- *
+ *
* @param file
* @return <tt>true</tt> if the file was added; <tt>false</tt> if it was
* already selected.
@@ -182,7 +182,7 @@
/**
* Removes a file from the file selection.
- *
+ *
* @param file
* @return <tt>true</tt> if the file was removed; <tt>false</tt> if it was
* not already selected.
@@ -202,7 +202,7 @@
/**
* When in single-select mode, returns the currently selected file.
- *
+ *
* @return The currently selected file.
*/
public File getSelectedFile() {
@@ -215,7 +215,7 @@
/**
* Sets the selection to a single file.
- *
+ *
* @param file
*/
public void setSelectedFile(File file) {
@@ -232,7 +232,7 @@
/**
* Returns the currently selected files.
- *
+ *
* @return An immutable list containing the currently selected files. Note
* that the returned list is a wrapper around the actual selection, not a
* copy. Any changes made to the selection state will be reflected in the
@@ -244,7 +244,7 @@
/**
* Sets the selected files.
- *
+ *
* @param selectedFiles The files to select.
* @return The files that were selected, with duplicates eliminated.
*/
@@ -307,7 +307,7 @@
/**
* Sets the file browser's multi-select state.
- *
+ *
* @param multiSelect <tt>true</tt> if multi-select is enabled;
* <tt>false</tt>, otherwise.
*/
@@ -324,7 +324,7 @@
/**
* Returns the current file filter.
- *
+ *
* @return The current file filter, or <tt>null</tt> if no filter is set.
*/
public Filter<File> getDisabledFileFilter() {
@@ -333,7 +333,7 @@
/**
* Sets the file filter.
- *
+ *
* @param disabledFileFilter The file filter to use, or <tt>null</tt> for no
* filter.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/FileBrowserListener.java b/wtk/src/org/apache/pivot/wtk/FileBrowserListener.java
index 51f4c4d..259036b 100644
--- a/wtk/src/org/apache/pivot/wtk/FileBrowserListener.java
+++ b/wtk/src/org/apache/pivot/wtk/FileBrowserListener.java
@@ -64,7 +64,7 @@
/**
* Called when a file browser's root directory has changed.
- *
+ *
* @param fileBrowser
* @param previousRootDirectory
*/
@@ -72,7 +72,7 @@
/**
* Called when a file has been added to a file browser's selection.
- *
+ *
* @param fileBrowser
* @param file
*/
@@ -80,7 +80,7 @@
/**
* Called when a file has been removed from a file browser's selection.
- *
+ *
* @param fileBrowser
* @param file
*/
@@ -88,7 +88,7 @@
/**
* Called when a file browser's selection state has been reset.
- *
+ *
* @param fileBrowser
* @param previousSelectedFiles
*/
@@ -96,14 +96,14 @@
/**
* Called when a file browser's multi-select flag has changed.
- *
+ *
* @param fileBrowser
*/
public void multiSelectChanged(FileBrowser fileBrowser);
/**
* Called when a file browser's file filter has changed.
- *
+ *
* @param fileBrowser
* @param previousDisabledFileFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/FileBrowserSheet.java b/wtk/src/org/apache/pivot/wtk/FileBrowserSheet.java
index ff523e2..5c77528 100644
--- a/wtk/src/org/apache/pivot/wtk/FileBrowserSheet.java
+++ b/wtk/src/org/apache/pivot/wtk/FileBrowserSheet.java
@@ -91,7 +91,7 @@
/**
* Creates a new FileBrowserSheet <p> Note that this version set by default
* the user home as root folder.
- *
+ *
* @param mode The mode for opening the sheet.
* @see Mode
*/
@@ -103,7 +103,7 @@
* Creates a new FileBrowserSheet <p> Note that this version of the
* constructor can be used when a custom root folder has to be set, and uses
* the default mode.
- *
+ *
* @param rootFolder The root folder full name.
*/
public FileBrowserSheet(String rootFolder) {
@@ -113,7 +113,7 @@
/**
* Creates a new FileBrowserSheet <p> Note that this version of the
* constructor must be used when a custom root folder has to be set.
- *
+ *
* @param mode The mode for opening the sheet.
* @see Mode
* @param rootFolder The root folder full name.
@@ -202,7 +202,7 @@
/**
* When in single-select mode, returns the currently selected file.
- *
+ *
* @return The currently selected file.
*/
public File getSelectedFile() {
@@ -215,7 +215,7 @@
/**
* Sets the selection to a single file.
- *
+ *
* @param file
*/
public void setSelectedFile(File file) {
@@ -232,7 +232,7 @@
/**
* Returns the currently selected files.
- *
+ *
* @return An immutable list containing the currently selected files. Note
* that the returned list is a wrapper around the actual selection, not a
* copy. Any changes made to the selection state will be reflected in the
@@ -244,7 +244,7 @@
/**
* Sets the selected files.
- *
+ *
* @param selectedFiles The files to select.
* @return The files that were selected, with duplicates eliminated.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/FileBrowserSheetListener.java b/wtk/src/org/apache/pivot/wtk/FileBrowserSheetListener.java
index 17e79eb..b12f71d 100644
--- a/wtk/src/org/apache/pivot/wtk/FileBrowserSheetListener.java
+++ b/wtk/src/org/apache/pivot/wtk/FileBrowserSheetListener.java
@@ -56,7 +56,7 @@
/**
* Called when a file browser sheet's mode has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousMode
*/
@@ -64,7 +64,7 @@
/**
* Called when a file browser sheet's root directory has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousRootDirectory
*/
@@ -72,7 +72,7 @@
/**
* Called when a file browser sheet's selection state has been reset.
- *
+ *
* @param fileBrowserSheet
* @param previousSelectedFiles
*/
@@ -81,7 +81,7 @@
/**
* Called when a file browser sheet's disabled file filter has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousDisabledFileFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/FillPaneListener.java b/wtk/src/org/apache/pivot/wtk/FillPaneListener.java
index c2a0dd0..6f63e78 100644
--- a/wtk/src/org/apache/pivot/wtk/FillPaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/FillPaneListener.java
@@ -22,7 +22,7 @@
public interface FillPaneListener {
/**
* Called when a fill pane's orientation has changed.
- *
+ *
* @param fillPane
*/
public void orientationChanged(FillPane fillPane);
diff --git a/wtk/src/org/apache/pivot/wtk/FocusTraversalPolicy.java b/wtk/src/org/apache/pivot/wtk/FocusTraversalPolicy.java
index ac49431..91cfdf4 100644
--- a/wtk/src/org/apache/pivot/wtk/FocusTraversalPolicy.java
+++ b/wtk/src/org/apache/pivot/wtk/FocusTraversalPolicy.java
@@ -23,7 +23,7 @@
public interface FocusTraversalPolicy {
/**
* Returns the next focus destination according to this traversal policy.
- *
+ *
* @param container The container to which the traversal policy applies.
* @param component The component from which focus is being transferred. If
* <tt>null</tt>, implementations should return the first component for a
diff --git a/wtk/src/org/apache/pivot/wtk/Form.java b/wtk/src/org/apache/pivot/wtk/Form.java
index c569bf9..f0dc8af 100644
--- a/wtk/src/org/apache/pivot/wtk/Form.java
+++ b/wtk/src/org/apache/pivot/wtk/Form.java
@@ -259,7 +259,7 @@
/**
* Creates a new flag with the given message type and no message.
- *
+ *
* @param messageType The type of the flag.
*/
public Flag(MessageType messageType) {
@@ -268,7 +268,7 @@
/**
* Creates a new flag with the given type and message.
- *
+ *
* @param messageType The type of the flag.
* @param message The message text associated with the flag, or
* <tt>null</tt> for no message.
@@ -284,7 +284,7 @@
/**
* Returns the flag's message type.
- *
+ *
* @return The message type of the flag.
*/
public MessageType getMessageType() {
@@ -293,7 +293,7 @@
/**
* Sets the flag's message type.
- *
+ *
* @param messageType
*/
public void setMessageType(MessageType messageType) {
@@ -306,7 +306,7 @@
/**
* Returns the flag message.
- *
+ *
* @return The message text associated with the flag, or <tt>null</tt>
* if there is no message.
*/
@@ -316,7 +316,7 @@
/**
* Sets the flag message.
- *
+ *
* @param message The message text associated with the flag, or
* <tt>null</tt> if there is no message.
*/
@@ -427,7 +427,7 @@
/**
* Returns the form's field sequence.
- *
+ *
* @return The form's field sequence.
*/
public SectionSequence getSections() {
@@ -447,7 +447,7 @@
/**
* Returns the number of fields that are flagged with a given message type.
- *
+ *
* @param messageType The message type to count, or <tt>null</tt> to return
* the count of all flagged fields regardless of message type.
*/
@@ -469,7 +469,7 @@
/**
* Ensures that the first field with the given flag type is visible.
- *
+ *
* @param messageType The message type, or <tt>null</tt> to scroll the first
* flag of any type to visible.
*/
@@ -510,7 +510,7 @@
/**
* Returns the form listener list.
- *
+ *
* @return The form listener list.
*/
public ListenerList<FormListener> getFormListeners() {
@@ -519,7 +519,7 @@
/**
* Returns the form attribute listener list.
- *
+ *
* @return The form attribute listener list.
*/
public ListenerList<FormAttributeListener> getFormAttributeListeners() {
@@ -529,7 +529,7 @@
/**
* Finds the {@link Form.Section} that the given component belongs to. Only
* finds the section if the component is a direct child of the section.
- *
+ *
* @see #getEnclosingSection getEnclosingSection(Component)
*/
public static Section getSection(Component component) {
@@ -540,7 +540,7 @@
* Finds the {@link Form.Section} that the given component belongs to. Will
* search up the parent hierarchy in case the component is nested inside
* other containers inside the form.
- *
+ *
* @return The form section this component (or one of its parents) belongs
* to or <code>null</code> if the component does not belong to a form.
* @see #getSection getSection(Component)
diff --git a/wtk/src/org/apache/pivot/wtk/FormAttributeListener.java b/wtk/src/org/apache/pivot/wtk/FormAttributeListener.java
index 6a4ba40..cf498fd 100644
--- a/wtk/src/org/apache/pivot/wtk/FormAttributeListener.java
+++ b/wtk/src/org/apache/pivot/wtk/FormAttributeListener.java
@@ -42,7 +42,7 @@
/**
* Called when a fields's label attribute has changed.
- *
+ *
* @param form
* @param field
* @param previousLabel
@@ -51,7 +51,7 @@
/**
* Called when a fields's required attribute has changed.
- *
+ *
* @param form
* @param field
*/
@@ -59,7 +59,7 @@
/**
* Called when a field's flag attribute has changed.
- *
+ *
* @param form
* @param field
* @param previousFlag
diff --git a/wtk/src/org/apache/pivot/wtk/FormListener.java b/wtk/src/org/apache/pivot/wtk/FormListener.java
index 008537c..aa50bd6 100644
--- a/wtk/src/org/apache/pivot/wtk/FormListener.java
+++ b/wtk/src/org/apache/pivot/wtk/FormListener.java
@@ -54,7 +54,7 @@
/**
* Called when a form section has been inserted.
- *
+ *
* @param form
* @param index
*/
@@ -62,7 +62,7 @@
/**
* Called when form sections have been removed.
- *
+ *
* @param form
* @param index
* @param removed
@@ -71,14 +71,14 @@
/**
* Called when a form section's heading has changed.
- *
+ *
* @param section
*/
public void sectionHeadingChanged(Form.Section section);
/**
* Called when a form field has been inserted.
- *
+ *
* @param section
* @param index
*/
@@ -86,7 +86,7 @@
/**
* Called when forms fields items have been removed.
- *
+ *
* @param section
* @param index
* @param fields
diff --git a/wtk/src/org/apache/pivot/wtk/FrameListener.java b/wtk/src/org/apache/pivot/wtk/FrameListener.java
index 4742021..ea2f4d5 100644
--- a/wtk/src/org/apache/pivot/wtk/FrameListener.java
+++ b/wtk/src/org/apache/pivot/wtk/FrameListener.java
@@ -22,7 +22,7 @@
public interface FrameListener {
/**
* Called when a frame's menu bar has changed.
- *
+ *
* @param frame
* @param previousMenuBar
*/
diff --git a/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java b/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java
index 9f00af6..f90b4c6 100644
--- a/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java
+++ b/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java
@@ -100,7 +100,7 @@
* pixels with the graphics context's paint. For this reason, and because
* Pivot supports scaling the display host, it is recommended that skins use
* this method over <tt>java.awt.Graphics#drawRect</tt>.
- *
+ *
* @param graphics The graphics context that will be used to perform the
* operation.
* @param x The x-coordinate of the upper-left corner of the rectangle.
@@ -124,7 +124,7 @@
* pixels with the graphics context's paint. For this reason, and because
* Pivot supports scaling the display host, it is recommended that skins use
* this method over <tt>java.awt.Graphics#drawRect</tt>.
- *
+ *
* @param graphics The graphics context that will be used to perform the
* operation.
* @param x The x-coordinate of the upper-left corner of the rectangle.
@@ -159,7 +159,7 @@
/**
* Interprets a string as a color value.
- *
+ *
* @param value One of the following forms: <ul> <li>0xdddddddd - 8
* hexadecimal digits, specifying 8 bits each of red, green, and blue,
* followed by 8 bits of alpha.</li> <li>#dddddd - 6 hexadecimal digits,
@@ -223,7 +223,7 @@
/**
* Interpret a string as a {@link Paint} value
- *
+ *
* @param value Either (a) One of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot} or (b) A {@linkplain GraphicsUtilities#decodePaint(Dictionary)
@@ -250,7 +250,7 @@
/**
* Interpret a dictionary as a {@link Paint} value
- *
+ *
* @param dictionary A dictionary containing a key {@value #PAINT_TYPE_KEY}
* and further elements according to its value: <ul> <li><b>solid_color</b>
* - key {@value #COLOR_KEY} with value being any of the
diff --git a/wtk/src/org/apache/pivot/wtk/GridPane.java b/wtk/src/org/apache/pivot/wtk/GridPane.java
index 13c85d6..dcdfcb6 100644
--- a/wtk/src/org/apache/pivot/wtk/GridPane.java
+++ b/wtk/src/org/apache/pivot/wtk/GridPane.java
@@ -40,7 +40,7 @@
/**
* Returns the grid pane with which this row is associated.
- *
+ *
* @return The row's grid pane, or <tt>null</tt> if the row does not
* currently belong to a grid.
*/
@@ -326,7 +326,7 @@
/**
* Creates a new grid pane with the specified column count.
- *
+ *
* @param columnCount
*/
public GridPane(int columnCount) {
@@ -358,7 +358,7 @@
/**
* Sets the number of columns in the grid pane.
- *
+ *
* @param columnCount
*/
public void setColumnCount(int columnCount) {
@@ -372,7 +372,7 @@
/**
* Returns the grid pane row sequence.
- *
+ *
* @return The grid pane row sequence
*/
public RowSequence getRows() {
@@ -381,7 +381,7 @@
/**
* Returns the index of the row at a given location.
- *
+ *
* @param y The y-coordinate of the row to identify.
* @return The row index, or <tt>-1</tt> if there is no row at the given
* y-coordinate.
@@ -393,7 +393,7 @@
/**
* Returns the bounds of a given row.
- *
+ *
* @param row The row index.
*/
public Bounds getRowBounds(int row) {
@@ -403,7 +403,7 @@
/**
* Returns the index of the column at a given location.
- *
+ *
* @param x The x-coordinate of the column to identify.
* @return The column index, or <tt>-1</tt> if there is no column at the
* given x-coordinate.
@@ -415,7 +415,7 @@
/**
* Returns the bounds of a given column.
- *
+ *
* @param column The column index.
*/
public Bounds getColumnBounds(int column) {
@@ -425,7 +425,7 @@
/**
* Gets the component at the specified cell in this grid pane.
- *
+ *
* @param rowIndex The row index of the cell
* @param columnIndex The column index of the cell
* @return The component in the specified cell, or <tt>null</tt> if the cell
@@ -446,7 +446,7 @@
/**
* Overrides the base method to check whether or not a cell component is
* being removed, and fires the appropriate event in that case.
- *
+ *
* @param index The index at which components were removed
* @param count The number of components removed
* @return The sequence of components that were removed
diff --git a/wtk/src/org/apache/pivot/wtk/GridPaneListener.java b/wtk/src/org/apache/pivot/wtk/GridPaneListener.java
index 16e58dc..526ebe9 100644
--- a/wtk/src/org/apache/pivot/wtk/GridPaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/GridPaneListener.java
@@ -59,7 +59,7 @@
/**
* Called when a grid pane's column count has changed.
- *
+ *
* @param gridPane
* @param previousColumnCount
*/
@@ -67,7 +67,7 @@
/**
* Called when a row has been inserted into a grid pane.
- *
+ *
* @param gridPane
* @param index
*/
@@ -75,7 +75,7 @@
/**
* Called when rows have been removed from a grid pane.
- *
+ *
* @param gridPane
* @param index
* @param rows
@@ -84,7 +84,7 @@
/**
* Called when a cell has been inserted into a grid pane.
- *
+ *
* @param row
* @param column
*/
@@ -92,7 +92,7 @@
/**
* Called when cell's have been removed from a grid pane.
- *
+ *
* @param row
* @param column
* @param removed
@@ -101,7 +101,7 @@
/**
* Called when a cell has been updated in a grid pane.
- *
+ *
* @param row
* @param column
* @param previousComponent
diff --git a/wtk/src/org/apache/pivot/wtk/ImageView.java b/wtk/src/org/apache/pivot/wtk/ImageView.java
index bcb1a6c..5e0ca7f 100644
--- a/wtk/src/org/apache/pivot/wtk/ImageView.java
+++ b/wtk/src/org/apache/pivot/wtk/ImageView.java
@@ -52,7 +52,7 @@
/**
* Converts a value from the bind context to an image representation
* during a {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public Image toImage(Object value);
@@ -60,7 +60,7 @@
/**
* Converts a value from the bind context to an image location during a
* {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public URL toImageURL(Object value);
@@ -68,7 +68,7 @@
/**
* Converts a value from the bind context to an image resource name
* during a {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public String toImageName(Object value);
@@ -76,7 +76,7 @@
/**
* Converts a text string to a value to be stored in the bind context
* during a {@link Component#store(Object)} operation.
- *
+ *
* @param image
*/
public Object valueOf(Image image);
@@ -147,7 +147,7 @@
/**
* Creates an image view with the given image.
- *
+ *
* @param image The initial image to set, or <tt>null</tt> for no image.
*/
public ImageView(Image image) {
@@ -158,7 +158,7 @@
/**
* Returns the image view's current image.
- *
+ *
* @return The current image, or <tt>null</tt> if no image is set.
*/
public Image getImage() {
@@ -167,7 +167,7 @@
/**
* Sets the image view's current image.
- *
+ *
* @param image The image to set, or <tt>null</tt> for no image.
*/
public void setImage(Image image) {
@@ -184,7 +184,7 @@
* exists in the application context resource cache, the cached value will
* be used. Otherwise, the icon will be loaded synchronously and added to
* the cache.
- *
+ *
* @param imageURL The location of the image to set.
*/
public final void setImage(final URL imageURL) {
@@ -248,7 +248,7 @@
/**
* Sets the image view's image by
* {@linkplain ClassLoader#getResource(String) resource name}.
- *
+ *
* @param imageName The resource name of the image to set.
* @see #setImage(URL)
*/
@@ -267,7 +267,7 @@
/**
* Returns the image view's asynchronous flag.
- *
+ *
* @return <tt>true</tt> if images specified via URL will be loaded in the
* background; <tt>false</tt> if they will be loaded synchronously.
*/
@@ -277,7 +277,7 @@
/**
* Sets the image view's asynchronous flag.
- *
+ *
* @param asynchronous <tt>true</tt> if images specified via URL will be
* loaded in the background; <tt>false</tt> if they will be loaded
* synchronously.
@@ -291,7 +291,7 @@
/**
* Returns the image view's image key.
- *
+ *
* @return The image key, or <tt>null</tt> if no key is set.
*/
public String getImageKey() {
@@ -300,7 +300,7 @@
/**
* Sets the image view's image key.
- *
+ *
* @param imageKey The image key, or <tt>null</tt> to clear the binding.
*/
public void setImageKey(String imageKey) {
diff --git a/wtk/src/org/apache/pivot/wtk/ImageViewBindingListener.java b/wtk/src/org/apache/pivot/wtk/ImageViewBindingListener.java
index 8d28a25..d233d80 100644
--- a/wtk/src/org/apache/pivot/wtk/ImageViewBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ImageViewBindingListener.java
@@ -43,7 +43,7 @@
/**
* Called when an image view's image key has changed.
- *
+ *
* @param imageView
* @param previousImageKey
*/
@@ -51,7 +51,7 @@
/**
* Called when a image views's image bind type has changed.
- *
+ *
* @param imageView
* @param previousImageBindType
*/
@@ -59,7 +59,7 @@
/**
* Called when an image view's text bind mapping has changed.
- *
+ *
* @param imageView
* @param previousImageBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ImageViewListener.java b/wtk/src/org/apache/pivot/wtk/ImageViewListener.java
index 8daee13..3b1dec5 100644
--- a/wtk/src/org/apache/pivot/wtk/ImageViewListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ImageViewListener.java
@@ -39,7 +39,7 @@
/**
* Called when an image view's image has changed.
- *
+ *
* @param imageView
* @param previousImage
*/
@@ -47,7 +47,7 @@
/**
* Called when an image view's asynchronous flag has changed.
- *
+ *
* @param imageView
*/
public void asynchronousChanged(ImageView imageView);
diff --git a/wtk/src/org/apache/pivot/wtk/Keyboard.java b/wtk/src/org/apache/pivot/wtk/Keyboard.java
index 50dcdbc..e1966e6 100644
--- a/wtk/src/org/apache/pivot/wtk/Keyboard.java
+++ b/wtk/src/org/apache/pivot/wtk/Keyboard.java
@@ -268,7 +268,7 @@
/**
* Tests the pressed state of a modifier.
- *
+ *
* @param modifier
* @return <tt>true</tt> if the modifier is pressed; <tt>false</tt>,
* otherwise.
@@ -279,7 +279,7 @@
/**
* Returns the current drop action.
- *
+ *
* @return The drop action corresponding to the currently pressed modifier
* keys, or <tt>null</tt> if no modifiers are pressed.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Label.java b/wtk/src/org/apache/pivot/wtk/Label.java
index d910d45..606f0ae 100644
--- a/wtk/src/org/apache/pivot/wtk/Label.java
+++ b/wtk/src/org/apache/pivot/wtk/Label.java
@@ -30,7 +30,7 @@
/**
* Converts a value from the bind context to a text representation
* during a {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public String toString(Object value);
@@ -38,7 +38,7 @@
/**
* Converts a text string to a value to be stored in the bind context
* during a {@link Component#store(Object)} operation.
- *
+ *
* @param text
*/
public Object valueOf(String text);
@@ -109,7 +109,7 @@
/**
* Returns the label's text.
- *
+ *
* @return The text.
*/
public String getText() {
@@ -118,7 +118,7 @@
/**
* Set the text of the Label.
- *
+ *
* @param text The text to set, must be not null.
*/
public void setText(String text) {
@@ -141,7 +141,7 @@
* Utility method to set text to the given value, or to an empty string if
* null (to avoid the setText throw an IllegalArgumentException). This is
* useful to be called by code.
- *
+ *
* @param text The text to set
* @see #setText
*/
@@ -151,7 +151,7 @@
/**
* Returns the label's text key.
- *
+ *
* @return The text key, or <tt>null</tt> if no text key is set.
*/
public String getTextKey() {
@@ -160,7 +160,7 @@
/**
* Returns the maximum length of the label text.
- *
+ *
* @return The maximum length of the label text.
*/
public int getMaximumLength() {
@@ -169,7 +169,7 @@
/**
* Sets the maximum length of the label text.
- *
+ *
* @param maximumLength The maximum length of the label text.
*/
public void setMaximumLength(int maximumLength) {
@@ -193,7 +193,7 @@
/**
* Sets the label's text key.
- *
+ *
* @param textKey The text key, or <tt>null</tt> to clear the binding.
*/
public void setTextKey(String textKey) {
diff --git a/wtk/src/org/apache/pivot/wtk/LabelBindingListener.java b/wtk/src/org/apache/pivot/wtk/LabelBindingListener.java
index fa865fe..8cfb27b 100644
--- a/wtk/src/org/apache/pivot/wtk/LabelBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/LabelBindingListener.java
@@ -43,7 +43,7 @@
/**
* Called when a label's text key has changed.
- *
+ *
* @param label
* @param previousTextKey
*/
@@ -51,7 +51,7 @@
/**
* Called when a label's text bind type has changed.
- *
+ *
* @param label
* @param previousTextBindType
*/
@@ -59,7 +59,7 @@
/**
* Called when a label's text bind mapping has changed.
- *
+ *
* @param label
* @param previousTextBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/LabelListener.java b/wtk/src/org/apache/pivot/wtk/LabelListener.java
index 7376a2a..0175de5 100644
--- a/wtk/src/org/apache/pivot/wtk/LabelListener.java
+++ b/wtk/src/org/apache/pivot/wtk/LabelListener.java
@@ -38,7 +38,7 @@
/**
* Called when a label's text has changed.
- *
+ *
* @param label
* @param previousText
*/
@@ -46,7 +46,7 @@
/**
* Called when a label text maximum length has changed.
- *
+ *
* @param label
* @param previousMaximumLength
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Limits.java b/wtk/src/org/apache/pivot/wtk/Limits.java
index ce7e7c5..efdcec3 100644
--- a/wtk/src/org/apache/pivot/wtk/Limits.java
+++ b/wtk/src/org/apache/pivot/wtk/Limits.java
@@ -77,7 +77,7 @@
/**
* Limits the specified value to the minimum and maximum values of this
* object.
- *
+ *
* @param value The value to limit.
* @return The bounded value.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ListButton.java b/wtk/src/org/apache/pivot/wtk/ListButton.java
index 4d01c0f..99dcae6 100644
--- a/wtk/src/org/apache/pivot/wtk/ListButton.java
+++ b/wtk/src/org/apache/pivot/wtk/ListButton.java
@@ -300,7 +300,7 @@
/**
* Creates a list button with the given button data and an empty list.
- *
+ *
* @param buttonData
*/
public ListButton(Object buttonData) {
@@ -309,7 +309,7 @@
/**
* Creates a list button with no button data and the given list data.
- *
+ *
* @param listData
*/
public ListButton(List<?> listData) {
@@ -321,7 +321,7 @@
* the default renderer uses (as last option) the toString method on list
* elements, so override it to return whatever you want to display in the
* ListView, or implement your own custom renderer.
- *
+ *
* @param buttonData The button data.
* @param listData The data to set.
* @see ListButtonDataRenderer
@@ -365,7 +365,7 @@
/**
* Returns the list data associated with this list button.
- *
+ *
* @return The list data.
*/
public List<?> getListData() {
@@ -374,7 +374,7 @@
/**
* Sets the list button's list data.
- *
+ *
* @param listData The list data to be presented by the list button.
*/
@SuppressWarnings("unchecked")
@@ -410,7 +410,7 @@
/**
* Sets the list button's list data.
- *
+ *
* @param listData The list data to be presented by the list button as a
* JSON array.
*/
@@ -428,7 +428,7 @@
/**
* Sets the list button's list data.
- *
+ *
* @param listData A URL referring to a JSON file containing the data to be
* presented by the list button.
*/
@@ -450,7 +450,7 @@
/**
* Returns the renderer used to display items in the list.
- *
+ *
* @return The item renderer instance.
*/
public ListView.ItemRenderer getItemRenderer() {
@@ -461,7 +461,7 @@
* Sets the renderer used to display items in the list. <p> Use
* {@link #setDataRenderer(org.apache.pivot.wtk.Button.DataRenderer)} to
* define the renderer used to draw the button data.
- *
+ *
* @param itemRenderer The item renderer instance.
*/
public void setItemRenderer(ListView.ItemRenderer itemRenderer) {
@@ -482,7 +482,7 @@
/**
* Sets the list button's repeatable flag.
- *
+ *
* @param repeatable
*/
public void setRepeatable(boolean repeatable) {
@@ -494,7 +494,7 @@
/**
* Returns the current selection.
- *
+ *
* @return The index of the currently selected list item, or <tt>-1</tt> if
* nothing is selected.
*/
@@ -504,7 +504,7 @@
/**
* Sets the selection.
- *
+ *
* @param selectedIndex The index of the list item to select, or <tt>-1</tt>
* to clear the selection.
*/
@@ -539,7 +539,7 @@
/**
* Returns an item's disabled state.
- *
+ *
* @param index The index of the item whose disabled state is to be tested.
* @return <tt>true</tt> if the item is disabled; <tt>false</tt>, otherwise.
*/
@@ -557,7 +557,7 @@
/**
* Returns the disabled item filter.
- *
+ *
* @return The disabled item filter, or <tt>null</tt> if no disabled item
* filter is set.
*/
@@ -567,7 +567,7 @@
/**
* Sets the disabled item filter.
- *
+ *
* @param disabledItemFilter The disabled item filter, or <tt>null</tt> for
* no disabled item filter.
*/
@@ -590,7 +590,7 @@
/**
* Sets the list size. If the number of items in the list exceeds this
* value, the list will scroll.
- *
+ *
* @param listSize
*/
public void setListSize(int listSize) {
@@ -607,7 +607,7 @@
/**
* Returns name of the key that is used in context binding.
- *
+ *
* @return The key.
*/
public String getListDataKey() {
@@ -616,7 +616,7 @@
/**
* Set the name of the key that is used in context binding.
- *
+ *
* @param listDataKey The key to set.
*/
public void setListDataKey(String listDataKey) {
diff --git a/wtk/src/org/apache/pivot/wtk/ListButtonBindingListener.java b/wtk/src/org/apache/pivot/wtk/ListButtonBindingListener.java
index 5090c02..c73a0dc 100644
--- a/wtk/src/org/apache/pivot/wtk/ListButtonBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListButtonBindingListener.java
@@ -60,7 +60,7 @@
/**
* Called when a list button's list data key has changed.
- *
+ *
* @param listButton
* @param previousListDataKey
*/
@@ -68,7 +68,7 @@
/**
* Called when a list button's list data bind type has changed.
- *
+ *
* @param listButton
* @param previousListDataBindType
*/
@@ -76,7 +76,7 @@
/**
* Called when a list button's list data bind mapping has changed.
- *
+ *
* @param listButton
* @param previousListDataBindMapping
*/
@@ -85,7 +85,7 @@
/**
* Called when a list button's selected item key has changed.
- *
+ *
* @param listButton
* @param previousSelectedItemKey
*/
@@ -93,7 +93,7 @@
/**
* Called when a list button's selected item bind type has changed.
- *
+ *
* @param listButton
* @param previousSelectedItemBindType
*/
@@ -102,7 +102,7 @@
/**
* Called when a list button's selected item bind mapping has changed.
- *
+ *
* @param listButton
* @param previousSelectedItemBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ListButtonItemListener.java b/wtk/src/org/apache/pivot/wtk/ListButtonItemListener.java
index 8a68d7f..aad61d9 100644
--- a/wtk/src/org/apache/pivot/wtk/ListButtonItemListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListButtonItemListener.java
@@ -52,7 +52,7 @@
/**
* Called when an item is inserted into a list button's list data.
- *
+ *
* @param listButton
* @param index
*/
@@ -60,7 +60,7 @@
/**
* Called when items are removed from a list button's list data.
- *
+ *
* @param listButton
* @param index
* @param count
@@ -69,7 +69,7 @@
/**
* Called when an item is updated within a list button's list data.
- *
+ *
* @param listButton
* @param index
*/
@@ -77,14 +77,14 @@
/**
* Called when a list button's list data has been cleared.
- *
+ *
* @param listButton
*/
public void itemsCleared(ListButton listButton);
/**
* Called when a list button's list data is sorted.
- *
+ *
* @param listButton
*/
public void itemsSorted(ListButton listButton);
diff --git a/wtk/src/org/apache/pivot/wtk/ListButtonListener.java b/wtk/src/org/apache/pivot/wtk/ListButtonListener.java
index 9c2eec5..8bd3793 100644
--- a/wtk/src/org/apache/pivot/wtk/ListButtonListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListButtonListener.java
@@ -57,7 +57,7 @@
/**
* Called when a list button's list data has changed.
- *
+ *
* @param listButton
* @param previousListData
*/
@@ -65,7 +65,7 @@
/**
* Called when a list button's item renderer has changed.
- *
+ *
* @param listButton
* @param previousItemRenderer
*/
@@ -74,14 +74,14 @@
/**
* Called when a list button's repeatable flag has changed.
- *
+ *
* @param listButton
*/
public void repeatableChanged(ListButton listButton);
/**
* Called when a list button's disabled item filter has changed.
- *
+ *
* @param listButton
* @param previousDisabledItemFilter
*/
@@ -90,7 +90,7 @@
/**
* Called when a list button's list size has changed.
- *
+ *
* @param listButton
* @param previousListSize
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ListButtonSelectionListener.java b/wtk/src/org/apache/pivot/wtk/ListButtonSelectionListener.java
index f25e56c..77bac1e 100644
--- a/wtk/src/org/apache/pivot/wtk/ListButtonSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListButtonSelectionListener.java
@@ -37,7 +37,7 @@
/**
* Called when a list button's selected index has changed.
- *
+ *
* @param listButton The source of the event.
* @param previousSelectedIndex If the selection changed directly, contains
* the index that was previously selected. Otherwise, contains the current
@@ -47,7 +47,7 @@
/**
* Called when a list button's selected item has changed.
- *
+ *
* @param listButton The source of the event.
* @param previousSelectedItem The item that was previously selected, or
* <tt>null</tt> if the previous selection cannot be determined.
diff --git a/wtk/src/org/apache/pivot/wtk/ListView.java b/wtk/src/org/apache/pivot/wtk/ListView.java
index 2a0490f..a08b396 100644
--- a/wtk/src/org/apache/pivot/wtk/ListView.java
+++ b/wtk/src/org/apache/pivot/wtk/ListView.java
@@ -67,7 +67,7 @@
public interface ItemRenderer extends Renderer {
/**
* Prepares the renderer for layout or paint.
- *
+ *
* @param item The item to render, or <tt>null</tt> if called to
* calculate preferred height for skins that assume a fixed renderer
* height.
@@ -84,7 +84,7 @@
/**
* Converts a list item to a string representation.
- *
+ *
* @param item
* @return The item's string representation, or <tt>null</tt> if the item
* does not have a string representation. <p> Note that this method may
@@ -100,7 +100,7 @@
public interface ItemEditor {
/**
* Called to begin editing a list item.
- *
+ *
* @param listView
* @param itemIndex
*/
@@ -108,7 +108,7 @@
/**
* Terminates an edit operation.
- *
+ *
* @param result <tt>true</tt> to perform the edit; <tt>false</tt> to
* cancel it.
*/
@@ -138,7 +138,7 @@
/**
* Converts a context value to list data during a
* {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public List<?> toListData(Object value);
@@ -146,7 +146,7 @@
/**
* Converts list data to a context value during a
* {@link Component#store(Object)} operation.
- *
+ *
* @param listData
*/
public Object valueOf(List<?> listData);
@@ -160,7 +160,7 @@
/**
* Returns the index of the item in the source list during a
* {@link Component#load(Object)} operation.
- *
+ *
* @param listData The source list data.
* @param value The value to locate.
* @return The index of first occurrence of the value if it exists in the
@@ -171,7 +171,7 @@
/**
* Retrieves the value at the given index during a
* {@link Component#store(Object)} operation.
- *
+ *
* @param listData The source list data.
* @param index The index of the value to retrieve.
*/
@@ -572,7 +572,7 @@
* default renderer uses (as last option) the toString method on list
* elements, so override it to return whatever you want to display in the
* ListView, or implement your own custom renderer.
- *
+ *
* @param listData The data to set.
* @see ListViewItemRenderer
*/
@@ -585,7 +585,7 @@
/**
* Returns the list data.
- *
+ *
* @return The data currently presented by the list view.
*/
public List<?> getListData() {
@@ -594,7 +594,7 @@
/**
* Sets the list data.
- *
+ *
* @param listData The data to be presented by the list view.
*/
@SuppressWarnings("unchecked")
@@ -636,7 +636,7 @@
/**
* Sets the list data.
- *
+ *
* @param listData A JSON string (must begin with <tt>[</tt> and end with
* <tt>]</tt>) denoting the data to be presented by the list view.
*/
@@ -654,7 +654,7 @@
/**
* Sets the list data.
- *
+ *
* @param listData A URL referring to a JSON file containing the data to be
* presented by the list view.
*/
@@ -693,7 +693,7 @@
/**
* Sets the item renderer to be used for items in this list.
- *
+ *
* @param itemRenderer The item renderer for the list.
*/
public void setItemRenderer(ItemRenderer itemRenderer) {
@@ -711,7 +711,7 @@
/**
* Returns the editor used to edit items in this list.
- *
+ *
* @return The item editor, or <tt>null</tt> if no editor is installed.
*/
public ItemEditor getItemEditor() {
@@ -720,7 +720,7 @@
/**
* Sets the editor used to edit items in this list.
- *
+ *
* @param itemEditor The item editor for the list.
*/
public void setItemEditor(ItemEditor itemEditor) {
@@ -734,7 +734,7 @@
/**
* Returns the currently selected index, even when in multi-select mode.
- *
+ *
* @return The currently selected index.
*/
public int getSelectedIndex() {
@@ -743,7 +743,7 @@
/**
* Sets the selection to a single index.
- *
+ *
* @param index The index to select, or <tt>-1</tt> to clear the selection.
*/
public void setSelectedIndex(int index) {
@@ -759,7 +759,7 @@
/**
* Sets the selection to a single range.
- *
+ *
* @param start
* @param end
*/
@@ -772,7 +772,7 @@
/**
* Returns the currently selected ranges.
- *
+ *
* @return An immutable list containing the currently selected ranges. Note
* that the returned list is a wrapper around the actual selection, not a
* copy. Any changes made to the selection state will be reflected in the
@@ -786,7 +786,7 @@
* Sets the selection to the given range sequence. Any overlapping or
* connecting ranges will be consolidated, and the resulting selection will
* be sorted in ascending order.
- *
+ *
* @param selectedRanges
* @return The ranges that were actually set.
*/
@@ -834,7 +834,7 @@
/**
* Sets the selection to the given range sequence.
- *
+ *
* @param selectedRanges A JSON-formatted string containing the ranges to
* select.
* @return The ranges that were actually set.
@@ -869,7 +869,7 @@
/**
* Returns the first selected index.
- *
+ *
* @return The first selected index, or <tt>-1</tt> if nothing is selected.
*/
public int getFirstSelectedIndex() {
@@ -878,7 +878,7 @@
/**
* Returns the last selected index.
- *
+ *
* @return The last selected index, or <tt>-1</tt> if nothing is selected.
*/
public int getLastSelectedIndex() {
@@ -888,7 +888,7 @@
/**
* Adds a single index to the selection.
- *
+ *
* @param index The index to add.
* @return <tt>true</tt> if the index was added to the selection;
* <tt>false</tt>, otherwise.
@@ -900,7 +900,7 @@
/**
* Adds a range of indexes to the selection.
- *
+ *
* @param start The first index in the range.
* @param end The last index in the range.
* @return The ranges that were added to the selection.
@@ -931,7 +931,7 @@
/**
* Adds a range of indexes to the selection.
- *
+ *
* @param range The range to add.
* @return The ranges that were added to the selection.
*/
@@ -945,7 +945,7 @@
/**
* Removes a single index from the selection.
- *
+ *
* @param index The index to remove.
* @return <tt>true</tt> if the index was removed from the selection;
* <tt>false</tt>, otherwise.
@@ -957,7 +957,7 @@
/**
* Removes a range of indexes from the selection.
- *
+ *
* @param start The start of the range to remove.
* @param end The end of the range to remove.
* @return The ranges that were removed from the selection.
@@ -989,7 +989,7 @@
/**
* Removes a range of indexes from the selection.
- *
+ *
* @param range The range to remove.
* @return The ranges that were removed from the selection.
*/
@@ -1019,7 +1019,7 @@
/**
* Returns the selection state of a given index.
- *
+ *
* @param index The index whose selection state is to be tested.
* @return <tt>true</tt> if the index is selected; <tt>false</tt>, otherwise.
*/
@@ -1095,7 +1095,7 @@
/**
* Sets the selection mode. Clears the selection if the mode has changed
* (but does not fire a selection change event).
- *
+ *
* @param selectMode The new selection mode.
*/
public void setSelectMode(SelectMode selectMode) {
@@ -1127,7 +1127,7 @@
/**
* Enables or disabled checkmarks. Clears the check state if the check mode
* has changed (but does not fire any check state change events).
- *
+ *
* @param checkmarksEnabled
*/
public void setCheckmarksEnabled(boolean checkmarksEnabled) {
@@ -1145,7 +1145,7 @@
/**
* Returns an item's checked state.
- *
+ *
* @param index
*/
public boolean isItemChecked(int index) {
@@ -1154,7 +1154,7 @@
/**
* Sets an item's checked state.
- *
+ *
* @param index
* @param checked
*/
@@ -1197,7 +1197,7 @@
/**
* Tells whether or not an item's checkmark is disabled.
- *
+ *
* @param index The index of the item whose disabled checkmark state is to
* be tested.
* @return <tt>true</tt> if the item's checkmark is disabled; <tt>false</tt>
@@ -1223,7 +1223,7 @@
* all checkboxes will be interactive. <p> <b>Note:</b> this filter is only
* relavent if {@link #setCheckmarksEnabled(boolean) checkmarksEnabled} is
* set to true.
- *
+ *
* @return The disabled checkmark filter, or <tt>null</tt> if no disabled
* checkmark filter is set
*/
@@ -1239,7 +1239,7 @@
* checkboxes will be interactive. <p> <b>Note:</b> this filter is only
* relavent if {@link #setCheckmarksEnabled(boolean) checkmarksEnabled} is
* set to true. enabled.
- *
+ *
* @param disabledCheckmarkFilter The disabled checkmark filter, or
* <tt>null</tt> for no disabled checkmark filter
*/
@@ -1254,7 +1254,7 @@
/**
* Returns an item's disabled state.
- *
+ *
* @param index The index of the item whose disabled state is to be tested.
* @return <tt>true</tt> if the item is disabled; <tt>false</tt>, otherwise.
*/
@@ -1272,7 +1272,7 @@
/**
* Returns the disabled item filter.
- *
+ *
* @return The disabled item filter, or <tt>null</tt> if no disabled item
* filter is set.
*/
@@ -1282,7 +1282,7 @@
/**
* Sets the disabled item filter.
- *
+ *
* @param disabledItemFilter The disabled item filter, or <tt>null</tt> for
* no disabled item filter.
*/
@@ -1297,7 +1297,7 @@
/**
* Returns name of the key that is used in context binding.
- *
+ *
* @return The key.
*/
public String getListDataKey() {
@@ -1306,7 +1306,7 @@
/**
* Set the name of the key that is used in context binding.
- *
+ *
* @param listDataKey The key to set.
*/
public void setListDataKey(String listDataKey) {
@@ -1689,7 +1689,7 @@
/**
* Returns the index of the item at a given location.
- *
+ *
* @param y The y-coordinate of the item to identify.
* @return The item index, or <tt>-1</tt> if there is no item at the given
* y-coordinate.
@@ -1701,7 +1701,7 @@
/**
* Returns the bounding area of a given item.
- *
+ *
* @param index The item index.
* @return The bounding area of the item.
*/
@@ -1712,7 +1712,7 @@
/**
* Returns the item indent.
- *
+ *
* @return The horizontal space preceding items in the list.
*/
public int getItemIndent() {
diff --git a/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java b/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java
index f5fb3d1..24ea633 100644
--- a/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java
@@ -94,7 +94,7 @@
/**
* Called when a list view's list data key has changed.
- *
+ *
* @param listView
* @param previousListDataKey
*/
@@ -102,7 +102,7 @@
/**
* Called when a list view's list data bind type has changed.
- *
+ *
* @param listView
* @param previousListDataBindType
*/
@@ -110,7 +110,7 @@
/**
* Called when a list view's list data bind mapping has changed.
- *
+ *
* @param listView
* @param previousListDataBindMapping
*/
@@ -119,7 +119,7 @@
/**
* Called when a list view's selected item key has changed.
- *
+ *
* @param listView
* @param previousSelectedItemKey
*/
@@ -127,7 +127,7 @@
/**
* Called when a list view's selected item bind type has changed.
- *
+ *
* @param listView
* @param previousSelectedItemBindType
*/
@@ -135,7 +135,7 @@
/**
* Called when a list view's selected item bind mapping has changed.
- *
+ *
* @param listView
* @param previousSelectedItemBindMapping
*/
@@ -144,7 +144,7 @@
/**
* Called when a list view's selected items key has changed.
- *
+ *
* @param listView
* @param previousSelectedItemsKey
*/
@@ -152,7 +152,7 @@
/**
* Called when a list view's selected items bind type has changed.
- *
+ *
* @param listView
* @param previousSelectedItemsBindType
*/
@@ -161,7 +161,7 @@
/**
* Called when a list view's selected items bind mapping has changed.
- *
+ *
* @param listView
* @param previousSelectedItemsBindMapping
*/
@@ -170,7 +170,7 @@
/**
* Called when a list view's checked items key has changed.
- *
+ *
* @param listView
* @param previousCheckedItemsKey
*/
@@ -178,7 +178,7 @@
/**
* Called when a list view's checked items bind type has changed.
- *
+ *
* @param listView
* @param previousCheckedItemsBindType
*/
@@ -186,7 +186,7 @@
/**
* Called when a list view's checked items bind mapping has changed.
- *
+ *
* @param listView
* @param previousCheckedItemsBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java b/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java
index 1cb0f29..12ab1d1 100644
--- a/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java
@@ -52,7 +52,7 @@
/**
* Called when an item has been inserted into the list view.
- *
+ *
* @param listView The source of the event.
* @param index The index of the item that was inserted.
*/
@@ -60,7 +60,7 @@
/**
* Called when items have been removed from the list view.
- *
+ *
* @param listView The source of the event.
* @param index The first index affected by the event.
* @param count The number of items that were removed, or <tt>-1</tt> if all
@@ -70,7 +70,7 @@
/**
* Called when an item in the list view has been updated.
- *
+ *
* @param listView The source of the event.
* @param index The first index affected by the event.
*/
@@ -78,14 +78,14 @@
/**
* Called when the items in a list view have been cleared.
- *
+ *
* @param listView
*/
public void itemsCleared(ListView listView);
/**
* Called when the items in a list view have been sorted.
- *
+ *
* @param listView The source of the event.
*/
public void itemsSorted(ListView listView);
diff --git a/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java b/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java
index eb1db0c..319b5bb 100644
--- a/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java
@@ -22,7 +22,7 @@
public interface ListViewItemStateListener {
/**
* Called when an item's checked state has changed.
- *
+ *
* @param listView
* @param index
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ListViewListener.java b/wtk/src/org/apache/pivot/wtk/ListViewListener.java
index f5a0832..c3c1799 100644
--- a/wtk/src/org/apache/pivot/wtk/ListViewListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListViewListener.java
@@ -68,7 +68,7 @@
/**
* Called when a list view's list data has changed.
- *
+ *
* @param listView
* @param previousListData
*/
@@ -76,7 +76,7 @@
/**
* Called when a list view's item renderer has changed.
- *
+ *
* @param listView
* @param previousItemRenderer
*/
@@ -84,7 +84,7 @@
/**
* Called when a list view's item editor has changed.
- *
+ *
* @param listView
* @param previousItemEditor
*/
@@ -92,7 +92,7 @@
/**
* Called when a list view's select mode has changed.
- *
+ *
* @param listView
* @param previousSelectMode
*/
@@ -100,14 +100,14 @@
/**
* Called when a list view's checkmarks enabled flag has changed.
- *
+ *
* @param listView
*/
public void checkmarksEnabledChanged(ListView listView);
/**
* Called when a list view's disabled item filter has changed.
- *
+ *
* @param listView
* @param previousDisabledItemFilter
*/
@@ -115,7 +115,7 @@
/**
* Called when a list view's disabled checkmark filter has changed.
- *
+ *
* @param listView
* @param previousDisabledCheckmarkFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ListViewSelectionListener.java b/wtk/src/org/apache/pivot/wtk/ListViewSelectionListener.java
index 837a29d..55bb9c6 100644
--- a/wtk/src/org/apache/pivot/wtk/ListViewSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ListViewSelectionListener.java
@@ -49,7 +49,7 @@
/**
* Called when a range has been added to a list view's selection.
- *
+ *
* @param listView The source of the event.
* @param rangeStart The start index of the range that was added, inclusive.
* @param rangeEnd The end index of the range that was added, inclusive.
@@ -58,7 +58,7 @@
/**
* Called when a range has been removed from a list view's selection.
- *
+ *
* @param listView The source of the event.
* @param rangeStart The starting index of the range that was removed,
* inclusive.
@@ -69,7 +69,7 @@
/**
* Called when a list view's selection state has changed.
- *
+ *
* @param listView The source of the event.
* @param previousSelectedRanges If the selection changed directly, contains
* the ranges that were previously selected. If the selection changed
@@ -80,7 +80,7 @@
/**
* Called when a list view's selected item has changed.
- *
+ *
* @param listView The source of the event.
* @param previousSelectedItem The item that was previously selected.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Menu.java b/wtk/src/org/apache/pivot/wtk/Menu.java
index 78f85b8..93611a1 100644
--- a/wtk/src/org/apache/pivot/wtk/Menu.java
+++ b/wtk/src/org/apache/pivot/wtk/Menu.java
@@ -201,7 +201,7 @@
public interface ItemListener {
/**
* Called when an item's menu has changed.
- *
+ *
* @param item
* @param previousMenu
*/
@@ -209,7 +209,7 @@
/**
* Called when an item's active state has changed.
- *
+ *
* @param item
*/
public void activeChanged(Item item);
@@ -356,7 +356,7 @@
public interface SectionListener {
/**
* Called when a menu item has been inserted.
- *
+ *
* @param section
* @param index
*/
@@ -364,7 +364,7 @@
/**
* Called when menu items have been removed.
- *
+ *
* @param section
* @param index
* @param removed
@@ -373,7 +373,7 @@
/**
* Called when a section's name has changed.
- *
+ *
* @param section
* @param previousName
*/
diff --git a/wtk/src/org/apache/pivot/wtk/MenuBar.java b/wtk/src/org/apache/pivot/wtk/MenuBar.java
index 4ac0138..0ae58f5 100644
--- a/wtk/src/org/apache/pivot/wtk/MenuBar.java
+++ b/wtk/src/org/apache/pivot/wtk/MenuBar.java
@@ -167,7 +167,7 @@
public interface ItemListener {
/**
* Called when an item's menu has changed.
- *
+ *
* @param item
* @param previousMenu
*/
@@ -175,7 +175,7 @@
/**
* Called when an item's active state has changed.
- *
+ *
* @param item
*/
public void activeChanged(Item item);
diff --git a/wtk/src/org/apache/pivot/wtk/MenuBarListener.java b/wtk/src/org/apache/pivot/wtk/MenuBarListener.java
index a383267..010f187 100644
--- a/wtk/src/org/apache/pivot/wtk/MenuBarListener.java
+++ b/wtk/src/org/apache/pivot/wtk/MenuBarListener.java
@@ -44,7 +44,7 @@
/**
* Called when a menu bar item has been inserted.
- *
+ *
* @param menuBar
* @param index
*/
@@ -52,7 +52,7 @@
/**
* Called when menu bar items have been removed.
- *
+ *
* @param menuBar
* @param index
* @param removed
@@ -61,7 +61,7 @@
/**
* Called when a menu bar's active item has changed.
- *
+ *
* @param menuBar
* @param previousActiveItem
*/
diff --git a/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java b/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java
index ceef4e4..d0216f1 100644
--- a/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java
+++ b/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java
@@ -22,7 +22,7 @@
public interface MenuButtonListener {
/**
* Called when a menu button's menu has changed.
- *
+ *
* @param menuButton
* @param previousMenu
*/
diff --git a/wtk/src/org/apache/pivot/wtk/MenuHandler.java b/wtk/src/org/apache/pivot/wtk/MenuHandler.java
index 06cbbf4..d2e614b 100644
--- a/wtk/src/org/apache/pivot/wtk/MenuHandler.java
+++ b/wtk/src/org/apache/pivot/wtk/MenuHandler.java
@@ -43,7 +43,7 @@
/**
* Called when a component to which this handler is attached gains the
* focus.
- *
+ *
* @param component
* @param menuBar
*/
@@ -52,7 +52,7 @@
/**
* Called when a component to which this handler is attached loses the
* focus.
- *
+ *
* @param component
* @param menuBar
*/
@@ -61,7 +61,7 @@
/**
* Called when the user right-clicks on a component to which this handler is
* attached.
- *
+ *
* @param component
* @param menu
* @param x
diff --git a/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java b/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java
index 093f396..0cd9d34 100644
--- a/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java
@@ -22,7 +22,7 @@
public interface MenuItemSelectionListener {
/**
* Called when a descendant item of this menu has been selected.
- *
+ *
* @param menuItem
*/
public void itemSelected(Menu.Item menuItem);
diff --git a/wtk/src/org/apache/pivot/wtk/MenuListener.java b/wtk/src/org/apache/pivot/wtk/MenuListener.java
index b8db60a..43affbf 100644
--- a/wtk/src/org/apache/pivot/wtk/MenuListener.java
+++ b/wtk/src/org/apache/pivot/wtk/MenuListener.java
@@ -44,7 +44,7 @@
/**
* Called when a menu section has been inserted.
- *
+ *
* @param menu
* @param index
*/
@@ -52,7 +52,7 @@
/**
* Called when menu sections have been removed.
- *
+ *
* @param menu
* @param index
* @param removed
@@ -61,7 +61,7 @@
/**
* Called when a menu's active item has changed.
- *
+ *
* @param menu
* @param previousActiveItem
*/
diff --git a/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java b/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java
index 6ddf1c0..3da3a24 100644
--- a/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java
+++ b/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java
@@ -22,7 +22,7 @@
public interface MenuPopupListener {
/**
* Called when a menu popup's menu has changed.
- *
+ *
* @param menuPopup
* @param previousMenu
*/
diff --git a/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java b/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java
index ca2d7cd..dfe3703 100644
--- a/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java
@@ -44,7 +44,7 @@
/**
* Called to preview a menu popup close event.
- *
+ *
* @param menuPopup
* @param immediate
*/
@@ -52,7 +52,7 @@
/**
* Called when a menu popup close event has been vetoed.
- *
+ *
* @param menuPopup
* @param reason
*/
@@ -60,7 +60,7 @@
/**
* Called when a menu popup has closed.
- *
+ *
* @param menuPopup
*/
public void menuPopupClosed(MenuPopup menuPopup);
diff --git a/wtk/src/org/apache/pivot/wtk/MeterListener.java b/wtk/src/org/apache/pivot/wtk/MeterListener.java
index 589c848..f1230b6 100644
--- a/wtk/src/org/apache/pivot/wtk/MeterListener.java
+++ b/wtk/src/org/apache/pivot/wtk/MeterListener.java
@@ -42,7 +42,7 @@
/**
* Called when a meter's percentage value has changed.
- *
+ *
* @param meter
* @param previousPercentage
*/
@@ -50,7 +50,7 @@
/**
* Called when a meter's text has changed.
- *
+ *
* @param meter
* @param previousText
*/
@@ -58,7 +58,7 @@
/**
* Called when a sliders's orientation has changed.
- *
+ *
* @param meter The source of the event.
*/
public void orientationChanged(Meter meter);
diff --git a/wtk/src/org/apache/pivot/wtk/Mouse.java b/wtk/src/org/apache/pivot/wtk/Mouse.java
index 9baede1..988b3eb 100644
--- a/wtk/src/org/apache/pivot/wtk/Mouse.java
+++ b/wtk/src/org/apache/pivot/wtk/Mouse.java
@@ -57,7 +57,7 @@
/**
* Tests the pressed state of a button.
- *
+ *
* @param button
* @return <tt>true</tt> if the button is pressed; <tt>false</tt>, otherwise.
*/
@@ -75,7 +75,7 @@
/**
* "Captures" the mouse, causing all mouse input to be delegated to the
* given component rather than propagating down the component hierarchy.
- *
+ *
* @param capturerArgument The component that wants to capture the mouse.
* The mouse pointer must currently be over the component.
*/
@@ -132,7 +132,7 @@
/**
* Returns the mouse capturer.
- *
+ *
* @return The component that has captured the mouse, or <tt>null</tt> if
* the mouse is not currently captured.
*/
@@ -142,7 +142,7 @@
/**
* Returns the current cursor.
- *
+ *
* @throws IllegalStateException If the mouse is not currently captured.
*/
public static Cursor getCursor() {
@@ -237,7 +237,7 @@
/**
* Sets the cursor to an explicit value.
- *
+ *
* @param cursor
* @throws IllegalStateException If the mouse is not currently captured.
*/
@@ -257,7 +257,7 @@
/**
* Sets the cursor based on a given component.
- *
+ *
* @param component
*/
public static void setCursor(final Component component) {
diff --git a/wtk/src/org/apache/pivot/wtk/MovieView.java b/wtk/src/org/apache/pivot/wtk/MovieView.java
index 4a4ca87..5debd26 100644
--- a/wtk/src/org/apache/pivot/wtk/MovieView.java
+++ b/wtk/src/org/apache/pivot/wtk/MovieView.java
@@ -48,7 +48,7 @@
/**
* Creates an movie view with the given movie.
- *
+ *
* @param movie The initial movie to set, or <tt>null</tt> for no movie.
*/
public MovieView(Movie movie) {
@@ -59,7 +59,7 @@
/**
* Returns the movie view's current movie.
- *
+ *
* @return The current movie, or <tt>null</tt> if no movie is set.
*/
public Movie getMovie() {
@@ -68,7 +68,7 @@
/**
* Sets the movie view's current movie.
- *
+ *
* @param movie The movie to set, or <tt>null</tt> for no movie.
*/
public void setMovie(Movie movie) {
@@ -82,7 +82,7 @@
/**
* Returns the movie view listener list.
- *
+ *
* @return The movie view listener list.
*/
public ListenerList<MovieViewListener> getMovieViewListeners() {
diff --git a/wtk/src/org/apache/pivot/wtk/MovieViewListener.java b/wtk/src/org/apache/pivot/wtk/MovieViewListener.java
index 7224c09..6b8b851 100644
--- a/wtk/src/org/apache/pivot/wtk/MovieViewListener.java
+++ b/wtk/src/org/apache/pivot/wtk/MovieViewListener.java
@@ -24,7 +24,7 @@
public interface MovieViewListener {
/**
* Called when an movie view's movie has changed.
- *
+ *
* @param movieView
* @param previousMovie
*/
diff --git a/wtk/src/org/apache/pivot/wtk/PromptListener.java b/wtk/src/org/apache/pivot/wtk/PromptListener.java
index 9438299..8bd61f9 100644
--- a/wtk/src/org/apache/pivot/wtk/PromptListener.java
+++ b/wtk/src/org/apache/pivot/wtk/PromptListener.java
@@ -59,7 +59,7 @@
/**
* Called when a prompt's message type has changed.
- *
+ *
* @param prompt
* @param previousMessageType
*/
@@ -67,7 +67,7 @@
/**
* Called when a prompt's message has changed.
- *
+ *
* @param prompt
* @param previousMessage
*/
@@ -75,7 +75,7 @@
/**
* Called when a prompt's body has changed.
- *
+ *
* @param prompt
* @param previousBody
*/
@@ -83,7 +83,7 @@
/**
* Called when an option has been inserted into a prompt's option sequence.
- *
+ *
* @param prompt
* @param index
*/
@@ -91,7 +91,7 @@
/**
* Called when options have been removed from a prompt's option sequence.
- *
+ *
* @param prompt
* @param index
* @param removed
@@ -100,7 +100,7 @@
/**
* Called when a prompt's selected option has changed.
- *
+ *
* @param prompt
* @param previousSelectedOption
*/
diff --git a/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java b/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java
index 6ea9978..aa6b90d 100644
--- a/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java
+++ b/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java
@@ -105,7 +105,7 @@
/*
* Potentially transfer focus away from the buttons in this group.
- *
+ *
* At this point we know that at least one button is focused, so we
* just need to find the first or last (and possibly only) focusable
* button depending on the focus transfer direction and then
@@ -281,7 +281,7 @@
/**
* Add a button to the group.
- *
+ *
* @see Group#add(Object)
* @see Sequence#add(Object)
*/
@@ -299,7 +299,7 @@
/**
* Return the button at the specified index.
- *
+ *
* @see Sequence#get(int)
*/
public Button get(int index) {
@@ -308,7 +308,7 @@
/**
* Return the number of buttons in the group.
- *
+ *
* @see Sequence#getLength()
*/
public int getLength() {
@@ -317,7 +317,7 @@
/**
* Return the index (order) of the button within the group.
- *
+ *
* @return The index or -1 if the button does not belong to this
* RadioButtonGroup
* @see Sequence#indexOf(Object)
@@ -328,7 +328,7 @@
/**
* Insert a button at the specified index.
- *
+ *
* @see Sequence#insert(Object, int)
*/
public void insert(Button button, int index) {
@@ -343,7 +343,7 @@
/**
* Remove the button from the group.
- *
+ *
* @see Group#remove(Object)
* @see Sequence#remove(Object)
*/
@@ -362,7 +362,7 @@
/**
* Remove <code>count</code> buttons from the group starting at
* <code>index</code>.
- *
+ *
* @see Sequence#remove(int, int)
*/
public Sequence<Button> remove(int index, int count) {
@@ -388,7 +388,7 @@
/**
* Select and <strong>focus</strong> the specified button.
- *
+ *
* @see ButtonGroup#setSelection(Button)
*/
@Override
@@ -426,7 +426,7 @@
/**
* Working forwards from the specified button, select the first focusable
* button.
- *
+ *
* @param button If null, the first available button will be selected,
* unless the group contains a selected or focused button, in which case
* that button will be used as the starting point for the search.
@@ -471,7 +471,7 @@
/**
* Working backwards from the specified button, select the first focusable
* button.
- *
+ *
* @param button If null, the last available button will be selected, unless
* the group contains a selected or focused button, in which case that
* button will be used as the starting point for the search.
@@ -518,7 +518,7 @@
* Iterate forwards over the buttons in the group, looping back to the start
* if the upper bound is reached and the <code>circular</code> parameter is
* true.
- *
+ *
* @param index Index to which the 'next' is relative
* @param filter Alternative filter to use during the search.
* @param circularArgument Loop when upper bound is reached
@@ -558,7 +558,7 @@
* Iterate backwards over the buttons in the group, looping back to the end
* if the lower bound is reached and the <code>circular</code> parameter is
* true.
- *
+ *
* @param index Index to which the 'previous' is relative
* @param filter Alternative filter to use during the search.
* @param circularArgument Loop when lower bound is reached
diff --git a/wtk/src/org/apache/pivot/wtk/RangeSelection.java b/wtk/src/org/apache/pivot/wtk/RangeSelection.java
index f099b4f..c6cd6eb 100644
--- a/wtk/src/org/apache/pivot/wtk/RangeSelection.java
+++ b/wtk/src/org/apache/pivot/wtk/RangeSelection.java
@@ -56,7 +56,7 @@
/**
* Adds a range to the selection, merging and removing intersecting ranges
* as needed.
- *
+ *
* @param start
* @param end
* @return A sequence containing the ranges that were added.
@@ -154,7 +154,7 @@
/**
* Removes a range from the selection, truncating and removing intersecting
* ranges as needed.
- *
+ *
* @param start
* @param end
* @return A sequence containing the ranges that were removed.
@@ -243,7 +243,7 @@
/**
* Returns the range at a given index.
- *
+ *
* @param index
*/
public Span get(int index) {
@@ -266,7 +266,7 @@
/**
* Determines the index of a range in the selection.
- *
+ *
* @param range
* @return The index of the range, if it exists in the selection;
* <tt>-1</tt>, otherwise.
@@ -286,7 +286,7 @@
/**
* Tests for the presence of an index in the selection.
- *
+ *
* @param index
* @return <tt>true</tt> if the index is selected; <tt>false</tt>, otherwise.
*/
@@ -300,7 +300,7 @@
/**
* Inserts an index into the span sequence (e.g. when items are inserted
* into the model data).
- *
+ *
* @param index
* @return The number of ranges that were updated.
*/
@@ -344,7 +344,7 @@
/**
* Removes a range of indexes from the span sequence (e.g. when items are
* removed from the model data).
- *
+ *
* @param index
* @param count
* @return The number of ranges that were updated.
@@ -376,7 +376,7 @@
/**
* Ensures that the start value is less than or equal to the end value.
- *
+ *
* @param start
* @param end
* @return A span containing the normalized range.
diff --git a/wtk/src/org/apache/pivot/wtk/RollupListener.java b/wtk/src/org/apache/pivot/wtk/RollupListener.java
index 03107cd..2f6f183 100644
--- a/wtk/src/org/apache/pivot/wtk/RollupListener.java
+++ b/wtk/src/org/apache/pivot/wtk/RollupListener.java
@@ -44,7 +44,7 @@
/**
* Called when a rollup's heading component changed.
- *
+ *
* @param rollup
* @param previousHeading
*/
@@ -52,7 +52,7 @@
/**
* Called when a rollup's content component changed.
- *
+ *
* @param rollup
* @param previousContent
*/
@@ -60,7 +60,7 @@
/**
* Called when a rollup's collapsible flag has changed.
- *
+ *
* @param rollup
*/
public void collapsibleChanged(Rollup rollup);
diff --git a/wtk/src/org/apache/pivot/wtk/RollupStateListener.java b/wtk/src/org/apache/pivot/wtk/RollupStateListener.java
index d95ef34..f3ba2d6 100644
--- a/wtk/src/org/apache/pivot/wtk/RollupStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/RollupStateListener.java
@@ -46,14 +46,14 @@
/**
* Called to preview a rollup expansion event.
- *
+ *
* @param rollup
*/
public Vote previewExpandedChange(Rollup rollup);
/**
* Called when a rollup expansion event has been vetoed.
- *
+ *
* @param rollup
* @param reason
*/
@@ -61,7 +61,7 @@
/**
* Called when a rollup's expanded state changed.
- *
+ *
* @param rollup
*/
public void expandedChanged(Rollup rollup);
diff --git a/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java b/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java
index 0b068f5..e09c6dc 100644
--- a/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java
@@ -48,7 +48,7 @@
/**
* Called when a scroll bar's orientation has changed.
- *
+ *
* @param scrollBar
* @param previousOrientation
*/
@@ -56,7 +56,7 @@
/**
* Called when a scroll bar's scope has changed.
- *
+ *
* @param scrollBar
* @param previousStart
* @param previousEnd
@@ -67,7 +67,7 @@
/**
* Called when a scroll bar's unit increment has changed.
- *
+ *
* @param scrollBar
* @param previousUnitIncrement
*/
@@ -75,7 +75,7 @@
/**
* Called when a scroll bar's block increment has changed.
- *
+ *
* @param scrollBar
* @param previousBlockIncrement
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java b/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java
index 0062c0e..50a36fa 100644
--- a/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java
@@ -22,7 +22,7 @@
public interface ScrollBarValueListener {
/**
* Called when a scroll bar's value has changed.
- *
+ *
* @param scrollBar
* @param previousValue
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java b/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java
index e528eea..fae4b0e 100644
--- a/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java
@@ -54,7 +54,7 @@
/**
* Called when the scroll pane's horizontal scroll bar policy changed.
- *
+ *
* @param scrollPane
* @param previousPolicy
*/
@@ -63,7 +63,7 @@
/**
* Called when the scroll pane's vertical scroll bar policy changed.
- *
+ *
* @param scrollPane
* @param previousPolicy
*/
@@ -72,7 +72,7 @@
/**
* Called when the scroll pane's row header changed.
- *
+ *
* @param scrollPane
* @param previousRowHeader
*/
@@ -80,7 +80,7 @@
/**
* Called when the scroll pane's column header changed.
- *
+ *
* @param scrollPane
* @param previousColumnHeader
*/
@@ -88,7 +88,7 @@
/**
* Called when the scroll pane's corner component changed.
- *
+ *
* @param scrollPane
* @param previousCorner
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Separator.java b/wtk/src/org/apache/pivot/wtk/Separator.java
index 01fc975..aade0fd 100644
--- a/wtk/src/org/apache/pivot/wtk/Separator.java
+++ b/wtk/src/org/apache/pivot/wtk/Separator.java
@@ -47,7 +47,7 @@
/**
* Returns the separator's heading.
- *
+ *
* @return The separator's heading, or <tt>null</tt> if no heading is set.
*/
public String getHeading() {
@@ -56,7 +56,7 @@
/**
* Sets the separator's heading.
- *
+ *
* @param heading The new heading, or <tt>null</tt> for no heading.
*/
public void setHeading(String heading) {
diff --git a/wtk/src/org/apache/pivot/wtk/SeparatorListener.java b/wtk/src/org/apache/pivot/wtk/SeparatorListener.java
index a3ef65e..03bcd2d 100644
--- a/wtk/src/org/apache/pivot/wtk/SeparatorListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SeparatorListener.java
@@ -22,7 +22,7 @@
public interface SeparatorListener {
/**
* Called when a separator's heading has changed.
- *
+ *
* @param separator
* @param previousHeading
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Sheet.java b/wtk/src/org/apache/pivot/wtk/Sheet.java
index 7b58231..e249e86 100644
--- a/wtk/src/org/apache/pivot/wtk/Sheet.java
+++ b/wtk/src/org/apache/pivot/wtk/Sheet.java
@@ -68,7 +68,7 @@
/**
* Creates a new sheet with an initial content component.
- *
+ *
* @param content The sheet's content component.
*/
public Sheet(Component content) {
diff --git a/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java b/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java
index ec45e1a..c8184ff 100644
--- a/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java
@@ -22,7 +22,7 @@
public interface SheetCloseListener {
/**
* Called when a sheet has closed.
- *
+ *
* @param sheet
*/
public void sheetClosed(Sheet sheet);
diff --git a/wtk/src/org/apache/pivot/wtk/SheetStateListener.java b/wtk/src/org/apache/pivot/wtk/SheetStateListener.java
index b68bd10..3875b50 100644
--- a/wtk/src/org/apache/pivot/wtk/SheetStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SheetStateListener.java
@@ -44,7 +44,7 @@
/**
* Called to preview a sheet close event.
- *
+ *
* @param sheet
* @param result
*/
@@ -52,7 +52,7 @@
/**
* Called when a sheet close event has been vetoed.
- *
+ *
* @param sheet
* @param reason
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Skin.java b/wtk/src/org/apache/pivot/wtk/Skin.java
index 0b5528e..dcd4d7c 100644
--- a/wtk/src/org/apache/pivot/wtk/Skin.java
+++ b/wtk/src/org/apache/pivot/wtk/Skin.java
@@ -45,7 +45,7 @@
public interface Skin extends ConstrainedVisual {
/**
* Associates a skin with a component.
- *
+ *
* @param component The component to which the skin is being attached.
*/
public void install(Component component);
@@ -63,7 +63,7 @@
/**
* Returns the skin's focusable state.
- *
+ *
* @return <tt>true</tt> if this skin is focusable; </tt>false</tt>,
* otherwise.
*/
@@ -71,7 +71,7 @@
/**
* Tells whether or not this skin is fully opaque when painted.
- *
+ *
* @return <tt>true</tt> if this skin is opaque; </tt>false</tt> if any part
* of it is transparent or translucent.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/SliderListener.java b/wtk/src/org/apache/pivot/wtk/SliderListener.java
index e514d5b..1ba7c30 100644
--- a/wtk/src/org/apache/pivot/wtk/SliderListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SliderListener.java
@@ -37,7 +37,7 @@
/**
* Called when a slider's range has changed.
- *
+ *
* @param slider
* @param previousStart
* @param previousEnd
@@ -46,7 +46,7 @@
/**
* Called when a sliders's orientation has changed.
- *
+ *
* @param slider The source of the event.
*/
public void orientationChanged(Slider slider);
diff --git a/wtk/src/org/apache/pivot/wtk/SliderValueListener.java b/wtk/src/org/apache/pivot/wtk/SliderValueListener.java
index 0df2f82..8643392 100644
--- a/wtk/src/org/apache/pivot/wtk/SliderValueListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SliderValueListener.java
@@ -22,7 +22,7 @@
public interface SliderValueListener {
/**
* Called when a slider's value has changed.
- *
+ *
* @param slider
* @param previousValue
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Span.java b/wtk/src/org/apache/pivot/wtk/Span.java
index 5d85292..4ffa0e9 100644
--- a/wtk/src/org/apache/pivot/wtk/Span.java
+++ b/wtk/src/org/apache/pivot/wtk/Span.java
@@ -70,7 +70,7 @@
/**
* Returns the length of the span.
- *
+ *
* @return The absolute value of (<tt>end</tt> minus <tt>start</tt>) + 1.
*/
public long getLength() {
@@ -79,7 +79,7 @@
/**
* Determines whether this span contains another span.
- *
+ *
* @param span The span to test for containment.
* @return <tt>true</tt> if this span contains <tt>span</tt>; <tt>false</tt>,
* otherwise.
@@ -103,7 +103,7 @@
/**
* Determines whether this span intersects with another span.
- *
+ *
* @param span The span to test for intersection.
* @return <tt>true</tt> if this span intersects with <tt>span</tt>;
* <tt>false</tt>, otherwise.
@@ -127,7 +127,7 @@
/**
* Calculates the intersection of this span and another span.
- *
+ *
* @param span The span to intersect with this span.
* @return A new Span instance representing the intersection of this span and
* <tt>span</tt>, or null if the spans do not intersect.
@@ -148,7 +148,7 @@
/**
* Calculates the union of this span and another span.
- *
+ *
* @param span The span to union with this span.
* @return A new Span instance representing the union of this span and
* <tt>span</tt>.
diff --git a/wtk/src/org/apache/pivot/wtk/Spinner.java b/wtk/src/org/apache/pivot/wtk/Spinner.java
index 2acccbe..fecea49 100644
--- a/wtk/src/org/apache/pivot/wtk/Spinner.java
+++ b/wtk/src/org/apache/pivot/wtk/Spinner.java
@@ -42,7 +42,7 @@
public interface ItemRenderer extends Renderer {
/**
* Prepares the renderer for layout or paint.
- *
+ *
* @param item The item to render, or <tt>null</tt> if called to
* calculate preferred height for skins that assume a fixed renderer
* height.
@@ -52,7 +52,7 @@
/**
* Converts a spinner item to a string representation.
- *
+ *
* @param item
* @return The item's string representation, or <tt>null</tt> if the item
* does not have a string representation. <p> Note that this method may
@@ -69,7 +69,7 @@
/**
* Converts a context value to spinner data during a
* {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public List<?> toSpinnerData(Object value);
@@ -77,7 +77,7 @@
/**
* Converts spinner data to a context value during a
* {@link Component#store(Object)} operation.
- *
+ *
* @param spinnerData
*/
public Object valueOf(List<?> spinnerData);
@@ -98,7 +98,7 @@
/**
* Returns the index of the item in the source list during a
* {@link Component#load(Object)} operation.
- *
+ *
* @param spinnerData The source spinner data.
* @param value The value to locate.
* @return The index of first occurrence of the value if it exists in the
@@ -109,7 +109,7 @@
/**
* Retrieves the item at the given index during a
* {@link Component#store(Object)} operation.
- *
+ *
* @param spinnerData The source spinner data.
* @param index The index of the value to retrieve.
*/
@@ -357,7 +357,7 @@
* the default renderer uses (as last option) the toString method on list
* elements, so override it to return whatever you want to display as text,
* or implement your own custom renderer.
- *
+ *
* @param spinnerData The data to set.
* @see SpinnerItemRenderer
*/
@@ -370,7 +370,7 @@
/**
* Returns the spinner data.
- *
+ *
* @return The data currently presented by the spinner.
*/
public List<?> getSpinnerData() {
@@ -379,7 +379,7 @@
/**
* Sets the spinner data. Clears any existing selection state.
- *
+ *
* @param spinnerData The data to be presented by the spinner.
*/
@SuppressWarnings("unchecked")
@@ -444,7 +444,7 @@
/**
* Sets the item renderer to be used for items in this list.
- *
+ *
* @param itemRenderer The item renderer for the list.
*/
public void setItemRenderer(ItemRenderer itemRenderer) {
@@ -477,7 +477,7 @@
/**
* Returns the currently selected index.
- *
+ *
* @return The currently selected index.
*/
public int getSelectedIndex() {
@@ -486,7 +486,7 @@
/**
* Sets the selection to the specified index.
- *
+ *
* @param selectedIndex The index to select, or <tt>-1</tt> to clear the
* selection.
*/
@@ -691,7 +691,7 @@
/**
* Gets the bounding area of the spinner content (the area in which the item
* renderer will render the content).
- *
+ *
* @return The bounding area of the spinner content.
*/
public Bounds getContentBounds() {
diff --git a/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java b/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java
index 53b8157..5e96287 100644
--- a/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java
@@ -60,7 +60,7 @@
/**
* Called when a spinner's spinner data key has changed.
- *
+ *
* @param spinner
* @param previousSpinnerDataKey
*/
@@ -68,7 +68,7 @@
/**
* Called when a spinner's spinner data bind type has changed.
- *
+ *
* @param spinner
* @param previousSpinnerDataBindType
*/
@@ -76,7 +76,7 @@
/**
* Called when a spinner's spinner data bind mapping has changed.
- *
+ *
* @param spinner
* @param previousSpinnerDataBindMapping
*/
@@ -85,7 +85,7 @@
/**
* Called when a spinner's selected item key has changed.
- *
+ *
* @param spinner
* @param previousSelectedItemKey
*/
@@ -93,7 +93,7 @@
/**
* Called when a spinner's selected item bind type has changed.
- *
+ *
* @param spinner
* @param previousSelectedItemBindType
*/
@@ -101,7 +101,7 @@
/**
* Called when a spinner's selected item bind mapping has changed.
- *
+ *
* @param spinner
* @param previousSelectedItemBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java b/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java
index 02681f7..a65d427 100644
--- a/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java
@@ -52,7 +52,7 @@
/**
* Called when an item is inserted into a spinner's data.
- *
+ *
* @param spinner
* @param index
*/
@@ -60,7 +60,7 @@
/**
* Called when items are removed from a spinner's data.
- *
+ *
* @param spinner
* @param index
* @param count
@@ -69,7 +69,7 @@
/**
* Called when an item is updated within a spinner's data.
- *
+ *
* @param spinner
* @param index
*/
@@ -77,14 +77,14 @@
/**
* Called when a spinner's data has been cleared.
- *
+ *
* @param spinner
*/
public void itemsCleared(Spinner spinner);
/**
* Called when a spinner's data is sorted.
- *
+ *
* @param spinner
*/
public void itemsSorted(Spinner spinner);
diff --git a/wtk/src/org/apache/pivot/wtk/SpinnerListener.java b/wtk/src/org/apache/pivot/wtk/SpinnerListener.java
index bb643d7..ad8af91 100644
--- a/wtk/src/org/apache/pivot/wtk/SpinnerListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SpinnerListener.java
@@ -44,7 +44,7 @@
/**
* Called when a spinner's data has changed.
- *
+ *
* @param spinner
* @param previousSpinnerData
*/
@@ -52,7 +52,7 @@
/**
* Called when a spinner's item renderer has changed.
- *
+ *
* @param spinner
* @param previousItemRenderer
*/
@@ -60,7 +60,7 @@
/**
* Called when a spinner's circular property has changed.
- *
+ *
* @param spinner
*/
public void circularChanged(Spinner spinner);
diff --git a/wtk/src/org/apache/pivot/wtk/SpinnerSelectionListener.java b/wtk/src/org/apache/pivot/wtk/SpinnerSelectionListener.java
index f54ed83..e5c5466 100644
--- a/wtk/src/org/apache/pivot/wtk/SpinnerSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SpinnerSelectionListener.java
@@ -37,7 +37,7 @@
/**
* Called when a spinner's selected index has changed.
- *
+ *
* @param spinner The source of the event.
* @param previousSelectedIndex If the selection changed directly, contains
* the index that was previously selected. Otherwise, contains the current
@@ -47,7 +47,7 @@
/**
* Called when a spinners's selected item has changed.
- *
+ *
* @param spinner The source of the event.
* @param previousSelectedItem The item that was previously selected, or
* <tt>null</tt> if the previous selection cannot be determined.
diff --git a/wtk/src/org/apache/pivot/wtk/SplitPaneListener.java b/wtk/src/org/apache/pivot/wtk/SplitPaneListener.java
index da837cb..fc0bc18 100644
--- a/wtk/src/org/apache/pivot/wtk/SplitPaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SplitPaneListener.java
@@ -62,7 +62,7 @@
/**
* Called when a split pane's top left component has changed.
- *
+ *
* @param splitPane The source of the event.
* @param previousTopLeft The previous component. The new component can be
* found inside the splitPane.
@@ -71,7 +71,7 @@
/**
* Called when a split pane's bottom right component has changed.
- *
+ *
* @param splitPane The source of the event.
* @param previousBottomRight The previous component. The new component can
* be found inside the splitPane.
@@ -80,21 +80,21 @@
/**
* Called when a split pane's orientation has changed.
- *
+ *
* @param splitPane The source of the event.
*/
public void orientationChanged(SplitPane splitPane);
/**
* Called when a split pane's primary region has changed.
- *
+ *
* @param splitPane The source of the event.
*/
public void primaryRegionChanged(SplitPane splitPane);
/**
* Called when a split pane's split location has changed.
- *
+ *
* @param splitPane The source of the event.
* @param previousSplitRatio The previous setting of the splitRatio.
*/
@@ -102,14 +102,14 @@
/**
* Called when a split pane's locked flag has changed.
- *
+ *
* @param splitPane The source of the event.
*/
public void lockedChanged(SplitPane splitPane);
/**
* Called when a split pane's split location has changed.
- *
+ *
* @param splitPane The source of the event.
* @param previousResizeMode The previous setting of the resizeMode.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java b/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java
index 751bdec..47c3acd 100644
--- a/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java
+++ b/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java
@@ -269,7 +269,7 @@
/**
* Sets the list of suggestions presented by the popup.
- *
+ *
* @param suggestionData
*/
@SuppressWarnings("unchecked")
@@ -313,7 +313,7 @@
/**
* Sets the list view item renderer used to present suggestions.
- *
+ *
* @param suggestionRenderer
*/
public void setSuggestionRenderer(ListView.ItemRenderer suggestionRenderer) {
@@ -327,7 +327,7 @@
/**
* Returns the current selection.
- *
+ *
* @return The index of the currently selected suggestion, or <tt>-1</tt> if
* nothing is selected.
*/
@@ -337,7 +337,7 @@
/**
* Sets the selection.
- *
+ *
* @param selectedIndex The index of the suggestion to select, or
* <tt>-1</tt> to clear the selection.
*/
@@ -381,7 +381,7 @@
/**
* Sets the list size. If the number of items in the list exceeds this
* value, the list will scroll.
- *
+ *
* @param listSize
*/
public void setListSize(int listSize) {
@@ -409,7 +409,7 @@
/**
* Opens the suggestion popup window.
- *
+ *
* @param textInputArgument The text input for which suggestions will be
* provided.
*/
@@ -419,7 +419,7 @@
/**
* Opens the suggestion popup window.
- *
+ *
* @param textInputArgument The text input for which suggestions will be
* provided.
* @param suggestionPopupCloseListenerArgument A listener that will be called
diff --git a/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java b/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java
index 535d297..dd4e4b0 100644
--- a/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java
@@ -22,7 +22,7 @@
public interface SuggestionPopupCloseListener {
/**
* Called when a suggestion popup has closed.
- *
+ *
* @param suggestionPopup
*/
public void suggestionPopupClosed(SuggestionPopup suggestionPopup);
diff --git a/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java b/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java
index ac27736..778c6d0 100644
--- a/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java
@@ -52,7 +52,7 @@
/**
* Called when an item is inserted into a list button's list data.
- *
+ *
* @param suggestionPopup
* @param index
*/
@@ -60,7 +60,7 @@
/**
* Called when items are removed from a list button's list data.
- *
+ *
* @param suggestionPopup
* @param index
* @param count
@@ -69,7 +69,7 @@
/**
* Called when an item is updated within a list button's list data.
- *
+ *
* @param suggestionPopup
* @param index
*/
@@ -77,14 +77,14 @@
/**
* Called when a list button's list data has been cleared.
- *
+ *
* @param suggestionPopup
*/
public void itemsCleared(SuggestionPopup suggestionPopup);
/**
* Called when a list button's list data is sorted.
- *
+ *
* @param suggestionPopup
*/
public void itemsSorted(SuggestionPopup suggestionPopup);
diff --git a/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java b/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java
index a529715..9b761e9 100644
--- a/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java
@@ -46,7 +46,7 @@
/**
* Called when a suggestion popup's suggestions have changed.
- *
+ *
* @param suggestionPopup
* @param previousSuggestionData
*/
@@ -55,7 +55,7 @@
/**
* Called when a suggestion popup's item renderer has changed.
- *
+ *
* @param suggestionPopup
* @param previousSuggestionRenderer
*/
@@ -64,7 +64,7 @@
/**
* Called when a suggestion popup's list size has changed.
- *
+ *
* @param suggestionPopup
* @param previousListSize
*/
diff --git a/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java b/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java
index 4edf771..ce4ba2b 100644
--- a/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java
@@ -38,7 +38,7 @@
/**
* Called when a suggestion popup's selected index has changed.
- *
+ *
* @param suggestionPopup
* @param previousSelectedIndex
*/
@@ -46,7 +46,7 @@
/**
* Called when a suggestion popup's selected suggestion has changed.
- *
+ *
* @param suggestionPopup The source of the event.
* @param previousSelectedSuggestion The item that was previously selected,
* or <tt>null</tt> if the previous selection cannot be determined.
diff --git a/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java b/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java
index f0d203f..7fabe13 100644
--- a/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java
@@ -44,7 +44,7 @@
/**
* Called to preview a suggestion popup close event.
- *
+ *
* @param suggestionPopup
* @param result
*/
@@ -52,7 +52,7 @@
/**
* Called when a suggestion popup close event has been vetoed.
- *
+ *
* @param suggestionPopup
* @param reason
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TabPane.java b/wtk/src/org/apache/pivot/wtk/TabPane.java
index 0daebb7..d77727c 100644
--- a/wtk/src/org/apache/pivot/wtk/TabPane.java
+++ b/wtk/src/org/apache/pivot/wtk/TabPane.java
@@ -389,7 +389,7 @@
/**
* Collapse or expand the TabPane (if it is collapsible).
- *
+ *
* @param collapsed <tt>true</tt> to collapse, <tt>false</tt> to expand and
* select the first tab. Use {@link #setSelectedIndex(int)} to expand and
* select a specific Tab.
diff --git a/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java b/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java
index 0ed0c90..7c7ca3f 100644
--- a/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java
@@ -38,7 +38,7 @@
/**
* Called when a tab's tab data attribute has changed.
- *
+ *
* @param tabPane
* @param component
* @param previousTabData
@@ -47,7 +47,7 @@
/**
* Called when a tab's tooltipText attribute has changed.
- *
+ *
* @param tabPane
* @param component
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TabPaneListener.java b/wtk/src/org/apache/pivot/wtk/TabPaneListener.java
index d8e3bec..ca8e2da 100644
--- a/wtk/src/org/apache/pivot/wtk/TabPaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TabPaneListener.java
@@ -71,7 +71,7 @@
/**
* Called when a tab has been inserted into a tab pane's tab sequence.
- *
+ *
* @param tabPane
* @param index
*/
@@ -79,7 +79,7 @@
/**
* Called to preview a tab removal.
- *
+ *
* @param tabPane
* @param index
* @param count
@@ -88,7 +88,7 @@
/**
* Called when a tab removal has been vetoed.
- *
+ *
* @param tabPane
* @param reason
*/
@@ -96,7 +96,7 @@
/**
* Called when a tab has been removed from a tab pane's tab sequence.
- *
+ *
* @param tabPane
* @param index
* @param tabs
@@ -105,7 +105,7 @@
/**
* Called when a tab pane's corner component has changed.
- *
+ *
* @param tabPane
* @param previousCorner
*/
@@ -113,7 +113,7 @@
/**
* Called when a tab pane's tab data renderer has changed.
- *
+ *
* @param tabPane
* @param previousTabDataRenderer
*/
@@ -121,14 +121,14 @@
/**
* Called when a tab pane's closeable property has changed.
- *
+ *
* @param tabPane
*/
public void closeableChanged(TabPane tabPane);
/**
* Called when a tab pane's collapsible property has changed.
- *
+ *
* @param tabPane
*/
public void collapsibleChanged(TabPane tabPane);
diff --git a/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java b/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java
index e0ea7d6..4735dbc 100644
--- a/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java
@@ -44,7 +44,7 @@
/**
* Called to preview a selected index change.
- *
+ *
* @param tabPane The source of the event.
* @param selectedIndex The index that will be selected.
*/
@@ -52,7 +52,7 @@
/**
* Called when a selected index change has been vetoed.
- *
+ *
* @param tabPane The source of the event.
* @param reason The reason the event was vetoed.
*/
@@ -60,7 +60,7 @@
/**
* Called when a tab pane's selected index has changed.
- *
+ *
* @param tabPane The source of the event.
* @param previousSelectedIndex If the selection changed directly, contains
* the index that was previously selected. Otherwise, contains the current
diff --git a/wtk/src/org/apache/pivot/wtk/TablePane.java b/wtk/src/org/apache/pivot/wtk/TablePane.java
index 2ddb95b..19b5f47 100644
--- a/wtk/src/org/apache/pivot/wtk/TablePane.java
+++ b/wtk/src/org/apache/pivot/wtk/TablePane.java
@@ -67,7 +67,7 @@
/**
* Returns the table pane with which this row is associated.
- *
+ *
* @return The row's table pane, or <tt>null</tt> if the row does not
* currently belong to a table.
*/
@@ -77,7 +77,7 @@
/**
* Returns the row height.
- *
+ *
* @return The height of the row.
*/
public int getHeight() {
@@ -86,7 +86,7 @@
/**
* Returns the relative flag.
- *
+ *
* @return <tt>true</tt> if the row height is relative, <tt>false</tt>
* if it is fixed.
*/
@@ -96,7 +96,7 @@
/**
* Set the row height.
- *
+ *
* @param height The absolute height of the row.
*/
public void setHeight(int height) {
@@ -105,7 +105,7 @@
/**
* Set the row height.
- *
+ *
* @param height The encoded height of the row. If the string ends with
* the '*' character, it is treated as a relative value. Otherwise, it
* is considered an absolute value.
@@ -124,7 +124,7 @@
/**
* Sets the row height.
- *
+ *
* @param height The height of the row.
* @param relative <tt>true</tt> if the row height is relative,
* <tt>false</tt> if it is fixed.
@@ -146,7 +146,7 @@
/**
* Returns the highlighted flag.
- *
+ *
* @return <tt>true</tt> if the row is highlighted, <tt>false</tt> if it
* is not
*/
@@ -156,7 +156,7 @@
/**
* Sets the highlighted flag.
- *
+ *
* @param highlighted <tt>true</tt> to set the row as highlighted,
* <tt>false</tt> to set it as not highlighted
*/
@@ -298,7 +298,7 @@
/**
* Returns the table pane with which this column is associated.
- *
+ *
* @return The column's table pane, or <tt>null</tt> if the column does
* not currently belong to a table.
*/
@@ -308,7 +308,7 @@
/**
* Returns the column width.
- *
+ *
* @return The width of the column.
*/
public int getWidth() {
@@ -317,7 +317,7 @@
/**
* Returns the relative flag.
- *
+ *
* @return <tt>true</tt> if the column width is relative, <tt>false</tt>
* if it is fixed.
*/
@@ -327,7 +327,7 @@
/**
* Set the column width.
- *
+ *
* @param width The absolute width of the column.
*/
public void setWidth(int width) {
@@ -336,7 +336,7 @@
/**
* Set the column width.
- *
+ *
* @param width The encoded width of the row. If the string ends with
* the '*' character, it is treated as a relative value. Otherwise, it
* is considered an absolute value.
@@ -355,7 +355,7 @@
/**
* Sets the column width.
- *
+ *
* @param width The width of the column.
* @param relative <tt>true</tt> if the column width is relative,
* <tt>false</tt> if it is fixed.
@@ -377,7 +377,7 @@
/**
* Returns the highlighted flag.
- *
+ *
* @return <tt>true</tt> if the column is highlighted, <tt>false</tt> if
* it is not
*/
@@ -387,7 +387,7 @@
/**
* Sets the highlighted flag.
- *
+ *
* @param highlighted <tt>true</tt> to set the column as highlighted,
* <tt>false</tt> to set it as not highlighted
*/
@@ -731,7 +731,7 @@
/**
* Creates a new <tt>TablePane</tt> with the specified columns.
- *
+ *
* @param columns The column sequence to use. A copy of this sequence will
* be made
*/
@@ -758,7 +758,7 @@
/**
* Returns the table pane row sequence.
- *
+ *
* @return The table pane row sequence
*/
public RowSequence getRows() {
@@ -767,7 +767,7 @@
/**
* Returns the index of the row at a given location.
- *
+ *
* @param y The y-coordinate of the row to identify.
* @return The row index, or <tt>-1</tt> if there is no row at the given
* y-coordinate.
@@ -779,7 +779,7 @@
/**
* Returns the bounds of a given row.
- *
+ *
* @param row The row index.
*/
public Bounds getRowBounds(int row) {
@@ -789,7 +789,7 @@
/**
* Returns the table pane column sequence.
- *
+ *
* @return The table pane column sequence
*/
public ColumnSequence getColumns() {
@@ -798,7 +798,7 @@
/**
* Returns the index of the column at a given location.
- *
+ *
* @param x The x-coordinate of the column to identify.
* @return The column index, or <tt>-1</tt> if there is no column at the
* given x-coordinate.
@@ -810,7 +810,7 @@
/**
* Returns the bounds of a given column.
- *
+ *
* @param column The column index.
*/
public Bounds getColumnBounds(int column) {
@@ -820,7 +820,7 @@
/**
* Gets the component at the specified cell in this table pane.
- *
+ *
* @param rowIndex The row index of the cell
* @param columnIndex The column index of the cell
* @return The component in the specified cell, or <tt>null</tt> if the cell
@@ -841,7 +841,7 @@
/**
* Overrides the base method to check whether or not a cell component is
* being removed, and fires the appropriate event in that case.
- *
+ *
* @param index The index at which components were removed
* @param count The number of components removed
* @return The sequence of components that were removed
diff --git a/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java b/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java
index 71d626b..42d955a 100644
--- a/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java
@@ -38,7 +38,7 @@
/**
* Called when a component's row span attribute has changed.
- *
+ *
* @param tablePane
* @param component
* @param previousRowSpan
@@ -47,7 +47,7 @@
/**
* Called when a component's column span attribute has changed.
- *
+ *
* @param tablePane
* @param component
* @param previousColumnSpan
diff --git a/wtk/src/org/apache/pivot/wtk/TablePaneListener.java b/wtk/src/org/apache/pivot/wtk/TablePaneListener.java
index 046d359..34717cc 100644
--- a/wtk/src/org/apache/pivot/wtk/TablePaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TablePaneListener.java
@@ -86,7 +86,7 @@
/**
* Called when a row has been inserted into a table pane.
- *
+ *
* @param tablePane
* @param index
*/
@@ -94,7 +94,7 @@
/**
* Called when rows have been removed from a table pane.
- *
+ *
* @param tablePane
* @param index
* @param rows
@@ -103,7 +103,7 @@
/**
* Called when a row's height has changed.
- *
+ *
* @param row
* @param previousHeight
* @param previousRelative
@@ -112,14 +112,14 @@
/**
* Called when a row's highlighted state has changed.
- *
+ *
* @param row
*/
public void rowHighlightedChanged(TablePane.Row row);
/**
* Called when a column has been inserted into a table pane.
- *
+ *
* @param tablePane
* @param index
*/
@@ -127,7 +127,7 @@
/**
* Called when column's have been removed from a table pane.
- *
+ *
* @param tablePane
* @param index
* @param columns
@@ -136,7 +136,7 @@
/**
* Called when a column's width has changed.
- *
+ *
* @param column
* @param previousWidth
* @param previousRelative
@@ -146,14 +146,14 @@
/**
* Called when a column's highlighted state has changed.
- *
+ *
* @param column
*/
public void columnHighlightedChanged(TablePane.Column column);
/**
* Called when a cell has been inserted into a table pane.
- *
+ *
* @param row
* @param column
*/
@@ -161,7 +161,7 @@
/**
* Called when cell's have been removed from a table pane.
- *
+ *
* @param row
* @param column
* @param removed
@@ -170,7 +170,7 @@
/**
* Called when a cell has been updated in a table pane.
- *
+ *
* @param row
* @param column
* @param previousComponent
diff --git a/wtk/src/org/apache/pivot/wtk/TableView.java b/wtk/src/org/apache/pivot/wtk/TableView.java
index c01faba..8979c09 100644
--- a/wtk/src/org/apache/pivot/wtk/TableView.java
+++ b/wtk/src/org/apache/pivot/wtk/TableView.java
@@ -80,7 +80,7 @@
/**
* Creates a new column with no header data and a fixed default width.
- *
+ *
* @param name The column name.
*/
public Column(String name) {
@@ -89,7 +89,7 @@
/**
* Creates a new column with a fixed default width.
- *
+ *
* @param name The column name.
* @param headerData The column header data.
*/
@@ -99,7 +99,7 @@
/**
* Creates a new column with a fixed width.
- *
+ *
* @param name The column name.
* @param headerData The column header data.
* @param width The width of the column.
@@ -110,7 +110,7 @@
/**
* Creates a new column.
- *
+ *
* @param name The column name.
* @param headerData The column header data.
* @param width The width of the column.
@@ -125,7 +125,7 @@
/**
* Returns the table view with which this column is associated.
- *
+ *
* @return The column's table view, or <tt>null</tt> if the column does
* not currently belong to a table.
*/
@@ -135,7 +135,7 @@
/**
* Returns the column name.
- *
+ *
* @return The column name.
*/
public String getName() {
@@ -144,7 +144,7 @@
/**
* Sets the column name.
- *
+ *
* @param name The column name.
*/
public void setName(String name) {
@@ -161,7 +161,7 @@
/**
* Returns the column header data.
- *
+ *
* @return The column header data, or <tt>null</tt> if the column has no
* header data.
*/
@@ -171,7 +171,7 @@
/**
* Sets the column header data.
- *
+ *
* @param headerData The column header data, or <tt>null</tt> for no
* header data.
*/
@@ -197,7 +197,7 @@
/**
* Sets the column header data renderer.
- *
+ *
* @param headerDataRenderer
*/
public void setHeaderDataRenderer(HeaderDataRenderer headerDataRenderer) {
@@ -218,7 +218,7 @@
/**
* Returns the column width.
- *
+ *
* @return The width of the column.
*/
public int getWidth() {
@@ -227,7 +227,7 @@
/**
* Returns the relative flag.
- *
+ *
* @return <tt>true</tt> if the column width is relative, <tt>false</tt>
* if it is fixed.
*/
@@ -237,7 +237,7 @@
/**
* Set the column width.
- *
+ *
* @param width The absolute width of the column.
*/
public void setWidth(int width) {
@@ -246,7 +246,7 @@
/**
* Set the column width.
- *
+ *
* @param width The encoded width of the row. If the string ends with
* the '*' character, it is treated as a relative value. Otherwise, it
* is considered an absolute value.
@@ -265,7 +265,7 @@
/**
* Sets the column width.
- *
+ *
* @param width The width of the column.
* @param relative <tt>true</tt> if the column width is relative,
* <tt>false</tt> if it is fixed.
@@ -298,7 +298,7 @@
/**
* Sets the minimum and maximum widths the column can size to.
- *
+ *
* @param minimumWidth Column width cannot be smaller than this size.
* @param maximumWidth Column width cannot be greater than this size.
*/
@@ -328,7 +328,7 @@
/**
* Sets the minimum and maximum widths to which the column can size.
- *
+ *
* @param widthLimits The new width limits.
*/
public void setWidthLimits(Limits widthLimits) {
@@ -337,7 +337,7 @@
/**
* Gets the minimum width the column is allowed to be.
- *
+ *
* @return Minimum column width.
*/
public int getMinimumWidth() {
@@ -346,7 +346,7 @@
/**
* Sets the minimum width the column is allowed to be.
- *
+ *
* @param minimumWidth Minimum column width.
*/
public void setMinimumWidth(int minimumWidth) {
@@ -355,7 +355,7 @@
/**
* Get the maximum width the column is allowed to be.
- *
+ *
* @return Maximum column width.
*/
public int getMaximumWidth() {
@@ -364,7 +364,7 @@
/**
* Set the maximum width the column is allowed to be.
- *
+ *
* @param maximumWidth Maximum column width.
*/
public void setMaximumWidth(int maximumWidth) {
@@ -373,7 +373,7 @@
/**
* Returns the column's filter.
- *
+ *
* @return The column's filter, or <tt>null</tt> if the column does not
* have a filter.
*/
@@ -383,7 +383,7 @@
/**
* Sets the column's filter.
- *
+ *
* @param filter The column's filter, or <tt>null</tt> for no filter.
*/
public void setFilter(Object filter) {
@@ -400,7 +400,7 @@
/**
* Returns the column's cell renderer.
- *
+ *
* @return The cell renderer that is used to draw the contents of this
* column.
*/
@@ -410,7 +410,7 @@
/**
* Sets the column's cell renderer.
- *
+ *
* @param cellRenderer The cell renderer that is used to draw the
* contents of this column.
*/
@@ -459,7 +459,7 @@
public interface CellRenderer extends Renderer {
/**
* Prepares the renderer for layout or paint.
- *
+ *
* @param row The row to render, or <tt>null</tt> if called to calculate
* preferred height for skins that assume a fixed renderer height.
* @param rowIndex The index of the row being rendered, or <tt>-1</tt> if
@@ -476,7 +476,7 @@
/**
* Converts table view cell data to a string representation.
- *
+ *
* @param row
* @param columnName
* @return The cell data's string representation, or <tt>null</tt> if the
@@ -494,7 +494,7 @@
public interface HeaderDataRenderer extends Renderer {
/**
* Prepares the renderer for layout or paint.
- *
+ *
* @param data The data to render, or <tt>null</tt> if called to
* calculate preferred height for skins that assume a fixed renderer
* height.
@@ -508,7 +508,7 @@
/**
* Converts table view header data to a string representation.
- *
+ *
* @param item
* @return The data's string representation, or <tt>null</tt> if the data
* does not have a string representation. <p> Note that this method may
@@ -524,7 +524,7 @@
public interface RowEditor {
/**
* Called to begin editing a table row.
- *
+ *
* @param tableView
* @param rowIndex
* @param columnIndex
@@ -533,7 +533,7 @@
/**
* Terminates an edit operation.
- *
+ *
* @param result <tt>true</tt> to perform the edit; <tt>false</tt> to
* cancel it.
*/
@@ -566,14 +566,14 @@
public interface TableDataBindMapping {
/**
* Converts a context value to table data.
- *
+ *
* @param value
*/
public List<?> toTableData(Object value);
/**
* Converts table data to a context value.
- *
+ *
* @param tableData
*/
public Object valueOf(List<?> tableData);
@@ -585,7 +585,7 @@
public interface SelectedRowBindMapping {
/**
* Returns the index of the row in the source list.
- *
+ *
* @param tableData The source table data.
* @param value The value to locate.
* @return The index of first occurrence of the value if it exists in the
@@ -595,7 +595,7 @@
/**
* Retrieves the value at the given index.
- *
+ *
* @param tableData The source table data.
* @param index The index of the value to retrieve.
*/
@@ -1166,7 +1166,7 @@
/**
* Creates a new table view populated with the given table data.
- *
+ *
* @param tableData
*/
public TableView(List<?> tableData) {
@@ -1186,7 +1186,7 @@
/**
* Returns the table column sequence.
- *
+ *
* @return The table column sequence.
*/
public ColumnSequence getColumns() {
@@ -1201,7 +1201,7 @@
/**
* Returns the table data.
- *
+ *
* @return The data currently presented by the table view.
*/
public List<?> getTableData() {
@@ -1210,7 +1210,7 @@
/**
* Sets the table data.
- *
+ *
* @param tableData The data to be presented by the table view.
*/
@SuppressWarnings("unchecked")
@@ -1251,7 +1251,7 @@
/**
* Sets the table data.
- *
+ *
* @param tableData A JSON string (must begin with <tt>[</tt> and end with
* <tt>]</tt>) denoting the data to be presented by the table view.
*/
@@ -1269,7 +1269,7 @@
/**
* Sets the table data.
- *
+ *
* @param tableData A URL referring to a JSON file containing the data to be
* presented by the table view.
*/
@@ -1304,7 +1304,7 @@
/**
* Returns the editor used to edit rows in this table.
- *
+ *
* @return The row editor, or <tt>null</tt> if no editor is installed.
*/
public RowEditor getRowEditor() {
@@ -1313,7 +1313,7 @@
/**
* Sets the editor used to edit rows in this table.
- *
+ *
* @param rowEditor The row editor for the list.
*/
public void setRowEditor(RowEditor rowEditor) {
@@ -1327,7 +1327,7 @@
/**
* Returns the currently selected index, even when in multi-select mode.
- *
+ *
* @return The currently selected index.
*/
public int getSelectedIndex() {
@@ -1336,7 +1336,7 @@
/**
* Sets the selection to a single index.
- *
+ *
* @param index The index to select, or <tt>-1</tt> to clear the selection.
*/
public void setSelectedIndex(int index) {
@@ -1352,7 +1352,7 @@
/**
* Sets the selection to a single range.
- *
+ *
* @param start
* @param end
*/
@@ -1365,7 +1365,7 @@
/**
* Returns the currently selected ranges.
- *
+ *
* @return An immutable list containing the currently selected ranges. Note
* that the returned list is a wrapper around the actual selection, not a
* copy. Any changes made to the selection state will be reflected in the
@@ -1379,7 +1379,7 @@
* Sets the selection to the given range sequence. Any overlapping or
* connecting ranges will be consolidated, and the resulting selection will
* be sorted in ascending order.
- *
+ *
* @param selectedRanges
* @return The ranges that were actually set.
*/
@@ -1431,7 +1431,7 @@
/**
* Sets the selection to the given range sequence.
- *
+ *
* @param selectedRanges A JSON-formatted string containing the ranges to
* select.
* @return The ranges that were actually set.
@@ -1466,7 +1466,7 @@
/**
* Returns the first selected index.
- *
+ *
* @return The first selected index, or <tt>-1</tt> if nothing is selected.
*/
public int getFirstSelectedIndex() {
@@ -1475,7 +1475,7 @@
/**
* Returns the last selected index.
- *
+ *
* @return The last selected index, or <tt>-1</tt> if nothing is selected.
*/
public int getLastSelectedIndex() {
@@ -1485,7 +1485,7 @@
/**
* Adds a single index to the selection.
- *
+ *
* @param index The index to add.
* @return <tt>true</tt> if the index was added to the selection;
* <tt>false</tt>, otherwise.
@@ -1497,7 +1497,7 @@
/**
* Adds a range of indexes to the selection.
- *
+ *
* @param start The first index in the range.
* @param end The last index in the range.
* @return The ranges that were added to the selection.
@@ -1532,7 +1532,7 @@
/**
* Adds a range of indexes to the selection.
- *
+ *
* @param range The range to add.
* @return The ranges that were added to the selection.
*/
@@ -1546,7 +1546,7 @@
/**
* Removes a single index from the selection.
- *
+ *
* @param index The index to remove.
* @return <tt>true</tt> if the index was removed from the selection;
* <tt>false</tt>, otherwise.
@@ -1558,7 +1558,7 @@
/**
* Removes a range of indexes from the selection.
- *
+ *
* @param start The start of the range to remove.
* @param end The end of the range to remove.
* @return The ranges that were removed from the selection.
@@ -1594,7 +1594,7 @@
/**
* Removes a range of indexes from the selection.
- *
+ *
* @param range The range to remove.
* @return The ranges that were removed from the selection.
*/
@@ -1624,7 +1624,7 @@
/**
* Returns the selection state of a given index.
- *
+ *
* @param index The index whose selection state is to be tested.
* @return <tt>true</tt> if the index is selected; <tt>false</tt>, otherwise.
*/
@@ -1699,7 +1699,7 @@
/**
* Sets the selection mode. Clears the selection if the mode has changed.
- *
+ *
* @param selectMode The new selection mode.
*/
public void setSelectMode(SelectMode selectMode) {
@@ -1730,7 +1730,7 @@
/**
* Sets the table view's sort.
- *
+ *
* @param columnName
* @param sortDirection
*/
@@ -1746,7 +1746,7 @@
/**
* Sets the table view's sort.
- *
+ *
* @param sort A sequence of key/value pairs representing the sort. Keys
* represent column names and values represent sort direction.
*/
@@ -1775,7 +1775,7 @@
/**
* Sets the table view's sort.
- *
+ *
* @param sort A JSON list containing JSON objects representing the sort.
* @see #setSort(Sequence)
*/
@@ -1824,7 +1824,7 @@
/**
* Returns the disabled state of a given row.
- *
+ *
* @param index The index of the row whose disabled state is to be tested.
* @return <tt>true</tt> if the row is disabled; <tt>false</tt>, otherwise.
*/
@@ -1842,7 +1842,7 @@
/**
* Returns the disabled row filter.
- *
+ *
* @return The disabled row filter, or <tt>null</tt> if no disabled row
* filter is set.
*/
@@ -1852,7 +1852,7 @@
/**
* Sets the disabled row filter.
- *
+ *
* @param disabledRowFilter The disabled row filter, or <tt>null</tt> for no
* disabled row filter.
*/
@@ -2158,7 +2158,7 @@
/**
* Returns the index of the row at a given location.
- *
+ *
* @param y The y-coordinate of the row to identify.
* @return The row index, or <tt>-1</tt> if there is no row at the given
* y-coordinate.
@@ -2170,7 +2170,7 @@
/**
* Returns the index of the column at a given location.
- *
+ *
* @param x The x-coordinate of the column to identify.
* @return The column index, or <tt>-1</tt> if there is no column at the
* given x-coordinate.
@@ -2182,7 +2182,7 @@
/**
* Returns the bounding area of a given row.
- *
+ *
* @param rowIndex The row index.
* @return The bounding area of the row.
*/
@@ -2193,7 +2193,7 @@
/**
* Returns the bounding area of a given column.
- *
+ *
* @param columnIndex The column index.
* @return The bounding area of the column.
*/
@@ -2204,7 +2204,7 @@
/**
* Returns the bounding area of a given cell.
- *
+ *
* @param rowIndex The row index of the cell.
* @param columnIndex The column index of the cell.
* @return The bounding area of the cell.
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java b/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java
index e52f70d..099fbad 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java
@@ -77,7 +77,7 @@
/**
* Called when a table view's table data key has changed.
- *
+ *
* @param tableView
* @param previousTableDataKey
*/
@@ -85,7 +85,7 @@
/**
* Called when a table view's table data bind type has changed.
- *
+ *
* @param tableView
* @param previousTableDataBindType
*/
@@ -93,7 +93,7 @@
/**
* Called when a table view's table data bind mapping has changed.
- *
+ *
* @param tableView
* @param previousTableDataBindMapping
*/
@@ -102,7 +102,7 @@
/**
* Called when a table view's selected row key has changed.
- *
+ *
* @param tableView
* @param previousSelectedRowKey
*/
@@ -110,7 +110,7 @@
/**
* Called when a table view's selected row bind type has changed.
- *
+ *
* @param tableView
* @param previousSelectedRowBindType
*/
@@ -118,7 +118,7 @@
/**
* Called when a table view's selected row bind mapping has changed.
- *
+ *
* @param tableView
* @param previousSelectedRowBindMapping
*/
@@ -127,7 +127,7 @@
/**
* Called when a table view's selected rows key has changed.
- *
+ *
* @param tableView
* @param previousSelectedRowsKey
*/
@@ -135,7 +135,7 @@
/**
* Called when a table view's selected rows bind type has changed.
- *
+ *
* @param tableView
* @param previousSelectedRowsBindType
*/
@@ -144,7 +144,7 @@
/**
* Called when a table view's selected rows bind mapping has changed.
- *
+ *
* @param tableView
* @param previousSelectedRowsBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java b/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java
index 9d7ba3c..b06eadd 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java
@@ -79,7 +79,7 @@
/**
* Called when a column is inserted into a table view's column sequence.
- *
+ *
* @param tableView
* @param index
*/
@@ -87,7 +87,7 @@
/**
* Called when columns are removed from a table view's column sequence.
- *
+ *
* @param tableView
* @param index
* @param columns
@@ -96,7 +96,7 @@
/**
* Called when a column's name has changed.
- *
+ *
* @param column
* @param previousName
*/
@@ -104,7 +104,7 @@
/**
* Called when a column's header data has changed.
- *
+ *
* @param column
* @param previousHeaderData
*/
@@ -112,7 +112,7 @@
/**
* Called when a column's header data renderer has changed.
- *
+ *
* @param column
* @param previousHeaderDataRenderer
*/
@@ -121,7 +121,7 @@
/**
* Called when a column's width has changed.
- *
+ *
* @param column
* @param previousWidth
* @param previousRelative
@@ -131,7 +131,7 @@
/**
* Called when a column's width limits have changed.
- *
+ *
* @param column
* @param previousMinimumWidth
* @param previousMaximumWidth
@@ -141,7 +141,7 @@
/**
* Called when a column's filter has changed.
- *
+ *
* @param column
* @param previousFilter
*/
@@ -149,7 +149,7 @@
/**
* Called when a column's cell renderer has changed.
- *
+ *
* @param column
* @param previousCellRenderer
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewHeader.java b/wtk/src/org/apache/pivot/wtk/TableViewHeader.java
index 7df6b92..4bc54c3 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewHeader.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewHeader.java
@@ -126,7 +126,7 @@
/**
* Returns the index of the header at a given location.
- *
+ *
* @param x The x-coordinate of the header to identify.
* @return The column index, or <tt>-1</tt> if there is no column at the
* given x-coordinate.
@@ -138,7 +138,7 @@
/**
* Returns the bounding area of a given header.
- *
+ *
* @param index The index of the header.
* @return The bounding area of the header.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java b/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java
index d5af09d..ae91e51 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java
@@ -39,7 +39,7 @@
/**
* Called when a table view header's table view has changed.
- *
+ *
* @param tableViewHeader
* @param previousTableView
*/
@@ -47,7 +47,7 @@
/**
* Called when a table view header's sort mode has changed.
- *
+ *
* @param tableViewHeader
* @param previousSortMode
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java b/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java
index ea468d3..8030750 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java
@@ -22,7 +22,7 @@
public interface TableViewHeaderPressListener {
/**
* Called when a table view header has been pressed.
- *
+ *
* @param tableViewHeader
* @param index
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewListener.java b/wtk/src/org/apache/pivot/wtk/TableViewListener.java
index 844ac4f..283fa3e 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewListener.java
@@ -56,7 +56,7 @@
/**
* Called when a table view's table data has changed.
- *
+ *
* @param tableView
* @param previousTableData
*/
@@ -64,7 +64,7 @@
/**
* Called when a table view's column source has changed.
- *
+ *
* @param tableView
* @param previousColumnSource
*/
@@ -72,7 +72,7 @@
/**
* Called when a table view's row editor has changed.
- *
+ *
* @param tableView
* @param previousRowEditor
*/
@@ -80,7 +80,7 @@
/**
* Called when a table view's select mode has changed.
- *
+ *
* @param tableView
* @param previousSelectMode
*/
@@ -88,7 +88,7 @@
/**
* Called when a table view's disabled row filter has changed.
- *
+ *
* @param tableView
* @param previousDisabledRowFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java b/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java
index 4255165..9f8d9de 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java
@@ -52,7 +52,7 @@
/**
* Called when a row has been inserted into the table view.
- *
+ *
* @param tableView The source of the event.
* @param index The index of the row that was inserted.
*/
@@ -60,7 +60,7 @@
/**
* Called when rows have been removed from the table view.
- *
+ *
* @param tableView The source of the event.
* @param index The first index affected by the event.
* @param count The number of rows that were removed, or <tt>-1</tt> if all
@@ -70,7 +70,7 @@
/**
* Called when an row in the table view has been updated.
- *
+ *
* @param tableView The source of the event.
* @param index The first index affected by the event.
*/
@@ -78,14 +78,14 @@
/**
* Called when the rows in a table view have been cleared.
- *
+ *
* @param tableView
*/
public void rowsCleared(TableView tableView);
/**
* Called when the rows in a table have been sorted.
- *
+ *
* @param tableView The source of the event.
*/
public void rowsSorted(TableView tableView);
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewSelectionListener.java b/wtk/src/org/apache/pivot/wtk/TableViewSelectionListener.java
index eeec272..15e1fe4 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewSelectionListener.java
@@ -49,7 +49,7 @@
/**
* Called when a range has been added to a table view's selection.
- *
+ *
* @param tableView The source of the event.
* @param rangeStart The start index of the range that was added, inclusive.
* @param rangeEnd The end index of the range that was added, inclusive.
@@ -58,7 +58,7 @@
/**
* Called when a range has been removed from a table view's selection.
- *
+ *
* @param tableView The source of the event.
* @param rangeStart The start index of the range that was removed,
* inclusive.
@@ -68,7 +68,7 @@
/**
* Called when a table view's selection state has been reset.
- *
+ *
* @param tableView The source of the event.
* @param previousSelectedRanges If the selection changed directly, contains
* the ranges that were previously selected. If the selection changed
@@ -79,7 +79,7 @@
/**
* Called when a table view's selected item has changed.
- *
+ *
* @param tableView The source of the event.
* @param previousSelectedRow The row that was previously selected.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java b/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java
index b250a55..3b3b019 100644
--- a/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java
@@ -48,7 +48,7 @@
/**
* Called when a sort has been added to a table view.
- *
+ *
* @param tableView
* @param columnName
*/
@@ -56,7 +56,7 @@
/**
* Called when a sort has been updated in a table view.
- *
+ *
* @param tableView
* @param columnName
* @param previousSortDirection
@@ -66,7 +66,7 @@
/**
* Called when a sort has been removed from a table view.
- *
+ *
* @param tableView
* @param columnName
* @param sortDirection
@@ -75,7 +75,7 @@
/**
* Called when a table view's sort has changed.
- *
+ *
* @param tableView
*/
public void sortChanged(TableView tableView);
diff --git a/wtk/src/org/apache/pivot/wtk/TaskAdapter.java b/wtk/src/org/apache/pivot/wtk/TaskAdapter.java
index d2a4035..d55da57 100644
--- a/wtk/src/org/apache/pivot/wtk/TaskAdapter.java
+++ b/wtk/src/org/apache/pivot/wtk/TaskAdapter.java
@@ -63,7 +63,7 @@
/**
* Creates a new <tt>TaskAdapter</tt> that wraps the specified task
* listener.
- *
+ *
* @param taskListener The task listener that will be notified on the UI
* thread
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TextArea.java b/wtk/src/org/apache/pivot/wtk/TextArea.java
index 7e07ead..42af3f6 100644
--- a/wtk/src/org/apache/pivot/wtk/TextArea.java
+++ b/wtk/src/org/apache/pivot/wtk/TextArea.java
@@ -189,7 +189,7 @@
/**
* Called when text has been inserted into a paragraph.
- *
+ *
* @param paragraph The source of the event.
* @param index The index at which the text was inserted.
* @param count The number of characters that were inserted.
@@ -198,7 +198,7 @@
/**
* Called when characters have been removed from a paragraph.
- *
+ *
* @param paragraph The source of the event.
* @param index The index from which the text was removed.
* @param count The number of characters that were removed.
@@ -219,7 +219,7 @@
public interface Skin {
/**
* Returns the insertion point for a given location.
- *
+ *
* @param x
* @param y
*/
@@ -228,7 +228,7 @@
/**
* Returns the next insertion point given an x coordinate and a
* character index.
- *
+ *
* @param x
* @param from
* @param direction
@@ -237,7 +237,7 @@
/**
* Returns the row index of the character at a given index.
- *
+ *
* @param index
*/
public int getRowAt(int index);
@@ -245,7 +245,7 @@
/**
* Returns the index of the first character in the row containing a
* given character index.
- *
+ *
* @param index
*/
public int getRowOffset(int index);
@@ -253,7 +253,7 @@
/**
* Returns the number of characters in the row containing a given
* character index.
- *
+ *
* @param index
*/
public int getRowLength(int index);
@@ -265,7 +265,7 @@
/**
* Returns the bounds of the character at a given index.
- *
+ *
* @param index
*/
public Bounds getCharacterBounds(int index);
@@ -284,7 +284,7 @@
/**
* Converts a value from the bind context to a text representation
* during a {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public String toString(Object value);
@@ -292,7 +292,7 @@
/**
* Converts a text string to a value to be stored in the bind context
* during a {@link Component#store(Object)} operation.
- *
+ *
* @param text
*/
public Object valueOf(String text);
@@ -609,7 +609,7 @@
/**
* Returns the text content of the text area.
- *
+ *
* @return A string containing a copy of the text area's text content.
*/
public String getText() {
@@ -618,7 +618,7 @@
/**
* Returns a portion of the text content of the text area.
- *
+ *
* @param beginIndex
* @param endIndex
* @return A string containing a copy of the text area's text content.
@@ -664,7 +664,7 @@
/**
* Sets the text content of the text area.
- *
+ *
* @param text
*/
public void setText(String text) {
@@ -879,7 +879,7 @@
/**
* Returns the index of the paragraph containing a given character index.
- *
+ *
* @param index
*/
public int getParagraphAt(int index) {
@@ -897,7 +897,7 @@
/**
* Returns the character at a given index.
- *
+ *
* @param index
*/
public char getCharacterAt(int index) {
@@ -987,7 +987,7 @@
/**
* Returns the starting index of the selection.
- *
+ *
* @return The starting index of the selection.
*/
public int getSelectionStart() {
@@ -996,7 +996,7 @@
/**
* Returns the length of the selection.
- *
+ *
* @return The length of the selection; may be <tt>0</tt>.
*/
public int getSelectionLength() {
@@ -1005,7 +1005,7 @@
/**
* Returns a span representing the current selection.
- *
+ *
* @return A span containing the current selection. Both start and end
* points are inclusive. Returns <tt>null</tt> if the selection is empty.
*/
@@ -1017,7 +1017,7 @@
/**
* Sets the selection. The sum of the selection start and length must be
* less than the length of the text area's content.
- *
+ *
* @param selectionStart The starting index of the selection.
* @param selectionLength The length of the selection.
*/
@@ -1044,7 +1044,7 @@
/**
* Sets the selection.
- *
+ *
* @param selection
* @see #setSelection(int, int)
*/
@@ -1072,7 +1072,7 @@
/**
* Returns the selected text.
- *
+ *
* @return A string containing a copy of the selected text.
*/
public String getSelectedText() {
@@ -1081,7 +1081,7 @@
/**
* Returns the maximum length of the text area's text content.
- *
+ *
* @return The maximum length of the text area's text content.
*/
public int getMaximumLength() {
@@ -1090,7 +1090,7 @@
/**
* Sets the maximum length of the text area's text content.
- *
+ *
* @param maximumLength The maximum length of the text area's text content.
*/
public void setMaximumLength(int maximumLength) {
@@ -1122,7 +1122,7 @@
/**
* Sets the text area's editable flag.
- *
+ *
* @param editable
*/
public void setEditable(boolean editable) {
@@ -1141,7 +1141,7 @@
/**
* Returns the text area's text key.
- *
+ *
* @return The text key, or <tt>null</tt> if no text key is set.
*/
public String getTextKey() {
@@ -1150,7 +1150,7 @@
/**
* Sets the text area's text key.
- *
+ *
* @param textKey The text key, or <tt>null</tt> to clear the binding.
*/
public void setTextKey(String textKey) {
@@ -1231,7 +1231,7 @@
* Sets whether tab characters (<code>\t</code>) are expanded to an
* appropriate number of spaces during {@link #setText} and
* {@link #insertText} operations.
- *
+ *
* @param expandTabs <code>true</code> to replace tab characters with space
* characters (depending on the setting of the
* {@link TextArea.Skin#getTabWidth} value) or <code>false</code> to leave
diff --git a/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java b/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java
index 9c7eb2d..225ae93 100644
--- a/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java
@@ -43,7 +43,7 @@
/**
* Called when a text area's text key has changed.
- *
+ *
* @param textArea
* @param previousTextKey
*/
@@ -51,7 +51,7 @@
/**
* Called when a text area's text bind type has changed.
- *
+ *
* @param textArea
* @param previousTextBindType
*/
@@ -59,7 +59,7 @@
/**
* Called when a text area's text bind mapping has changed.
- *
+ *
* @param textArea
* @param previousTextBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TextAreaContentListener.java b/wtk/src/org/apache/pivot/wtk/TextAreaContentListener.java
index 8444400..6d2aff5 100644
--- a/wtk/src/org/apache/pivot/wtk/TextAreaContentListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextAreaContentListener.java
@@ -46,7 +46,7 @@
/**
* Called when a paragraph has been inserted into a text area's paragraph
* sequence.
- *
+ *
* @param textArea The source of the event.
* @param index The index at which the paragraph was inserted.
*/
@@ -55,7 +55,7 @@
/**
* Called when paragraphs have been removed from a text area's paragraph
* sequence.
- *
+ *
* @param textArea The source of the event.
* @param index The starting index from which the paragraphs were removed.
* @param removed The paragraphs that were removed.
@@ -64,7 +64,7 @@
/**
* Called when a text area's text has changed.
- *
+ *
* @param textArea The source of the event.
*/
public void textChanged(TextArea textArea);
diff --git a/wtk/src/org/apache/pivot/wtk/TextAreaListener.java b/wtk/src/org/apache/pivot/wtk/TextAreaListener.java
index c8ac30e..0b13bcf 100644
--- a/wtk/src/org/apache/pivot/wtk/TextAreaListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextAreaListener.java
@@ -37,7 +37,7 @@
/**
* Called when a text area's maximum length has changed.
- *
+ *
* @param textArea
* @param previousMaximumLength
*/
@@ -45,7 +45,7 @@
/**
* Called when a text area's editable state has changed.
- *
+ *
* @param textArea
*/
public void editableChanged(TextArea textArea);
diff --git a/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java b/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java
index 562f8b6..5f4f9db 100644
--- a/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java
@@ -22,7 +22,7 @@
public interface TextAreaSelectionListener {
/**
* Called when a text area's selection state has changed.
- *
+ *
* @param textArea
* @param previousSelectionStart
* @param previousSelectionLength
diff --git a/wtk/src/org/apache/pivot/wtk/TextInput.java b/wtk/src/org/apache/pivot/wtk/TextInput.java
index 7636dbf..147c5d1 100644
--- a/wtk/src/org/apache/pivot/wtk/TextInput.java
+++ b/wtk/src/org/apache/pivot/wtk/TextInput.java
@@ -36,14 +36,14 @@
public interface Skin {
/**
* Returns the insertion point for a given location.
- *
+ *
* @param x
*/
public int getInsertionPoint(int x);
/**
* Returns the bounds of the character at a given index.
- *
+ *
* @param index
*/
public Bounds getCharacterBounds(int index);
@@ -56,7 +56,7 @@
/**
* Converts a value from the bind context to a text representation
* during a {@link Component#load(Object)} operation.
- *
+ *
* @param value
*/
public String toString(Object value);
@@ -64,7 +64,7 @@
/**
* Converts a text string to a value to be stored in the bind context
* during a {@link Component#store(Object)} operation.
- *
+ *
* @param text
*/
public Object valueOf(String text);
@@ -306,7 +306,7 @@
/**
* Returns the text content of the text input.
- *
+ *
* @return A string containing a copy of the text input's text content.
*/
public String getText() {
@@ -315,7 +315,7 @@
/**
* Returns a portion of the text content of the text input.
- *
+ *
* @param beginIndex
* @param endIndex
* @return A string containing a copy of the text area's text content.
@@ -469,7 +469,7 @@
/**
* Returns the character at a given index.
- *
+ *
* @param index
*/
public char getCharacterAt(int index) {
@@ -550,7 +550,7 @@
/**
* Returns the starting index of the selection.
- *
+ *
* @return The starting index of the selection.
*/
public int getSelectionStart() {
@@ -559,7 +559,7 @@
/**
* Returns the length of the selection.
- *
+ *
* @return The length of the selection; may be <tt>0</tt>.
*/
public int getSelectionLength() {
@@ -568,7 +568,7 @@
/**
* Returns a span representing the current selection.
- *
+ *
* @return A span containing the current selection. Both start and end
* points are inclusive. Returns <tt>null</tt> if the selection length is
* <tt>0</tt>.
@@ -581,7 +581,7 @@
/**
* Sets the selection. The sum of the selection start and length must be
* less than the length of the text input's content.
- *
+ *
* @param selectionStart The starting index of the selection.
* @param selectionLength The length of the selection.
*/
@@ -608,7 +608,7 @@
/**
* Sets the selection.
- *
+ *
* @param selection
* @see #setSelection(int, int)
*/
@@ -636,7 +636,7 @@
/**
* Returns the currently selected text.
- *
+ *
* @return A new string containing a copy of the text in the selected range.
*/
public String getSelectedText() {
@@ -645,7 +645,7 @@
/**
* Returns the text size.
- *
+ *
* @return The number of characters to display in the text input.
*/
public int getTextSize() {
@@ -654,7 +654,7 @@
/**
* Sets the text size.
- *
+ *
* @param textSize The number of characters to display in the text input.
*/
public void setTextSize(int textSize) {
@@ -672,7 +672,7 @@
/**
* Returns the maximum length of the text input's text content.
- *
+ *
* @return The maximum length of the text input's text content.
*/
public int getMaximumLength() {
@@ -681,7 +681,7 @@
/**
* Sets the maximum length of the text input's text content.
- *
+ *
* @param maximumLength The maximum length of the text input's text content.
*/
public void setMaximumLength(int maximumLength) {
@@ -711,7 +711,7 @@
/**
* Returns the password flag.
- *
+ *
* @return <tt>true</tt> if this is a password text input; <tt>false</tt>,
* otherwise.
*/
@@ -722,7 +722,7 @@
/**
* Sets or clears the password flag. If the password flag is set, the text
* input will visually mask its contents.
- *
+ *
* @param password <tt>true</tt> if this is a password text input;
* <tt>false</tt>, otherwise.
*/
@@ -742,7 +742,7 @@
/**
* Sets the text input's prompt.
- *
+ *
* @param prompt The prompt text, or <tt>null</tt> for no prompt.
*/
public void setPrompt(String prompt) {
@@ -756,7 +756,7 @@
/**
* Returns the text input's text key.
- *
+ *
* @return The text key, or <tt>null</tt> if no text key is set.
*/
public String getTextKey() {
@@ -765,7 +765,7 @@
/**
* Sets the text input's text key.
- *
+ *
* @param textKey The text key, or <tt>null</tt> to clear the binding.
*/
public void setTextKey(String textKey) {
@@ -857,7 +857,7 @@
/**
* Sets the validator associated with this text input.
- *
+ *
* @param validator The validator to use, or <tt>null</tt> to use no
* validator.
*/
@@ -892,7 +892,7 @@
/**
* Sets the text input's strict validation flag. When enabled, only valid
* text will be accepted by the text input.
- *
+ *
* @param strictValidation
*/
public void setStrictValidation(boolean strictValidation) {
@@ -905,7 +905,7 @@
/**
* Reports whether this text input's text is currently valid as defined by
* its validator.
- *
+ *
* @return <tt>true</tt> if the text is valid or no validator is installed;
* <tt>false</tt>, otherwise.
*/
@@ -922,7 +922,7 @@
/**
* Sets the text area's editable flag.
- *
+ *
* @param editable
*/
public void setEditable(boolean editable) {
diff --git a/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java b/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java
index c9e219c..8f5e4d0 100644
--- a/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java
@@ -43,7 +43,7 @@
/**
* Called when a text input's text key has changed.
- *
+ *
* @param textInput
* @param previousTextKey
*/
@@ -51,7 +51,7 @@
/**
* Called when a text input's text bind type has changed.
- *
+ *
* @param textInput
* @param previousTextBindType
*/
@@ -59,7 +59,7 @@
/**
* Called when a text input's text bind mapping has changed.
- *
+ *
* @param textInput
* @param previousTextBindMapping
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java b/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java
index 6c915f8..6b35ad6 100644
--- a/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java
@@ -64,7 +64,7 @@
/**
* Called to preview a text insertion.
- *
+ *
* @param textInput The source of the event.
* @param text The text that will be inserted.
* @param index The index at which the text will be inserted.
@@ -73,7 +73,7 @@
/**
* Called when a text insertion has been vetoed.
- *
+ *
* @param textInput The source of the event.
* @param reason The reason the event was vetoed.
*/
@@ -81,7 +81,7 @@
/**
* Called when text has been inserted into a text input.
- *
+ *
* @param textInput The source of the event.
* @param index The index at which the text was inserted.
* @param count The number of characters that were inserted.
@@ -90,7 +90,7 @@
/**
* Called to preview a text removal.
- *
+ *
* @param textInput The source of the event.
* @param index The starting index from which the text will be removed.
*/
@@ -98,7 +98,7 @@
/**
* Called when a text removal has been vetoed.
- *
+ *
* @param textInput The source of the event.
* @param reason The reason the event was vetoed.
*/
@@ -106,7 +106,7 @@
/**
* Called when text has been removed from a text input.
- *
+ *
* @param textInput The source of the event.
* @param index The index from which the text was removed.
* @param count The number of characters that were removed.
@@ -115,7 +115,7 @@
/**
* Called when a text input's text has changed.
- *
+ *
* @param textInput The source of the event.
*/
public void textChanged(TextInput textInput);
diff --git a/wtk/src/org/apache/pivot/wtk/TextInputListener.java b/wtk/src/org/apache/pivot/wtk/TextInputListener.java
index 7cbf243..bf5059f 100644
--- a/wtk/src/org/apache/pivot/wtk/TextInputListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextInputListener.java
@@ -69,7 +69,7 @@
/**
* Called when a text input's text size has changed.
- *
+ *
* @param textInput
* @param previousTextSize
*/
@@ -77,7 +77,7 @@
/**
* Called when a text input's maximum length has changed.
- *
+ *
* @param textInput
* @param previousMaximumLength
*/
@@ -85,14 +85,14 @@
/**
* Called when a text input's password flag has changed.
- *
+ *
* @param textInput
*/
public void passwordChanged(TextInput textInput);
/**
* Called when a text input's prompt has changed.
- *
+ *
* @param textInput
* @param previousPrompt
*/
@@ -100,7 +100,7 @@
/**
* Called when the validator changes.
- *
+ *
* @param textInput
* @param previousValidator
*/
@@ -108,21 +108,21 @@
/**
* Called when a text input's strict validation flag has changed.
- *
+ *
* @param textInput
*/
public void strictValidationChanged(TextInput textInput);
/**
* Called when the text changes validity.
- *
+ *
* @param textInput
*/
public void textValidChanged(TextInput textInput);
/**
* Called when the editable state has changed.
- *
+ *
* @param textInput
*/
public void editableChanged(TextInput textInput);
diff --git a/wtk/src/org/apache/pivot/wtk/TextInputSelectionListener.java b/wtk/src/org/apache/pivot/wtk/TextInputSelectionListener.java
index 2c11a7f..27eba3e 100644
--- a/wtk/src/org/apache/pivot/wtk/TextInputSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextInputSelectionListener.java
@@ -22,7 +22,7 @@
public interface TextInputSelectionListener {
/**
* Called when a text input's selection state has changed.
- *
+ *
* @param textInput The source of the event.
* @param previousSelectionStart If the selection changed directly, the
* previous selection start index. Otherwise, the current selection start
diff --git a/wtk/src/org/apache/pivot/wtk/TextPane.java b/wtk/src/org/apache/pivot/wtk/TextPane.java
index 4e6f2ea..b7a0599 100644
--- a/wtk/src/org/apache/pivot/wtk/TextPane.java
+++ b/wtk/src/org/apache/pivot/wtk/TextPane.java
@@ -54,7 +54,7 @@
public interface Skin {
/**
* Returns the insertion point for a given location.
- *
+ *
* @param x
* @param y
* @return The insertion point for the given location.
@@ -64,7 +64,7 @@
/**
* Returns the next insertion point given an x coordinate and a
* character offset.
- *
+ *
* @param x
* @param from
* @param direction
@@ -75,7 +75,7 @@
/**
* Returns the row index of the character at a given offset within the
* document.
- *
+ *
* @param offset
* @return The row index of the character at the given offset.
*/
@@ -83,7 +83,7 @@
/**
* Returns the total number of rows in the document.
- *
+ *
* @return The number of rows in the document.
*/
public int getRowCount();
@@ -91,7 +91,7 @@
/**
* Returns the bounds of the character at a given offset within the
* document.
- *
+ *
* @param offset
* @return The bounds of the character at the given offset.
*/
@@ -316,7 +316,7 @@
* Sets the document that backs the text pane. Documents are not shareable
* across multiple TextPanes; because a Document may contain Components, and
* a Component may only be in one Container at a time.
- *
+ *
* @param document
*/
public void setDocument(Document document) {
@@ -509,7 +509,7 @@
/**
* Returns character count of the document.
- *
+ *
* @return The document's character count, or <tt>0</tt> if the document is
* <tt>null</tt>.
*/
@@ -700,7 +700,7 @@
/**
* Convenience method to get all the text from the current document into a
* single string.
- *
+ *
* @see #setText
*/
public String getText() {
@@ -729,7 +729,7 @@
/**
* Returns the starting index of the selection.
- *
+ *
* @return The starting index of the selection.
*/
public int getSelectionStart() {
@@ -738,7 +738,7 @@
/**
* Returns the length of the selection.
- *
+ *
* @return The length of the selection; may be <tt>0</tt>.
*/
public int getSelectionLength() {
@@ -747,7 +747,7 @@
/**
* Returns a span representing the current selection.
- *
+ *
* @return A span containing the current selection. Both start and end
* points are inclusive. Returns <tt>null</tt> if the selection is empty.
*/
@@ -759,7 +759,7 @@
/**
* Sets the selection. The sum of the selection start and length must be
* less than the length of the text input's content.
- *
+ *
* @param selectionStart The starting index of the selection.
* @param selectionLength The length of the selection.
*/
@@ -795,7 +795,7 @@
/**
* Sets the selection.
- *
+ *
* @param selection
* @see #setSelection(int, int)
*/
@@ -827,7 +827,7 @@
/**
* Returns the currently selected text.
- *
+ *
* @return A new string containing a copy of the text in the selected range,
* or <tt>null</tt> if nothing is selected.
*/
@@ -859,7 +859,7 @@
/**
* Sets the text pane's editable flag.
- *
+ *
* @param editable
*/
public void setEditable(boolean editable) {
diff --git a/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java b/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java
index 450026c..376f92c 100644
--- a/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java
@@ -37,7 +37,7 @@
/**
* Called when characters have been inserted into a text pane.
- *
+ *
* @param textPane
* @param index
* @param count
@@ -46,7 +46,7 @@
/**
* Called when characters have been removed from a text pane.
- *
+ *
* @param textPane
* @param index
* @param count
diff --git a/wtk/src/org/apache/pivot/wtk/TextPaneListener.java b/wtk/src/org/apache/pivot/wtk/TextPaneListener.java
index df9f597..692d8a6 100644
--- a/wtk/src/org/apache/pivot/wtk/TextPaneListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextPaneListener.java
@@ -39,7 +39,7 @@
/**
* Called when a text pane's document has changed.
- *
+ *
* @param textPane
* @param previousDocument
*/
@@ -47,7 +47,7 @@
/**
* Called when a text pane's editable state has changed.
- *
+ *
* @param textPane
*/
public void editableChanged(TextPane textPane);
diff --git a/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java b/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java
index 04532fe..8637d5c 100644
--- a/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java
@@ -22,7 +22,7 @@
public interface TextPaneSelectionListener {
/**
* Called when a text pane's selection state has changed.
- *
+ *
* @param textPane
* @param previousSelectionStart
* @param previousSelectionLength
diff --git a/wtk/src/org/apache/pivot/wtk/Theme.java b/wtk/src/org/apache/pivot/wtk/Theme.java
index 39a29fd..6dc18c8 100644
--- a/wtk/src/org/apache/pivot/wtk/Theme.java
+++ b/wtk/src/org/apache/pivot/wtk/Theme.java
@@ -110,7 +110,7 @@
/**
* Returns the skin class responsible for skinning the specified component
* class.
- *
+ *
* @param componentClass The component class.
* @return The skin class, or <tt>null</tt> if no skin mapping exists for the
* component class.
@@ -126,7 +126,7 @@
/**
* Sets the skin class responsible for skinning the specified component
* class.
- *
+ *
* @param componentClass The component class.
* @param skinClass The skin class.
*/
@@ -145,7 +145,7 @@
/**
* Gets the current theme, as determined by the {@linkplain #PROVIDER_NAME
* theme provider}.
- *
+ *
* @throws IllegalStateException If a theme has not been installed.
*/
public static Theme getTheme() {
@@ -158,7 +158,7 @@
/**
* Produce a font by describing it relative to the current theme's font
- *
+ *
* @param dictionary A dictionary with any of the following keys: <ul> <li>
* {@value #NAME_KEY} - the family name of the font</li> <li>
* {@value #SIZE_KEY} - the font size as an integer, or a string "x%" for a
diff --git a/wtk/src/org/apache/pivot/wtk/TreeView.java b/wtk/src/org/apache/pivot/wtk/TreeView.java
index b05e0db..b0a57ad 100644
--- a/wtk/src/org/apache/pivot/wtk/TreeView.java
+++ b/wtk/src/org/apache/pivot/wtk/TreeView.java
@@ -94,7 +94,7 @@
public interface NodeRenderer extends Renderer {
/**
* Prepares the renderer for layout or paint.
- *
+ *
* @param node The node value to render, or <tt>null</tt> if called to
* calculate preferred height for skins that assume a fixed renderer
* height.
@@ -120,7 +120,7 @@
/**
* Converts a tree node to a string representation.
- *
+ *
* @param node
* @return The node's string representation, or <tt>null</tt> if the node
* does not have a string representation. <p> Note that this method may
@@ -136,7 +136,7 @@
public interface NodeEditor {
/**
* Called to begin editing a tree node.
- *
+ *
* @param treeView
* @param path
*/
@@ -144,7 +144,7 @@
/**
* Terminates an edit operation.
- *
+ *
* @param result <tt>true</tt> to perform the edit; <tt>false</tt> to
* cancel it.
*/
@@ -163,7 +163,7 @@
/**
* Gets the path to the node found at the specified y-coordinate
* (relative to the tree view).
- *
+ *
* @param y The y-coordinate in pixels.
* @return The path to the node, or <tt>null</tt> if there is no node
* being painted at the specified y-coordinate.
@@ -174,7 +174,7 @@
* Gets the bounds of the node at the specified path relative to the
* tree view. Note that all nodes are left aligned with the tree; to get
* the pixel value of a node's indent, use {@link #getNodeIndent(int)}.
- *
+ *
* @param path The path to the node.
* @return The bounds, or <tt>null</tt> if the node is not currently
* visible.
@@ -185,7 +185,7 @@
* Gets the pixel indent of nodes at the specified depth. Depth is
* measured in generations away from the tree view's "root" node, which
* is represented by the {@link #getTreeData() tree data}.
- *
+ *
* @param depth The depth, where the first child of the root has depth
* 1, the child of that branch has depth 2, etc.
* @return The indent in pixels to the node's content.
@@ -196,7 +196,7 @@
* Gets the row index of the node, as seen in the current visible nodes
* list. Note that as branches are expanded and collapsed, the row index
* of any given node in the tree will change.
- *
+ *
* @param path The path to the node.
* @return The row index of the node, or <tt>-1</tt> if the node is not
* currently visible.
@@ -645,7 +645,7 @@
* [5, 0]]</tt>, <tt>basePath</tt> is <tt>[]</tt>, and <tt>index</tt> is
* <tt>4</tt>, then <tt>paths</tt> will be updated to <tt>[[3, 0], [6,
* 0]]</tt>. No events are fired.
- *
+ *
* @param paths Sequence of paths guaranteed to be sorted by
* "row order".
* @param basePath The path to the parent of the inserted item.
@@ -697,7 +697,7 @@
* <tt>basePath</tt> is <tt>[]</tt>, <tt>index</tt> is <tt>3</tt>, and
* <tt>count</tt> is <tt>2</tt>, then <tt>paths</tt> will be updated to
* <tt>[[4, 0]]</tt>. No events are fired.
- *
+ *
* @param paths Sequence of paths guaranteed to be sorted by
* "row order".
* @param basePath The path to the parent of the removed items.
@@ -756,7 +756,7 @@
* <tt>basePath</tt> is <tt>[3]</tt>, and <tt>index</tt> is <tt>0</tt>,
* then <tt>paths</tt> will be updated to <tt>[[3], [3, 1], [5,
* 0]]</tt>. No events are fired.
- *
+ *
* @param paths Sequence of paths guaranteed to be sorted by
* "row order".
* @param basePath The path to the parent of the updated item.
@@ -791,7 +791,7 @@
* <tt>[[3], [3, 0], [3, 1], [5, 0]]</tt> and <tt>basePath</tt> is
* <tt>[3]</tt>, then <tt>paths</tt> will be updated to <tt>[[3], [5,
* 0]]</tt>. No events are fired.
- *
+ *
* @param paths Sequence of paths guaranteed to be sorted by
* "row order".
* @param basePath The path whose children were sorted.
@@ -864,7 +864,7 @@
/**
* Creates a new <tt>TreeView</tt> with the specified tree data.
- *
+ *
* @param treeData Default data set to be used with the tree. This list
* represents the root set of items displayed by the tree and will never
* itself be painted. Sub-items that also implement the <tt>List</tt>
@@ -879,7 +879,7 @@
/**
* Sets the skin, replacing any previous skin. This ensures that the skin
* being set implements the {@link TreeView.Skin} interface.
- *
+ *
* @param skin The new skin.
*/
@Override
@@ -899,7 +899,7 @@
* other items are considered leaves. <p> For instance, a tree view that
* displays a single root branch would be backed by list with one child
* (also a list).
- *
+ *
* @return The tree view's data model.
*/
public List<?> getTreeData() {
@@ -916,7 +916,7 @@
* corresponding events will <b>not</b> be fired, since these actions are
* implied by the {@link TreeViewListener#treeDataChanged(TreeView,List)
* treeDataChanged} event.
- *
+ *
* @param treeData The data to be presented by the tree.
*/
public void setTreeData(List<?> treeData) {
@@ -965,7 +965,7 @@
* appearance of the node data. As such, note that there is an implied
* coordination between the node renderer and the data model. The default
* node renderer used is an instance of <tt>TreeViewNodeRenderer</tt>.
- *
+ *
* @return The current node renderer.
* @see TreeViewNodeRenderer
*/
@@ -976,7 +976,7 @@
/**
* Sets the tree view's node renderer, which is responsible for the
* appearance of the node data.
- *
+ *
* @param nodeRenderer The new node renderer.
*/
public void setNodeRenderer(NodeRenderer nodeRenderer) {
@@ -994,7 +994,7 @@
/**
* Returns the editor used to edit nodes in this tree.
- *
+ *
* @return The node editor, or <tt>null</tt> if no editor is installed.
*/
public NodeEditor getNodeEditor() {
@@ -1003,7 +1003,7 @@
/**
* Sets the editor used to edit nodes in this tree.
- *
+ *
* @param nodeEditor The node editor for the tree.
*/
public void setNodeEditor(NodeEditor nodeEditor) {
@@ -1017,7 +1017,7 @@
/**
* Returns the current selection mode.
- *
+ *
* @return The current selection mode.
*/
public SelectMode getSelectMode() {
@@ -1030,7 +1030,7 @@
* notified, as the clearing of the selection is implied by the
* {@link TreeViewListener#selectModeChanged(TreeView,TreeView.SelectMode)
* selectModeChanged} event.
- *
+ *
* @param selectMode The new selection mode.
* @see TreeViewListener
* @see TreeViewSelectionListener
@@ -1056,7 +1056,7 @@
/**
* Returns the currently selected paths.
- *
+ *
* @return An immutable list containing the currently selected paths. Note
* that the returned list is a wrapper around the actual selection, not a
* copy. Any changes made to the selection state will be reflected in the
@@ -1115,7 +1115,7 @@
/**
* Returns the first selected path, as it would appear in a fully expanded
* tree.
- *
+ *
* @return The first selected path, or <tt>null</tt> if nothing is selected.
*/
public Path getFirstSelectedPath() {
@@ -1125,7 +1125,7 @@
/**
* Returns the last selected path, as it would appear in a fully expanded
* tree.
- *
+ *
* @return The last selected path, or <tt>null</tt> if nothing is selected.
*/
public Path getLastSelectedPath() {
@@ -1135,7 +1135,7 @@
/**
* Returns the currently selected index, even when in multi-select mode.
- *
+ *
* @return The selected path, or <tt>null</tt> if nothing is selected.
*/
public Path getSelectedPath() {
@@ -1175,7 +1175,7 @@
/**
* Adds a path to the selection.
- *
+ *
* @param path
* @return <tt>true</tt> if the path was added to the selection;
* <tt>false</tt>, otherwise.
@@ -1212,7 +1212,7 @@
/**
* Removes a path from the selection.
- *
+ *
* @param path
* @return <tt>true</tt> if the path was added to the selection;
* <tt>false</tt>, otherwise.
@@ -1294,7 +1294,7 @@
/**
* Returns the disabled state of a given node.
- *
+ *
* @param path The path to the node whose disabled state is to be tested
* @return <tt>true</tt> if the node is disabled; <tt>false</tt>, otherwise
*/
@@ -1320,7 +1320,7 @@
* that disabled nodes may still be expanded, selected, and checked
* <i>programatically</i>. A disabled node may have enabled children. <p> If
* the disabled node filter is set to <tt>null</tt>, all nodes are enabled.
- *
+ *
* @return The disabled node filter, or <tt>null</tt> if no disabled node
* filter is set
*/
@@ -1334,7 +1334,7 @@
* that disabled nodes may still be expanded, selected, and checked
* <i>programatically</i>. A disabled node may have enabled children. <p> If
* the disabled node filter is set to <tt>null</tt>, all nodes are enabled.
- *
+ *
* @param disabledNodeFilter The disabled node filter, or <tt>null</tt> for
* no disabled node filter
*/
@@ -1360,7 +1360,7 @@
* existing checkmarks is implied by the
* {@link TreeViewListener#checkmarksEnabledChanged(TreeView)
* checkmarksEnabledChanged} event.
- *
+ *
* @param checkmarksEnabled <tt>true</tt> to enable checkmarks;
* <tt>false</tt> to disable them.
*/
@@ -1382,7 +1382,7 @@
* view. This state is a derived state meaning "the node is not checked, but
* one or more of its descendants are." When this state is configured to not
* be shown, such nodes will simply be reported as unchecked.
- *
+ *
* @return <tt>true</tt> if the tree view will report so-called mixed nodes
* as mixed; <tt>false</tt> if it will report them as unchecked.
* @see NodeCheckState#MIXED
@@ -1402,7 +1402,7 @@
* state is implied by the
* {@link TreeViewListener#showMixedCheckmarkStateChanged(TreeView)
* showMixedCheckmarkStateChanged} event.
- *
+ *
* @param showMixedCheckmarkState <tt>true</tt> to show the derived mixed
* state; <tt>false</tt> to report so-called "mixed" nodes as unchecked.
* @see NodeCheckState#MIXED
@@ -1421,7 +1421,7 @@
* Tells whether or not the node at the specified path is checked. If
* checkmarks are not enabled, this is guaranteed to be <tt>false</tt>. So
* called mixed nodes will always be reported as unchecked in this method.
- *
+ *
* @param path The path to the node.
* @return <tt>true</tt> if the node is explicitly checked; <tt>false</tt>
* otherwise.
@@ -1442,7 +1442,7 @@
* checked, but one or more of its descendants are") is only reported when
* the tree view is configured as such. Otherwise, such nodes will be
* reported as <tt>UNCHECKED</tt>.
- *
+ *
* @param path The path to the node.
* @return The checkmark state of the specified node.
* @see #getCheckmarksEnabled()
@@ -1483,7 +1483,7 @@
* is impossible to set the check state of a node to <tt>MIXED</tt>. This is
* because the mixed check state is a derived state meaning "the node is not
* checked, but one or more of its descendants are."
- *
+ *
* @param path The path to the node.
* @param checked <tt>true</tt> to check the node; <tt>false</tt> to uncheck
* it.
@@ -1565,7 +1565,7 @@
* return an empty sequence. <p> Note that if the tree view is configured to
* show mixed checkmark states (see {@link #getShowMixedCheckmarkState()}),
* this will still only return the nodes that are fully checked.
- *
+ *
* @return The paths to the checked nodes in the tree, guaranteed to be
* non-<tt>null</tt>.
*/
@@ -1581,7 +1581,7 @@
* all checkboxes will be interactive. <p> <b>Note:</b> this filter is only
* relavent if {@link #setCheckmarksEnabled(boolean) checkmarksEnabled} is
* set to true.
- *
+ *
* @return The disabled checkmark filter, or <tt>null</tt> if no disabled
* checkmark filter is set
*/
@@ -1597,7 +1597,7 @@
* checkboxes will be interactive. <p> <b>Note:</b> this filter is only
* relavent if {@link #setCheckmarksEnabled(boolean) checkmarksEnabled} is
* set to true. enabled.
- *
+ *
* @param disabledCheckmarkFilter The disabled checkmark filter, or
* <tt>null</tt> for no disabled checkmark filter
*/
@@ -1613,7 +1613,7 @@
/**
* Sets the expansion state of the specified branch. If the branch already
* has the specified expansion state, nothing happens.
- *
+ *
* @param path The path to the branch node.
* @param expanded <tt>true</tt> to expand the branch; <tt>false</tt> to
* collapse it.
@@ -1649,7 +1649,7 @@
/**
* Tells whether or not the specified branch is expanded.
- *
+ *
* @param path The path to the branch node.
* @return <tt>true</tt> if the branch is expanded; <tt>false</tt> otherwise.
*/
@@ -1664,7 +1664,7 @@
/**
* Expands the branch at the specified path. If the branch is already
* expanded, nothing happens.
- *
+ *
* @param path The path to the branch node.
*/
public final void expandBranch(Path path) {
@@ -1694,7 +1694,7 @@
/**
* Collapses the branch at the specified path. If the branch is already
* collapsed, nothing happens.
- *
+ *
* @param path The path to the branch node.
*/
public final void collapseBranch(Path path) {
@@ -1724,7 +1724,7 @@
/**
* Ensures that this tree view is listening for list events on every branch
* node along the specified path.
- *
+ *
* @param path A path leading to a nested branch node.
* @throws IndexOutOfBoundsException If a path element is out of bounds.
* @throws IllegalArgumentException If the path contains any leaf nodes.
@@ -1759,7 +1759,7 @@
/**
* Gets the path to the node found at the specified y-coordinate (relative
* to the tree view).
- *
+ *
* @param y The y-coordinate in pixels.
* @return The path to the node, or <tt>null</tt> if there is no node being
* painted at the specified y-coordinate.
@@ -1773,7 +1773,7 @@
* Gets the bounds of the node at the specified path relative to the tree
* view. Note that all nodes are left aligned with the tree; to get the
* pixel value of a node's indent, use {@link #getNodeIndent(int)}.
- *
+ *
* @param path The path to the node.
* @return The bounds, or <tt>null</tt> if the node is not currently visible.
*/
@@ -1794,7 +1794,7 @@
* Gets the pixel indent of nodes at the specified depth. Depth is measured
* in generations away from the tree view's "root" node, which is
* represented by the {@link #getTreeData() tree data}.
- *
+ *
* @param depth The depth, where the first child of the root has depth 1,
* the child of that branch has depth 2, etc.
* @return The indent in pixels.
@@ -1808,7 +1808,7 @@
* Gets the row index of the node, as seen in the current visible nodes
* list. Note that as branches are expanded and collapsed, the row index of
* any given node in the tree will change.
- *
+ *
* @param path The path to the node.
* @return The row index of the node, or <tt>-1</tt> if the node is not
* currently visible.
@@ -1822,7 +1822,7 @@
* Gets the <tt>TreeViewListener</tt>s. Developers interested in these
* events can register for notification on these events by adding themselves
* to the listener list.
- *
+ *
* @return The tree view listeners.
*/
public ListenerList<TreeViewListener> getTreeViewListeners() {
@@ -1833,7 +1833,7 @@
* Gets the <tt>TreeViewBranchListener</tt>s. Developers interested in these
* events can register for notification on these events by adding themselves
* to the listener list.
- *
+ *
* @return The tree view branch listeners.
*/
public ListenerList<TreeViewBranchListener> getTreeViewBranchListeners() {
@@ -1844,7 +1844,7 @@
* Gets the <tt>TreeViewNodeListener</tt>s. Developers interested in these
* events can register for notification on these events by adding themselves
* to the listener list.
- *
+ *
* @return The tree view node listeners.
*/
public ListenerList<TreeViewNodeListener> getTreeViewNodeListeners() {
@@ -1855,7 +1855,7 @@
* Gets the <tt>TreeViewNodeStateListener</tt>s. Developers interested in
* these events can register for notification on these events by adding
* themselves to the listener list.
- *
+ *
* @return The tree view node state listeners.
*/
public ListenerList<TreeViewNodeStateListener> getTreeViewNodeStateListeners() {
@@ -1866,7 +1866,7 @@
* Gets the <tt>TreeViewSelectionListener</tt>s. Developers interested in
* these events can register for notification on these events by adding
* themselves to the listener list.
- *
+ *
* @return The tree view selection listeners.
*/
public ListenerList<TreeViewSelectionListener> getTreeViewSelectionListeners() {
diff --git a/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java b/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java
index 28c436b..62f22fb 100644
--- a/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java
@@ -40,7 +40,7 @@
/**
* Called when a tree node is expanded. This event can be used to perform
* lazy loading of tree node data.
- *
+ *
* @param treeView The source of the event.
* @param path The path of the node that was shown.
*/
@@ -48,7 +48,7 @@
/**
* Called when a tree node is collapsed.
- *
+ *
* @param treeView The source of the event.
* @param path The path of the node that was collapsed.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TreeViewListener.java b/wtk/src/org/apache/pivot/wtk/TreeViewListener.java
index ba5b24d..f6648d7 100644
--- a/wtk/src/org/apache/pivot/wtk/TreeViewListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TreeViewListener.java
@@ -73,7 +73,7 @@
/**
* Called when a tree view's data has changed.
- *
+ *
* @param treeView
* @param previousTreeData
*/
@@ -81,7 +81,7 @@
/**
* Called when a tree view's node renderer has changed.
- *
+ *
* @param treeView
* @param previousNodeRenderer
*/
@@ -89,7 +89,7 @@
/**
* Called when a tree view's node editor has changed.
- *
+ *
* @param treeView
* @param previousNodeEditor
*/
@@ -97,7 +97,7 @@
/**
* Called when a tree view's select mode has changed.
- *
+ *
* @param treeView
* @param previousSelectMode
*/
@@ -105,21 +105,21 @@
/**
* Called when a tree view's checkmarks enabled flag has changed.
- *
+ *
* @param treeView
*/
public void checkmarksEnabledChanged(TreeView treeView);
/**
* Called when a tree view's "show mixed checkmark state" flag has changed.
- *
+ *
* @param treeView
*/
public void showMixedCheckmarkStateChanged(TreeView treeView);
/**
* Called when a tree view's disabled node filter has changed.
- *
+ *
* @param treeView
* @param previousDisabledNodeFilter
*/
@@ -127,7 +127,7 @@
/**
* Called when a tree view's disabled checkmark filter has changed.
- *
+ *
* @param treeView
* @param previousDisabledCheckmarkFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java b/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java
index a1bace3..17bc865 100644
--- a/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java
@@ -54,7 +54,7 @@
/**
* Called when a node has been inserted into the tree view.
- *
+ *
* @param treeView
* @param path
* @param index
@@ -63,7 +63,7 @@
/**
* Called when nodes have been removed from the tree view.
- *
+ *
* @param treeView
* @param path
* @param index
@@ -74,7 +74,7 @@
/**
* Called when a node in the tree view has been updated.
- *
+ *
* @param treeView
* @param path
* @param index
@@ -83,14 +83,14 @@
/**
* Called when the nodes in a branch have been cleared.
- *
+ *
* @param treeView
*/
public void nodesCleared(TreeView treeView, Path path);
/**
* Called when the nodes in a branch have been sorted.
- *
+ *
* @param treeView
* @param path
*/
diff --git a/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java b/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java
index 4d4fbda..a5d4456 100644
--- a/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java
@@ -24,7 +24,7 @@
public interface TreeViewNodeStateListener {
/**
* Called when a node's checked state has changed.
- *
+ *
* @param treeView
* @param path
* @param previousCheckState
diff --git a/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java b/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java
index e17c55d..602d087 100644
--- a/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java
@@ -50,7 +50,7 @@
/**
* Called when a selected path has been added to a tree view.
- *
+ *
* @param treeView
* @param path
*/
@@ -58,7 +58,7 @@
/**
* Called when a selected path has been removed from a tree view.
- *
+ *
* @param treeView
* @param path
*/
@@ -66,7 +66,7 @@
/**
* Called when a tree view's selection state has been reset.
- *
+ *
* @param treeView
* @param previousSelectedPaths
*/
@@ -74,7 +74,7 @@
/**
* Called when a tree view's selected node has changed.
- *
+ *
* @param treeView
* @param previousSelectedNode
*/
diff --git a/wtk/src/org/apache/pivot/wtk/VFSBrowser.java b/wtk/src/org/apache/pivot/wtk/VFSBrowser.java
index 98e8eec..cafdefc 100644
--- a/wtk/src/org/apache/pivot/wtk/VFSBrowser.java
+++ b/wtk/src/org/apache/pivot/wtk/VFSBrowser.java
@@ -122,7 +122,7 @@
* Creates a new VFSBrowser <p> Note that this version of the constructor
* must be used when a custom root folder (that may include a completely
* different URI scheme) has to be set.
- *
+ *
* @param manager The virtual file system we're going to manage.
* @param rootFolder The root folder full name.
*/
@@ -150,7 +150,7 @@
/**
* Creates a new VFSBrowser <p> Note that this version of the constructor
* must be used when a custom root folder has to be set.
- *
+ *
* @param manager The virtual file system we're going to manage.
* @param rootFolder The root folder full name.
*/
@@ -177,7 +177,7 @@
/**
* Returns the current file system manager.
- *
+ *
* @return The current file system manager.
*/
public FileSystemManager getManager() {
@@ -186,7 +186,7 @@
/**
* Returns the current root directory.
- *
+ *
* @return The current root directory.
*/
public FileObject getRootDirectory() {
@@ -196,7 +196,7 @@
/**
* Sets the root directory from a string. Clears any existing file
* selection.
- *
+ *
* @param rootDirectory
*/
public void setRootDirectory(String rootDirectory) throws FileSystemException {
@@ -205,7 +205,7 @@
/**
* Sets the root directory. Clears any existing file selection.
- *
+ *
* @param rootDirectory
*/
public void setRootDirectory(FileObject rootDirectory) throws FileSystemException {
@@ -228,7 +228,7 @@
/**
* Adds a file to the file selection.
- *
+ *
* @param file
* @return <tt>true</tt> if the file was added; <tt>false</tt> if it was
* already selected.
@@ -258,7 +258,7 @@
/**
* Removes a file from the file selection.
- *
+ *
* @param file
* @return <tt>true</tt> if the file was removed; <tt>false</tt> if it was
* not already selected.
@@ -278,7 +278,7 @@
/**
* When in single-select mode, returns the currently selected file.
- *
+ *
* @return The currently selected file.
*/
public FileObject getSelectedFile() {
@@ -291,7 +291,7 @@
/**
* Sets the selection to a single file.
- *
+ *
* @param file
*/
public void setSelectedFile(FileObject file) throws FileSystemException {
@@ -310,7 +310,7 @@
/**
* Returns the currently selected files.
- *
+ *
* @return An immutable list containing the currently selected files. Note
* that the returned list is a wrapper around the actual selection, not a
* copy. Any changes made to the selection state will be reflected in the
@@ -322,7 +322,7 @@
/**
* Sets the selected files.
- *
+ *
* @param selectedFiles The files to select.
* @return The files that were selected, with duplicates eliminated.
*/
@@ -389,7 +389,7 @@
/**
* Sets the file browser's multi-select state.
- *
+ *
* @param multiSelect <tt>true</tt> if multi-select is enabled;
* <tt>false</tt>, otherwise.
*/
@@ -406,7 +406,7 @@
/**
* Returns the current file filter.
- *
+ *
* @return The current file filter, or <tt>null</tt> if no filter is set.
*/
public Filter<FileObject> getDisabledFileFilter() {
@@ -415,7 +415,7 @@
/**
* Sets the file filter.
- *
+ *
* @param disabledFileFilter The file filter to use, or <tt>null</tt> for no
* filter.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java b/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java
index c394798..7701a42 100644
--- a/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java
+++ b/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java
@@ -70,7 +70,7 @@
/**
* Called when a file browser's FileSystemManager has changed, (such as when
* a nested VirtualFileSystem is opened).
- *
+ *
* @param fileBrowser
* @param previousManager
*/
@@ -78,7 +78,7 @@
/**
* Called when a file browser's root directory has changed.
- *
+ *
* @param fileBrowser
* @param previousRootDirectory
*/
@@ -86,7 +86,7 @@
/**
* Called when a file has been added to a file browser's selection.
- *
+ *
* @param fileBrowser
* @param file
*/
@@ -94,7 +94,7 @@
/**
* Called when a file has been removed from a file browser's selection.
- *
+ *
* @param fileBrowser
* @param file
*/
@@ -102,7 +102,7 @@
/**
* Called when a file browser's selection state has been reset.
- *
+ *
* @param fileBrowser
* @param previousSelectedFiles
*/
@@ -111,14 +111,14 @@
/**
* Called when a file browser's multi-select flag has changed.
- *
+ *
* @param fileBrowser
*/
public void multiSelectChanged(VFSBrowser fileBrowser);
/**
* Called when a file browser's file filter has changed.
- *
+ *
* @param fileBrowser
* @param previousDisabledFileFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java b/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java
index 4791642..63dadfb 100644
--- a/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java
+++ b/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java
@@ -106,7 +106,7 @@
/**
* Creates a new VFSBrowserSheet <p> Note that this version set by default
* the user home as root folder.
- *
+ *
* @param mode The mode for opening the sheet.
* @see Mode
*/
@@ -117,7 +117,7 @@
/**
* Creates a new VFSBrowserSheet <p> Note that this version of the
* constructor must be used when a custom root folder has to be set.
- *
+ *
* @param mode The mode for opening the sheet.
* @see Mode
* @param rootFolder The root folder full name.
@@ -129,7 +129,7 @@
/**
* Creates a new VFSBrowserSheet <p> Note that this version of the
* constructor must be used when a custom root folder has to be set.
- *
+ *
* @param manager The VFS FileSystemManager that we will be browsing. If
* <tt>null</tt> the default (local) will be used.
* @param mode The mode for opening the sheet.
@@ -253,7 +253,7 @@
/**
* When in single-select mode, returns the currently selected file.
- *
+ *
* @return The currently selected file.
*/
public FileObject getSelectedFile() {
@@ -266,7 +266,7 @@
/**
* Sets the selection to a single file.
- *
+ *
* @param file
*/
public void setSelectedFile(FileObject file) throws FileSystemException {
@@ -285,7 +285,7 @@
/**
* Returns the currently selected files.
- *
+ *
* @return An immutable list containing the currently selected files. Note
* that the returned list is a wrapper around the actual selection, not a
* copy. Any changes made to the selection state will be reflected in the
@@ -297,7 +297,7 @@
/**
* Sets the selected files.
- *
+ *
* @param selectedFiles The files to select.
* @return The files that were selected, with duplicates eliminated.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java b/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java
index d95d2b2..9f3d2b6 100644
--- a/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java
+++ b/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java
@@ -62,7 +62,7 @@
/**
* Called when a file browser's file system manager has changed (as when
* browsing into a new virtual file system).
- *
+ *
* @param fileBrowserSheet
* @param previousManager
*/
@@ -70,7 +70,7 @@
/**
* Called when a file browser sheet's mode has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousMode
*/
@@ -78,7 +78,7 @@
/**
* Called when a file browser sheet's root directory has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousRootDirectory
*/
@@ -87,7 +87,7 @@
/**
* Called when a file browser sheet's selection state has been reset.
- *
+ *
* @param fileBrowserSheet
* @param previousSelectedFiles
*/
@@ -96,7 +96,7 @@
/**
* Called when a file browser sheet's disabled file filter has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousDisabledFileFilter
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Viewport.java b/wtk/src/org/apache/pivot/wtk/Viewport.java
index 7ac59b9..44fa38d 100644
--- a/wtk/src/org/apache/pivot/wtk/Viewport.java
+++ b/wtk/src/org/apache/pivot/wtk/Viewport.java
@@ -151,7 +151,7 @@
* viewport will propagate repaints to its parent or consume them. This flag
* enables skins to optimize viewport scrolling by blitting the display to
* reduce the required repaint area.
- *
+ *
* @return <tt>true</tt> if this viewport will consume repaints that bubble
* up through it; <tt>false</tt> if it will propagate them up like normal.
*/
@@ -164,7 +164,7 @@
* viewport will propagate repaints to its parent or consume them. This flag
* enables skins to optimize viewport scrolling by blitting the display to
* reduce the required repaint area.
- *
+ *
* @param consumeRepaint <tt>true</tt> to consume repaints that bubble up
* through this viewport; <tt>false</tt> to propagate them up like normal.
*/
@@ -218,7 +218,7 @@
* problems with the scrolled-in area not being painted properly by default,
* consider setting this property <tt>true</tt> using the
* {@link #setRepaintAllViewport setRepaintAllViewport} method.
- *
+ *
* @return <tt>false</tt> if optimized, otherwise <tt>true</tt> (repaint
* entire viewport)
*/
@@ -231,7 +231,7 @@
* for various painting issues on some platforms. So, if you experience
* problems with the scrolled-in area not being painted properly by default,
* consider setting this property <tt>true</tt> (default is <tt>false</tt>).
- *
+ *
* @param repaintAllViewport <tt>false</tt> means optimized (repaint only
* needed area, default), while <tt>true</tt> means repaint all
*/
diff --git a/wtk/src/org/apache/pivot/wtk/ViewportListener.java b/wtk/src/org/apache/pivot/wtk/ViewportListener.java
index aa4ddc4..d7b21bd 100644
--- a/wtk/src/org/apache/pivot/wtk/ViewportListener.java
+++ b/wtk/src/org/apache/pivot/wtk/ViewportListener.java
@@ -42,7 +42,7 @@
/**
* Called when a viewport's scroll top has changed.
- *
+ *
* @param scrollPane
* @param previousScrollTop
*/
@@ -50,7 +50,7 @@
/**
* Called when a viewport's scroll left has changed.
- *
+ *
* @param scrollPane
* @param previousScrollLeft
*/
@@ -58,7 +58,7 @@
/**
* Called when a viewport's view component has changed.
- *
+ *
* @param scrollPane
* @param previousView
*/
diff --git a/wtk/src/org/apache/pivot/wtk/Visual.java b/wtk/src/org/apache/pivot/wtk/Visual.java
index 74923b8..e63a2f1 100644
--- a/wtk/src/org/apache/pivot/wtk/Visual.java
+++ b/wtk/src/org/apache/pivot/wtk/Visual.java
@@ -35,7 +35,7 @@
/**
* Returns the visual's baseline.
- *
+ *
* @return The baseline relative to the origin of the visual, or <tt>-1</tt>
* if this visual does not have a baseline.
*/
@@ -43,7 +43,7 @@
/**
* Paints the visual.
- *
+ *
* @param graphics The graphics context in which to paint the visual.
*/
public void paint(Graphics2D graphics);
diff --git a/wtk/src/org/apache/pivot/wtk/Window.java b/wtk/src/org/apache/pivot/wtk/Window.java
index 4122e36..92bb9b8 100644
--- a/wtk/src/org/apache/pivot/wtk/Window.java
+++ b/wtk/src/org/apache/pivot/wtk/Window.java
@@ -544,7 +544,7 @@
/**
* Tests whether this window is an owning ancestor of a given window. A
* window is not considered an owner of itself.
- *
+ *
* @param window
* @return <tt>true</tt> if this window is an owning ancestor of the given
* window; <tt>false</tt>, otherwise.
@@ -565,7 +565,7 @@
/**
* Returns this window's open state.
- *
+ *
* @return <tt>true</tt> if the window is open; <tt>false</tt>, otherwise.
*/
public boolean isOpen() {
@@ -574,7 +574,7 @@
/**
* Returns this window's opening state.
- *
+ *
* @return <tt>true</tt> if the window is opening; <tt>false</tt>,
* otherwise.
*/
@@ -584,7 +584,7 @@
/**
* Opens the window.
- *
+ *
* @param display
*/
public final void open(Display display) {
@@ -593,7 +593,7 @@
/**
* Opens the window.
- *
+ *
* @param ownerArgument The window's owner. The window is opened on the
* owner's display.
*/
@@ -608,7 +608,7 @@
/**
* Opens the window. <p> Note that this method is not a synchronous call, it
* schedules an event to open the window.
- *
+ *
* @param display The display on which the window will be opened.
* @param ownerArgument The window's owner, or <tt>null</tt> if the window
* has no owner.
@@ -671,7 +671,7 @@
/**
* Returns this window's closed state.
- *
+ *
* @return <tt>true</tt> if the window is closed; <tt>false</tt>, otherwise.
*/
public boolean isClosed() {
@@ -680,7 +680,7 @@
/**
* Returns this window's closing state.
- *
+ *
* @return <tt>true</tt> if the window is closing; <tt>false</tt>,
* otherwise.
*/
@@ -747,7 +747,7 @@
/**
* Returns the window's title.
- *
+ *
* @return The pane's title, or <tt>null</tt> if no title is set.
*/
public String getTitle() {
@@ -756,7 +756,7 @@
/**
* Sets the window's title.
- *
+ *
* @param title The new title, or <tt>null</tt> for no title.
*/
public void setTitle(String title) {
@@ -779,7 +779,7 @@
* Sets the window's icon by URL. <p> If the icon already exists in the
* application context resource cache, the cached value will be used.
* Otherwise, the icon will be loaded synchronously and added to the cache.
- *
+ *
* @param iconURL The location of the icon to set.
*/
public void setIcon(URL iconURL) {
@@ -796,7 +796,7 @@
/**
* Sets the window's icon by {@linkplain ClassLoader#getResource(String)
* resource name}.
- *
+ *
* @param iconName The resource name of the icon to set.
* @see #setIcon(URL)
*/
@@ -849,7 +849,7 @@
/**
* Returns the window's active state.
- *
+ *
* @return <tt>true</tt> if the window is active; <tt>false</tt>; otherwise.
*/
public boolean isActive() {
@@ -858,7 +858,7 @@
/**
* Requests that this window become the active window.
- *
+ *
* @return <tt>true</tt> if the window became active; <tt>false</tt>,
* otherwise.
*/
@@ -872,7 +872,7 @@
/**
* Called to notify a window that its active state has changed.
- *
+ *
* @param active
* @param obverseWindow
*/
@@ -882,7 +882,7 @@
/**
* Returns the currently active window.
- *
+ *
* @return The window that is currently active, or <tt>null</tt> if no
* window is active.
*/
@@ -893,7 +893,7 @@
/**
* Sets the active window. The window must be activatable, open, and
* enabled. If the window is not currently visible, it will be made visible.
- *
+ *
* @param activeWindow The window to activate, or <tt>null</tt> to clear the
* active window.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java b/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java
index 0387fe7..78f452c 100644
--- a/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java
+++ b/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java
@@ -24,14 +24,14 @@
public interface WindowActionMappingListener {
/**
* Called when an action mapping has been added to a window.
- *
+ *
* @param window
*/
public void actionMappingAdded(Window window);
/**
* Called when action mappings have been removed from a window.
- *
+ *
* @param window
* @param index
* @param removed
@@ -41,7 +41,7 @@
/**
* Called when an action mapping's keystroke has changed.
- *
+ *
* @param actionMapping
* @param previousKeyStroke
*/
@@ -50,7 +50,7 @@
/**
* Called when an action mapping's action has changed.
- *
+ *
* @param actionMapping
* @param previousAction
*/
diff --git a/wtk/src/org/apache/pivot/wtk/WindowClassListener.java b/wtk/src/org/apache/pivot/wtk/WindowClassListener.java
index 4d8cb3f..dff02cc 100644
--- a/wtk/src/org/apache/pivot/wtk/WindowClassListener.java
+++ b/wtk/src/org/apache/pivot/wtk/WindowClassListener.java
@@ -22,7 +22,7 @@
public interface WindowClassListener {
/**
* Called when the active window has changed.
- *
+ *
* @param previousActiveWindow
*/
public void activeWindowChanged(Window previousActiveWindow);
diff --git a/wtk/src/org/apache/pivot/wtk/WindowListener.java b/wtk/src/org/apache/pivot/wtk/WindowListener.java
index 29b1f4e..8a09e52 100644
--- a/wtk/src/org/apache/pivot/wtk/WindowListener.java
+++ b/wtk/src/org/apache/pivot/wtk/WindowListener.java
@@ -65,7 +65,7 @@
/**
* Called when a window's title has changed.
- *
+ *
* @param window
* @param previousTitle
*/
@@ -73,7 +73,7 @@
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param addedIcon
*/
@@ -81,7 +81,7 @@
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param addedIcon
*/
@@ -89,7 +89,7 @@
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param index
* @param removed
@@ -98,7 +98,7 @@
/**
* Called when a window's content component has changed.
- *
+ *
* @param window
* @param previousContent
*/
@@ -106,7 +106,7 @@
/**
* Called when a window's active state has changed.
- *
+ *
* @param window
* @param obverseWindow
*/
@@ -114,7 +114,7 @@
/**
* Called when a window's maximized state has changed.
- *
+ *
* @param window
*/
public void maximizedChanged(Window window);
diff --git a/wtk/src/org/apache/pivot/wtk/WindowStateListener.java b/wtk/src/org/apache/pivot/wtk/WindowStateListener.java
index 37061ae..a4c6b9a 100644
--- a/wtk/src/org/apache/pivot/wtk/WindowStateListener.java
+++ b/wtk/src/org/apache/pivot/wtk/WindowStateListener.java
@@ -59,28 +59,28 @@
/**
* Called when a window has opened.
- *
+ *
* @param window
*/
public void windowOpened(Window window);
/**
* Called to preview a window close event.
- *
+ *
* @param window
*/
public Vote previewWindowClose(Window window);
/**
* Called to preview a window open event.
- *
+ *
* @param window
*/
public Vote previewWindowOpen(Window window);
/**
* Called when a window close event has been vetoed.
- *
+ *
* @param window
* @param reason
*/
@@ -88,7 +88,7 @@
/**
* Called when a window open event has been vetoed.
- *
+ *
* @param window
* @param reason
*/
@@ -96,7 +96,7 @@
/**
* Called when a window has closed.
- *
+ *
* @param window
* @param display
* @param owner
diff --git a/wtk/src/org/apache/pivot/wtk/content/ButtonData.java b/wtk/src/org/apache/pivot/wtk/content/ButtonData.java
index f99de03..c62ac59 100644
--- a/wtk/src/org/apache/pivot/wtk/content/ButtonData.java
+++ b/wtk/src/org/apache/pivot/wtk/content/ButtonData.java
@@ -57,7 +57,7 @@
* Sets the button data's icon by URL. <p> If the icon already exists in the
* application context resource cache, the cached value will be used.
* Otherwise, the icon will be loaded synchronously and added to the cache.
- *
+ *
* @param iconURL The location of the icon to set.
*/
public void setIcon(URL iconURL) {
@@ -71,7 +71,7 @@
/**
* Sets the button data's icon by
* {@linkplain ClassLoader#getResource(String) resource name}.
- *
+ *
* @param iconName The resource name of the icon to set.
* @see #setIcon(URL)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java b/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java
index f5cf39b..063e2f9 100644
--- a/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java
+++ b/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java
@@ -84,7 +84,7 @@
/**
* Creates a new <tt>CalendarDateSpinnerData</tt> bounded by the specified
* calendar dates (inclusive).
- *
+ *
* @param lowerBound The earliest date to include in this spinner data.
* @param upperBound The latest date to include in this spinner data.
*/
@@ -158,7 +158,7 @@
/**
* Gets the calendar date at the specified index.
- *
+ *
* @param index The index of the calendar date to retrieve.
*/
@Override
@@ -208,7 +208,7 @@
/**
* Gets the number of entries in this list.
- *
+ *
* @return The number of calendar dates in this list.
*/
@Override
diff --git a/wtk/src/org/apache/pivot/wtk/content/ListItem.java b/wtk/src/org/apache/pivot/wtk/content/ListItem.java
index 17efe45..8be0b04 100644
--- a/wtk/src/org/apache/pivot/wtk/content/ListItem.java
+++ b/wtk/src/org/apache/pivot/wtk/content/ListItem.java
@@ -57,7 +57,7 @@
* Sets the list item's icon by URL. <p> If the icon already exists in the
* application context resource cache, the cached value will be used.
* Otherwise, the icon will be loaded synchronously and added to the cache.
- *
+ *
* @param iconURL The location of the icon to set.
*/
public void setIcon(URL iconURL) {
@@ -71,7 +71,7 @@
/**
* Sets the list item's icon by {@linkplain ClassLoader#getResource(String)
* resource name}.
- *
+ *
* @param iconName The resource name of the icon to set.
* @see #setIcon(URL)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/content/ListViewItemRenderer.java b/wtk/src/org/apache/pivot/wtk/content/ListViewItemRenderer.java
index 2020f37..04e56fb 100644
--- a/wtk/src/org/apache/pivot/wtk/content/ListViewItemRenderer.java
+++ b/wtk/src/org/apache/pivot/wtk/content/ListViewItemRenderer.java
@@ -156,7 +156,7 @@
/**
* Gets the bounds of the text that is rendered by this renderer.
- *
+ *
* @return The bounds of the rendered text, or <tt>null</tt> if this
* renderer did not render any text.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/content/MenuItemData.java b/wtk/src/org/apache/pivot/wtk/content/MenuItemData.java
index 04b83af..104be18 100644
--- a/wtk/src/org/apache/pivot/wtk/content/MenuItemData.java
+++ b/wtk/src/org/apache/pivot/wtk/content/MenuItemData.java
@@ -34,7 +34,7 @@
/**
* Constructor.
- *
+ *
* @param icon The icon to display in the menu item.
*/
public MenuItemData(Image icon) {
@@ -43,7 +43,7 @@
/**
* Constructor.
- *
+ *
* @param text The text to display in the menu item.
*/
public MenuItemData(String text) {
@@ -52,7 +52,7 @@
/**
* Constructor.
- *
+ *
* @param icon The icon to display in the menu item.
* @param text The text to display in the menu item.
*/
@@ -62,7 +62,7 @@
/**
* Constructor.
- *
+ *
* @param icon The icon to display in the menu item.
* @param text The text to display in the menu item.
* @param keyboardShortcut The keyboard shortcut associated with this menu
diff --git a/wtk/src/org/apache/pivot/wtk/content/TableViewHeaderData.java b/wtk/src/org/apache/pivot/wtk/content/TableViewHeaderData.java
index 9a1444f..7547674 100644
--- a/wtk/src/org/apache/pivot/wtk/content/TableViewHeaderData.java
+++ b/wtk/src/org/apache/pivot/wtk/content/TableViewHeaderData.java
@@ -56,7 +56,7 @@
* Sets the header data's icon by URL. <p> If the icon already exists in the
* application context resource cache, the cached value will be used.
* Otherwise, the icon will be loaded synchronously and added to the cache.
- *
+ *
* @param iconURL The location of the icon to set.
*/
public void setIcon(URL iconURL) {
@@ -70,7 +70,7 @@
/**
* Sets the header data's icon by
* {@linkplain ClassLoader#getResource(String) resource name}.
- *
+ *
* @param iconName The resource name of the icon to set.
* @see #setIcon(URL)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/content/TableViewRowEditor.java b/wtk/src/org/apache/pivot/wtk/content/TableViewRowEditor.java
index 9b9cbc9..032cc65 100644
--- a/wtk/src/org/apache/pivot/wtk/content/TableViewRowEditor.java
+++ b/wtk/src/org/apache/pivot/wtk/content/TableViewRowEditor.java
@@ -161,7 +161,7 @@
* so it is the caller's responsibility to set up the data binding keys in
* each component they specify in this dictionary. The data binding key
* should equal the column name that the cell editor serves.
- *
+ *
* @return The cell editor dictionary.
*/
public Dictionary<String, Component> getCellEditors() {
@@ -293,7 +293,7 @@
/**
* Returns the effect that is applied when the editor opens or closes.
- *
+ *
* @return The edit effect, or <tt>null</tt> for no effect.
*/
public CardPaneSkin.SelectionChangeEffect getEditEffect() {
@@ -303,7 +303,7 @@
/**
* Sets the effect that is applied when the editor opens or closes.
- *
+ *
* @param editEffect The edit effect, or <tt>null</tt> for no effect.
*/
public void setEditEffect(CardPaneSkin.SelectionChangeEffect editEffect) {
@@ -312,7 +312,7 @@
/**
* Returns the edit effect duration.
- *
+ *
* @return The effect duration in milliseconds.
*/
public int getEditEffectDuration() {
@@ -321,7 +321,7 @@
/**
* Sets the edit effect duration.
- *
+ *
* @param effectDuration The effect duration in milliseconds.
*/
public void setEditEffectDuration(int effectDuration) {
@@ -330,7 +330,7 @@
/**
* Returns the edit effect rate.
- *
+ *
* @return The effect rate.
*/
public int getEditEffectRate() {
@@ -339,7 +339,7 @@
/**
* Sets the edit effect rate.
- *
+ *
* @param effectRate The effect rate.
*/
public void setEditEffectRate(int effectRate) {
diff --git a/wtk/src/org/apache/pivot/wtk/content/TreeBranch.java b/wtk/src/org/apache/pivot/wtk/content/TreeBranch.java
index b85ae52..6c99eb5 100644
--- a/wtk/src/org/apache/pivot/wtk/content/TreeBranch.java
+++ b/wtk/src/org/apache/pivot/wtk/content/TreeBranch.java
@@ -72,7 +72,7 @@
* exists in the application context resource cache, the cached value will
* be used. Otherwise, the icon will be loaded synchronously and added to
* the cache.
- *
+ *
* @param iconURL The location of the expanded icon to set.
*/
public void setExpandedIcon(URL iconURL) {
@@ -86,7 +86,7 @@
/**
* Sets the tree branch's expanded icon by
* {@linkplain ClassLoader#getResource(String) resource name}.
- *
+ *
* @param expandedIconName The resource name of the expanded icon to set.
* @see #setExpandedIcon(URL)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/content/TreeNode.java b/wtk/src/org/apache/pivot/wtk/content/TreeNode.java
index 4650907..5638d64 100644
--- a/wtk/src/org/apache/pivot/wtk/content/TreeNode.java
+++ b/wtk/src/org/apache/pivot/wtk/content/TreeNode.java
@@ -68,7 +68,7 @@
* Sets the tree node's icon by URL. <p> If the icon already exists in the
* application context resource cache, the cached value will be used.
* Otherwise, the icon will be loaded synchronously and added to the cache.
- *
+ *
* @param iconURL The location of the icon to set.
*/
public void setIcon(URL iconURL) {
@@ -82,7 +82,7 @@
/**
* Sets the tree node's icon by {@linkplain ClassLoader#getResource(String)
* resource name}.
- *
+ *
* @param iconName The resource name of the icon to set.
* @see #setIcon(URL)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/content/TreeViewNodeRenderer.java b/wtk/src/org/apache/pivot/wtk/content/TreeViewNodeRenderer.java
index e0c07d1..ead39bf 100644
--- a/wtk/src/org/apache/pivot/wtk/content/TreeViewNodeRenderer.java
+++ b/wtk/src/org/apache/pivot/wtk/content/TreeViewNodeRenderer.java
@@ -182,7 +182,7 @@
/**
* Gets the bounds of the text that is rendered by this renderer.
- *
+ *
* @return The bounds of the rendered text, or <tt>null</tt> if this
* renderer did not render any text.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java b/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java
index f673385..75e182f 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java
@@ -50,7 +50,7 @@
/**
* Creates a <tt>BlurDecorator</tt> with the default blur magnitude.
- *
+ *
* @see #BlurDecorator(int)
*/
public BlurDecorator() {
@@ -59,7 +59,7 @@
/**
* Creates a <tt>BlurDecorator</tt> with the specified blur magnitude.
- *
+ *
* @param blurMagnitude The intensity of the blur.
*/
public BlurDecorator(int blurMagnitude) {
diff --git a/wtk/src/org/apache/pivot/wtk/effects/Decorator.java b/wtk/src/org/apache/pivot/wtk/effects/Decorator.java
index 30758e2..c75b160 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/Decorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/Decorator.java
@@ -49,7 +49,7 @@
* will paint. This method is called immediately prior to
* {@link Component#paint(Graphics2D)}; decorators are called in descending
* order.
- *
+ *
* @param component
* @param graphics
* @return The graphics context that should be used by the component or prior
@@ -67,7 +67,7 @@
/**
* Returns the bounding area of the decorator.
- *
+ *
* @param component
* @return The decorator's bounds, relative to the component's origin.
*/
@@ -76,7 +76,7 @@
/**
* Returns the transformation the decorator applies to the component's
* coordinate space.
- *
+ *
* @return The decorator's transform.
*/
public AffineTransform getTransform(Component component);
diff --git a/wtk/src/org/apache/pivot/wtk/effects/DropShadowDecorator.java b/wtk/src/org/apache/pivot/wtk/effects/DropShadowDecorator.java
index b96f1e6..c688eeb 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/DropShadowDecorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/DropShadowDecorator.java
@@ -55,7 +55,7 @@
/**
* Returns the color used to draw the shadow.
- *
+ *
* @return The color used to draw the shadow.
*/
public Color getShadowColor() {
@@ -64,7 +64,7 @@
/**
* Sets the color used to draw the shadow.
- *
+ *
* @param shadowColor The color used to draw the shadow.
*/
public void setShadowColor(Color shadowColor) {
@@ -73,7 +73,7 @@
/**
* Sets the color used to draw the shadow.
- *
+ *
* @param shadowColor The color used to draw the shadow, which can be any of
* the {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
@@ -88,7 +88,7 @@
/**
* Returns the opacity used to draw the shadow.
- *
+ *
* @return The color used to draw the shadow.
*/
public float getShadowOpacity() {
@@ -97,7 +97,7 @@
/**
* Sets the opacity used to draw the shadow.
- *
+ *
* @param shadowOpacity The opacity used to draw the shadow.
*/
public void setShadowOpacity(float shadowOpacity) {
@@ -106,7 +106,7 @@
/**
* Returns the blur radius used to draw the shadow.
- *
+ *
* @return The blur radius used to draw the shadow.
*/
public int getBlurRadius() {
@@ -115,7 +115,7 @@
/**
* Sets the blur radius used to draw the shadow.
- *
+ *
* @param blurRadius The blur radius used to draw the shadow.
*/
public void setBlurRadius(int blurRadius) {
@@ -124,7 +124,7 @@
/**
* Returns the amount that the drop shadow will be offset along the x axis.
- *
+ *
* @return The x offset used to draw the shadow
*/
public int getXOffset() {
@@ -133,7 +133,7 @@
/**
* Sets the amount that the drop shadow will be offset along the x axis.
- *
+ *
* @param xOffset The x offset used to draw the shadow
*/
public void setXOffset(int xOffset) {
@@ -142,7 +142,7 @@
/**
* Returns the amount that the drop shadow will be offset along the y axis.
- *
+ *
* @return The y offset used to draw the shadow
*/
public int getYOffset() {
@@ -151,7 +151,7 @@
/**
* Sets the amount that the drop shadow will be offset along the y axis.
- *
+ *
* @param yOffset The y offset used to draw the shadow
*/
public void setYOffset(int yOffset) {
@@ -210,7 +210,7 @@
* the decorator. The generated image dimensions are computed as follows:
* <pre> width = imageWidth + 2 * blurRadius height = imageHeight + 2 *
* blurRadius </pre>
- *
+ *
* @param src The image from which the shadow will be cast.
* @return An image containing the generated shadow.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java b/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java
index 9eaea10..86d36ba 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java
@@ -37,7 +37,7 @@
/**
* Creates a new rotation decorator with the specified theta value.
- *
+ *
* @param theta The rotation angle, in radians.
*/
public RotationDecorator(double theta) {
diff --git a/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java b/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java
index 5fd7376..1e886b6 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java
@@ -54,7 +54,7 @@
/**
* Creates a new <tt>ScaleDecorator</tt> with the specified <tt>scaleX</tt>
* and <tt>scaleY</tt> values.
- *
+ *
* @param scaleX The amount to scale the component's x-axis
* @param scaleY The amount to scale the component's y-axis
*/
@@ -65,7 +65,7 @@
/**
* Gets the amount by which drawing operations will be scaled along the
* x-axis.
- *
+ *
* @return The amount to scale the component's x-axis
*/
public float getScaleX() {
@@ -75,7 +75,7 @@
/**
* Sets the amount by which drawing operations will be scaled along the
* x-axis.
- *
+ *
* @param scaleX The amount to scale the component's x-axis
*/
public void setScaleX(float scaleX) {
@@ -85,7 +85,7 @@
/**
* Sets the amount by which drawing operations will be scaled along the
* x-axis.
- *
+ *
* @param scaleX The amount to scale the component's x-axis
*/
public void setScaleX(Number scaleX) {
@@ -99,7 +99,7 @@
/**
* Gets the amount by which drawing operations will be scaled along the
* y-axis.
- *
+ *
* @return The amount to scale the component's y-axis
*/
public float getScaleY() {
@@ -109,7 +109,7 @@
/**
* Sets the amount by which drawing operations will be scaled along the
* y-axis.
- *
+ *
* @param scaleY The amount to scale the component's y-axis
*/
public void setScaleY(float scaleY) {
@@ -119,7 +119,7 @@
/**
* Sets the amount by which drawing operations will be scaled along the
* y-axis.
- *
+ *
* @param scaleY The amount to scale the component's y-axis
*/
public void setScaleY(Number scaleY) {
@@ -133,7 +133,7 @@
/**
* Sets the amount by which drawing operations will be scaled along the x
* and y axes.
- *
+ *
* @param scaleX The amount to scale the component's x-axis.
* @param scaleY The amount to scale the component's y-axis.
*/
@@ -153,7 +153,7 @@
/**
* Sets the amount by which drawing operations will be scaled along both the
* x and y axes.
- *
+ *
* @param scale The amount to scale the component's x and y axes.
*/
public void setScale(float scale) {
@@ -168,7 +168,7 @@
* the component's bounding box. A center or justified alignment will paint
* the scaled component centered with respect to the component's bounding
* box.
- *
+ *
* @return The horizontal alignment
*/
public HorizontalAlignment getHorizontalAlignment() {
@@ -182,7 +182,7 @@
* the component's bounding box. A center or justified alignment will paint
* the scaled component centered with respect to the component's bounding
* box.
- *
+ *
* @param horizontalAlignment The horizontal alignment
*/
public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment) {
@@ -200,7 +200,7 @@
* the component's bounding box. A center or justified alignment will paint
* the scaled component centered with respect to the component's bounding
* box.
- *
+ *
* @return The vertical alignment
*/
public VerticalAlignment getVerticalAlignment() {
@@ -214,7 +214,7 @@
* the component's bounding box. A center or justified alignment will paint
* the scaled component centered with respect to the component's bounding
* box.
- *
+ *
* @param verticalAlignment The vertical alignment
*/
public void setVerticalAlignment(VerticalAlignment verticalAlignment) {
@@ -229,7 +229,7 @@
* Gets the x translation that will be applied with respect to the specified
* component, given this decorator's <tt>scaleX</tt> and
* <tt>horizontalAlignment</tt> properties.
- *
+ *
* @param component The component being decorated
* @return The amount to translate x-coordinate actions when decorating this
* component
@@ -259,7 +259,7 @@
* Gets the y translation that will be applied with respect to the specified
* component, given this decorator's <tt>scaleY</tt> and
* <tt>verticalAlignment</tt> properties.
- *
+ *
* @param component The component being decorated
* @return The amount to translate y-coordinate actions when decorating this
* component
diff --git a/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java b/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java
index 8d3df17..cd3bacf 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java
@@ -48,7 +48,7 @@
/**
* Creates a new <tt>ShadeDecorator</tt> with the specified opacity and
* shade color.
- *
+ *
* @param opacity The opacity of the shade, between 0 and 1, exclusive.
* @param color The color of the shade.
*/
@@ -74,7 +74,7 @@
/**
* Sets the opacity of the decorator.
- *
+ *
* @param opacity A number between 0 (transparent) and 1 (opaque)
*/
public void setOpacity(float opacity) {
@@ -83,7 +83,7 @@
/**
* Sets the opacity of the decorator.
- *
+ *
* @param opacity A number between 0 (transparent) and 1 (opaque)
*/
public void setOpacity(Number opacity) {
@@ -114,7 +114,7 @@
/**
* Sets the color of the decorator
- *
+ *
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/effects/Transition.java b/wtk/src/org/apache/pivot/wtk/effects/Transition.java
index c88d150..7531296 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/Transition.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/Transition.java
@@ -60,7 +60,7 @@
/**
* Creates a new non-repeating transition with the given duration, rate.
- *
+ *
* @param duration Transition duration, in milliseconds.
* @param rate Transition rate, in frames per second.
*/
@@ -70,7 +70,7 @@
/**
* Creates a new transition with the given duration, rate, and repeat.
- *
+ *
* @param duration Transition duration, in milliseconds.
* @param rate Transition rate, in frames per second.
* @param repeating <tt>true</tt> if the transition should repeat;
@@ -82,7 +82,7 @@
/**
* Creates a new transition with the given duration, rate, and repeat.
- *
+ *
* @param duration Transition duration, in milliseconds.
* @param rate Transition rate, in frames per second.
* @param repeating <tt>true</tt> if the transition should repeat;
@@ -103,7 +103,7 @@
/**
* Returns the transition duration.
- *
+ *
* @return The duration of the transition, in milliseconds.
* @see #setDuration(int)
*/
@@ -114,7 +114,7 @@
/**
* Sets the transition duration, the length of time the transition is
* scheduled to run.
- *
+ *
* @param duration The duration of the transition, in milliseconds.
*/
public void setDuration(int duration) {
@@ -131,7 +131,7 @@
/**
* Returns the transition rate.
- *
+ *
* @return The rate of the transition, in frames per second.
* @see #setRate(int)
*/
@@ -142,7 +142,7 @@
/**
* Sets the transition rate, the number of times the transition will be
* updated within the span of one second.
- *
+ *
* @param rate The transition rate, in frames per second.
*/
public void setRate(int rate) {
@@ -160,7 +160,7 @@
/**
* Returns the transition interval, the number of milliseconds between
* updates.
- *
+ *
* @return The transition interval, in milliseconds.
*/
public int getInterval() {
@@ -169,7 +169,7 @@
/**
* Returns the time at which the transition was started.
- *
+ *
* @return The transition's start time.
*/
public long getStartTime() {
@@ -178,7 +178,7 @@
/**
* Returns the last time the transition was updated.
- *
+ *
* @return The most recent update time.
*/
public long getCurrentTime() {
@@ -187,7 +187,7 @@
/**
* Returns the elapsed time since the transition started.
- *
+ *
* @return Returns the amount of time that has passed since the transition
* was started. If the transition is reversed, this value reflects the
* amount of time remaining.
@@ -207,7 +207,7 @@
/**
* Returns the percentage of the transition that has completed.
- *
+ *
* @return A value between 0 and 1, inclusive, representing the transition's
* percent complete. If the transition is reversed, this value reflects the
* percent remaining.
@@ -224,7 +224,7 @@
/**
* Tells whether or not the transition is currently running.
- *
+ *
* @return <tt>true</tt> if the transition is currently running;
* <tt>false</tt> if it is not
*/
@@ -234,7 +234,7 @@
/**
* Starts the transition with no listener.
- *
+ *
* @see #start(TransitionListener)
*/
public final void start() {
@@ -246,7 +246,7 @@
* state and starts a timer that will repeatedly call {@link #update()} at
* the current rate. The specified <tt>TransitionListener</tt> will be
* notified when the transition completes.
- *
+ *
* @param transitionListenerArgument The listener to get notified when the
* transition completes, or <tt>null</tt> if no notification is necessary
*/
@@ -303,7 +303,7 @@
/**
* Tests whether the transition is reversed.
- *
+ *
* @return <tt>true</tt> if the transition is reversed; <tt>false</tt>,
* otherwise.
*/
@@ -313,7 +313,7 @@
/**
* Sets the transition's reversed flag.
- *
+ *
* @param reversed
*/
public void setReversed(boolean reversed) {
diff --git a/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java b/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java
index 6df8894..a1c7d30 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java
@@ -22,7 +22,7 @@
public interface TransitionListener {
/**
* Called when a transition has completed.
- *
+ *
* @param transition
*/
public void transitionCompleted(Transition transition);
diff --git a/wtk/src/org/apache/pivot/wtk/effects/WatermarkDecorator.java b/wtk/src/org/apache/pivot/wtk/effects/WatermarkDecorator.java
index e9c0017..4b428c4 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/WatermarkDecorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/WatermarkDecorator.java
@@ -58,7 +58,7 @@
/**
* Creates a new <tt>WatermarkDecorator</tt> with the specified string as
* its text and no image.
- *
+ *
* @param text The text to paint over the decorated component
*/
public WatermarkDecorator(String text) {
@@ -68,7 +68,7 @@
/**
* Creates a new <tt>WatermarkDecorator</tt> with no text and the specified
* image.
- *
+ *
* @param image The image to paint over the decorated component
*/
public WatermarkDecorator(Image image) {
@@ -78,7 +78,7 @@
/**
* Creates a new <tt>WatermarkDecorator</tt> with the specified text and
* image.
- *
+ *
* @param text The text to paint over the decorated component
* @param image The image to paint over the decorated component
*/
@@ -100,7 +100,7 @@
/**
* Gets the text that will be painted over this decorator's component.
- *
+ *
* @return This decorator's text
*/
public String getText() {
@@ -109,7 +109,7 @@
/**
* Sets the text that will be painted over this decorator's component.
- *
+ *
* @param text This decorator's text
*/
public void setText(String text) {
@@ -119,7 +119,7 @@
/**
* Gets the font that will be used when painting this decorator's text.
- *
+ *
* @return This decorator's font
*/
public Font getFont() {
@@ -128,7 +128,7 @@
/**
* Sets the font that will be used when painting this decorator's text.
- *
+ *
* @param font This decorator's font
*/
public void setFont(Font font) {
@@ -142,7 +142,7 @@
/**
* Sets the font that will be used when painting this decorator's text.
- *
+ *
* @param font This decorator's font
*/
public final void setFont(String font) {
@@ -163,7 +163,7 @@
/**
* Gets the image that will be painted over this decorator's component.
- *
+ *
* @return This decorator's image
*/
public Image getImage() {
@@ -172,7 +172,7 @@
/**
* Sets the image that will be painted over this decorator's component.
- *
+ *
* @param image This decorator's image
*/
public void setImage(Image image) {
@@ -185,7 +185,7 @@
* URL. <p> If the icon already exists in the application context resource
* cache, the cached value will be used. Otherwise, the icon will be loaded
* synchronously and added to the cache.
- *
+ *
* @param imageURL The location of the image to set.
*/
public void setImage(URL imageURL) {
@@ -198,7 +198,7 @@
/**
* Sets the image that will be painted over this decorator's component.
- *
+ *
* @param imageName The resource name of the image to set.
* @see #setImage(URL)
*/
@@ -217,7 +217,7 @@
/**
* Gets the opacity of the watermark.
- *
+ *
* @return This decorator's opacity
*/
public float getOpacity() {
@@ -226,7 +226,7 @@
/**
* Sets the opacity of the watermark.
- *
+ *
* @param opacity This decorator's opacity
*/
public void setOpacity(float opacity) {
@@ -236,7 +236,7 @@
/**
* Gets the angle at the watermark will be painted, in radians.
- *
+ *
* @return This decorator's watermark angle
*/
public double getTheta() {
@@ -246,7 +246,7 @@
/**
* Sets the angle at the watermark will be painted, in radians. This value
* must lie between <tt>0</tt> and <tt>PI / 2</tt> (inclusive).
- *
+ *
* @param theta This decorator's watermark angle
*/
public void setTheta(double theta) {
diff --git a/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java b/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java
index 03f176b..6ba68b0 100644
--- a/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java
+++ b/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java
@@ -85,7 +85,7 @@
/**
* Reads a serialized image from an input stream.
- *
+ *
* @return A <tt>BufferedImage</tt> object
*/
@Override
diff --git a/wtk/src/org/apache/pivot/wtk/media/ImageListener.java b/wtk/src/org/apache/pivot/wtk/media/ImageListener.java
index c727424..f638e4d 100644
--- a/wtk/src/org/apache/pivot/wtk/media/ImageListener.java
+++ b/wtk/src/org/apache/pivot/wtk/media/ImageListener.java
@@ -22,7 +22,7 @@
public interface ImageListener {
/**
* Called when an image's size has changed.
- *
+ *
* @param image
* @param previousWidth
* @param previousHeight
@@ -31,7 +31,7 @@
/**
* Called when an image's baseline has changed.
- *
+ *
* @param image
* @param previousBaseline
*/
@@ -39,7 +39,7 @@
/**
* Called when a region within an image needs to be repainted.
- *
+ *
* @param image
* @param x
* @param y
diff --git a/wtk/src/org/apache/pivot/wtk/media/MovieListener.java b/wtk/src/org/apache/pivot/wtk/media/MovieListener.java
index 7b32d58..c5dea27 100644
--- a/wtk/src/org/apache/pivot/wtk/media/MovieListener.java
+++ b/wtk/src/org/apache/pivot/wtk/media/MovieListener.java
@@ -62,7 +62,7 @@
/**
* Called when a movie's size has changed.
- *
+ *
* @param movie
* @param previousWidth
* @param previousHeight
@@ -71,7 +71,7 @@
/**
* Called when a movie's baseline has changed.
- *
+ *
* @param movie
* @param previousBaseline
*/
@@ -79,7 +79,7 @@
/**
* Called when the movie's current frame changed.
- *
+ *
* @param movie
* @param previousFrame
*/
@@ -87,7 +87,7 @@
/**
* Called when the movie's looping property changed.
- *
+ *
* @param movie
*/
public void loopingChanged(Movie movie);
@@ -96,7 +96,7 @@
* Called when the movie begins playing. The frame at which the movie is
* starting can be obtained via <tt>getCurrentFrame()</tt> (it is not
* guaranteed to be positioned before the first frame when it is started).
- *
+ *
* @param movie
*/
public void movieStarted(Movie movie);
@@ -105,14 +105,14 @@
* Called when the movie stops playing. The frame at which the movie stopped
* can be obtained via <tt>getCurrentFrame()</tt> (it is not guaranteed to
* have completed the last frame when it is stopped).
- *
+ *
* @param movie
*/
public void movieStopped(Movie movie);
/**
* Called when a region within a movie needs to be repainted.
- *
+ *
* @param movie
* @param x
* @param y
diff --git a/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java b/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java
index d8eaa8e..82f6f17 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java
@@ -336,7 +336,7 @@
/**
* Sets the font used in rendering the title
- *
+ *
* @param font A {@link ComponentSkin#decodeFont(String) font specification}
*/
public final void setFont(String font) {
@@ -349,7 +349,7 @@
/**
* Sets the font used in rendering the title
- *
+ *
* @param font A dictionary {@link Theme#deriveFont describing a font}
*/
public final void setFont(Dictionary<String, ?> font) {
@@ -381,7 +381,7 @@
/**
* Sets the color of the border
- *
+ *
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
*/
@@ -468,7 +468,7 @@
/**
* Sets the amount of space to leave between the edge of the Border and its
* content.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -503,7 +503,7 @@
/**
* Sets the amount of space to leave between the edge of the Border and its
* content.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
@@ -537,7 +537,7 @@
/**
* Sets the radii of the Border's corners
- *
+ *
* @param cornerRadii A Dictionary
* {@link CornerRadii#CornerRadii(Dictionary) specifying the four corners}
*/
@@ -569,7 +569,7 @@
/**
* Sets the radii of the Border's corners
- *
+ *
* @param cornerRadii A single integer value, or a JSON dictionary
* {@link CornerRadii#CornerRadii(Dictionary) specifying the four corners}
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java
index 0a903e6..676bc65 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java
@@ -561,7 +561,7 @@
/**
* Sets the amount of space to leave between the edge of the BoxPane and its
* components.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -596,7 +596,7 @@
/**
* Sets the amount of space to leave between the edge of the BoxPane and its
* components.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
@@ -648,7 +648,7 @@
/**
* Sets whether the BoxPane's components fill to the edges of the pane.
- *
+ *
* @param fill If <b>true</b>, the components are given all the available
* space in the dimension orthogonal to the pane's orientation (e.g.,
* vertically in a BoxPane with orientation=horizontal). It has no effect on
diff --git a/wtk/src/org/apache/pivot/wtk/skin/CalendarButtonSkin.java b/wtk/src/org/apache/pivot/wtk/skin/CalendarButtonSkin.java
index 76593a7..e0d57be 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/CalendarButtonSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/CalendarButtonSkin.java
@@ -281,7 +281,7 @@
/**
* {@link KeyCode#SPACE SPACE} Repaints the component to reflect the pressed
* state.
- *
+ *
* @see #keyReleased(Component, int,
* org.apache.pivot.wtk.Keyboard.KeyLocation)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java
index be3f5b1..1b7c06f 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java
@@ -511,7 +511,7 @@
/**
* Sets the amount of space to leave between the edge of the CardPane and
* its content.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -546,7 +546,7 @@
/**
* Sets the amount of space to leave between the edge of the CardPane and
* its content.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
@@ -610,7 +610,7 @@
* from the last card to the first, and backward when they transition from
* the first card to the last. <p> Note: to avoid ambiguity, the circular
* style will be ignored if the card pane has fewer than three cards.
- *
+ *
* @return <tt>true</tt> if directional transitions will be circular;
* <tt>false</tt> otherwise
*/
@@ -629,7 +629,7 @@
* from the last card to the first, and backward when they transition from
* the first card to the last. <p> Note: to avoid ambiguity, the circular
* style will be ignored if the card pane has fewer than three cards.
- *
+ *
* @param circular <tt>true</tt> if directional transitions should be
* circular; <tt>false</tt> otherwise
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/ColorChooserButtonSkin.java b/wtk/src/org/apache/pivot/wtk/skin/ColorChooserButtonSkin.java
index 3894617..b90927b 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/ColorChooserButtonSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/ColorChooserButtonSkin.java
@@ -292,7 +292,7 @@
/**
* {@link KeyCode#SPACE SPACE} Repaints the component to reflect the pressed
* state.
- *
+ *
* @see #keyReleased(Component, int,
* org.apache.pivot.wtk.Keyboard.KeyLocation)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java b/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java
index 90abd87..a6f9579 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java
@@ -382,7 +382,7 @@
/**
* Interpret a string as a font specification
- *
+ *
* @param value Either a JSON dictionary {@link Theme#deriveFont describing
* a font relative to the current theme}, or one of the
* {@link Font#decode(String) standard Java font specifications}.
diff --git a/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java b/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java
index 940129d..60adbd7 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java
@@ -183,7 +183,7 @@
/**
* Sets the object used to paint the background of the container.
- *
+ *
* @param backgroundPaint The {@link Paint} object
*/
public void setBackgroundPaint(Paint backgroundPaint) {
@@ -193,7 +193,7 @@
/**
* Sets the object used to paint the background of the container.
- *
+ *
* @param backgroundPaint A string recognized by Pivot as a
* {@linkplain GraphicsUtilities#decodePaint(String) Color or Paint value}.
*/
@@ -207,7 +207,7 @@
/**
* Sets the object used to paint the background of the container.
- *
+ *
* @param backgroundPaint A dictionary containing a
* {@linkplain GraphicsUtilities#decodePaint(Dictionary) Paint description}.
*/
@@ -236,7 +236,7 @@
/**
* Sets the background of the container to a solid color.
- *
+ *
* @param backgroundColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
diff --git a/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java
index a3ef1b4..e3d2422 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java
@@ -367,7 +367,7 @@
/**
* Sets the amount of space to leave between the edge of the FillPane and
* its components.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -402,7 +402,7 @@
/**
* Sets the amount of space to leave between the edge of the FillPane and
* its components.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java
index 9015034..0c90f0b 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java
@@ -367,7 +367,7 @@
/**
* Sets the amount of space to leave between the edge of the FlowPane and
* its components.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -402,7 +402,7 @@
/**
* Sets the amount of space to leave between the edge of the FlowPane and
* its components.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java
index bb0ed14..67b292f 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java
@@ -586,7 +586,7 @@
/**
* Sets the color used to paint the grid pane's horizontal grid lines.
- *
+ *
* @param horizontalGridColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
@@ -623,7 +623,7 @@
/**
* Sets the color used to paint the grid pane's vertical grid lines.
- *
+ *
* @param verticalGridColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
diff --git a/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java b/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java
index 4f4e697..5243445 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java
@@ -281,7 +281,7 @@
/**
* Sets the color that is painted behind the image
- *
+ *
* @param backgroundColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
@@ -303,7 +303,7 @@
/**
* Sets the opacity of the image.
- *
+ *
* @param opacity A number between 0 (transparent) and 1 (opaque)
*/
public void setOpacity(float opacity) {
@@ -317,7 +317,7 @@
/**
* Sets the opacity of the image.
- *
+ *
* @param opacity A number between 0 (transparent) and 1 (opaque)
*/
public final void setOpacity(Number opacity) {
diff --git a/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java b/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java
index 474ffd5..4da0c1c 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java
@@ -477,7 +477,7 @@
/**
* Sets the font used in rendering the Label's text
- *
+ *
* @param font A {@link ComponentSkin#decodeFont(String) font specification}
*/
public final void setFont(String font) {
@@ -490,7 +490,7 @@
/**
* Sets the font used in rendering the Label's text
- *
+ *
* @param font A dictionary {@link Theme#deriveFont describing a font}
*/
public final void setFont(Dictionary<String, ?> font) {
@@ -522,7 +522,7 @@
/**
* Sets the foreground color of the text of the label.
- *
+ *
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
*/
@@ -555,7 +555,7 @@
/**
* Sets the foreground color of the text of the label when disabled.
- *
+ *
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
*/
@@ -584,7 +584,7 @@
/**
* Sets the background color of the label.
- *
+ *
* @param backgroundColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
@@ -656,7 +656,7 @@
/**
* Sets the amount of space to leave between the edge of the Label and its
* text.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -691,7 +691,7 @@
/**
* Sets the amount of space to leave between the edge of the Label and its
* text.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/ListButtonSkin.java b/wtk/src/org/apache/pivot/wtk/skin/ListButtonSkin.java
index deb1875..deed259 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/ListButtonSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/ListButtonSkin.java
@@ -299,7 +299,7 @@
* state and opens the popup.<br> {@link KeyCode#UP UP} Selects the previous
* enabled list item.<br> {@link KeyCode#DOWN DOWN} Selects the next enabled
* list item.
- *
+ *
* @see #keyReleased(Component, int,
* org.apache.pivot.wtk.Keyboard.KeyLocation)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/MenuButtonSkin.java b/wtk/src/org/apache/pivot/wtk/skin/MenuButtonSkin.java
index a3ee043..693f9ab 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/MenuButtonSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/MenuButtonSkin.java
@@ -168,7 +168,7 @@
/**
* {@link KeyCode#SPACE SPACE} Repaints the component to reflect the pressed
* state.
- *
+ *
* @see #keyReleased(Component, int,
* org.apache.pivot.wtk.Keyboard.KeyLocation)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/PushButtonSkin.java b/wtk/src/org/apache/pivot/wtk/skin/PushButtonSkin.java
index eb16a3b..b148791 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/PushButtonSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/PushButtonSkin.java
@@ -82,7 +82,7 @@
/**
* {@link KeyCode#SPACE SPACE} Repaints the component to reflect the pressed
* state.
- *
+ *
* @see #keyReleased(Component, int,
* org.apache.pivot.wtk.Keyboard.KeyLocation)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/ScrollPaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/ScrollPaneSkin.java
index aa04c49..e61b572 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/ScrollPaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/ScrollPaneSkin.java
@@ -419,7 +419,7 @@
* {@link KeyCode#RIGHT RIGHT} Scroll right a single scroll unit.<br>
* {@link KeyCode#PAGE_UP PAGE_UP} Scroll up a single scroll block.<br>
* {@link KeyCode#PAGE_DOWN PAGE_DOWN} Scroll down a single scroll block.
- *
+ *
* @see ScrollBar#getBlockIncrement()
* @see ScrollBar#getUnitIncrement()
*/
@@ -483,7 +483,7 @@
* Gets the maximum legal <tt>scrollTop</tt> value this this skin imposes.
* This is the largest value possible that still shows as much of the view
* component as it can.
- *
+ *
* @return The maximum scrollTop value
*/
private int getMaxScrollTop() {
@@ -518,7 +518,7 @@
* Gets the maximum legal <tt>scrollLeft</tt> value this this skin imposes.
* This is the largest value possible that still shows as much of the view
* component as it can.
- *
+ *
* @return The maximum scrollLeft value
*/
private int getMaxScrollLeft() {
@@ -619,7 +619,7 @@
/**
* Layout helper method that assumes that the <tt>FILL_TO_CAPACITY</tt>
* scroll policy doesn't exist.
- *
+ *
* @param horizontalPolicy The assumed horizontal scroll policy; musn't be
* <tt>FILL_TO_CAPACITY</tt>
* @param verticalPolicy The assumed vertical scroll policy; musn't be
diff --git a/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java b/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java
index 19461e1..dfa0278 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java
@@ -194,7 +194,7 @@
/**
* Sets the font used in rendering the Separator's heading
- *
+ *
* @param font A {@link ComponentSkin#decodeFont(String) font specification}
*/
public final void setFont(String font) {
@@ -207,7 +207,7 @@
/**
* Sets the font used in rendering the Separator's heading
- *
+ *
* @param font A dictionary {@link Theme#deriveFont describing a font}
*/
public final void setFont(Dictionary<String, ?> font) {
@@ -239,7 +239,7 @@
/**
* Sets the color of the Separator's horizontal rule
- *
+ *
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
*/
@@ -272,7 +272,7 @@
/**
* Sets the color of the text in the heading
- *
+ *
* @param headingColor Any of the {@linkplain GraphicsUtilities#decodeColor
* color values recognized by Pivot}.
*/
@@ -337,7 +337,7 @@
/**
* Sets the amount of space to leave around the Separator's heading, and
* above and below the entire component.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -372,7 +372,7 @@
/**
* Sets the amount of space to leave around the Separator's heading, and
* above and below the entire component.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java
index 510bb14..d3300de 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java
@@ -121,7 +121,7 @@
/**
* Sets the amount of space to leave between the edge of the StackPane and
* its components.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -156,7 +156,7 @@
/**
* Sets the amount of space to leave between the edge of the StackPane and
* its components.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java
index 96a3b3b..7d3247f 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java
@@ -780,7 +780,7 @@
/**
* Sets the amount of space that will be reserved around the inside edges of
* the table pane.
- *
+ *
* @param padding A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -807,7 +807,7 @@
/**
* Sets the amount of space that will be reserved around the inside edges of
* the table pane.
- *
+ *
* @param padding A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
@@ -919,7 +919,7 @@
/**
* Sets the color used to paint the table pane's horizontal grid lines.
- *
+ *
* @param horizontalGridColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
@@ -956,7 +956,7 @@
/**
* Sets the color used to paint the table pane's vertical grid lines.
- *
+ *
* @param verticalGridColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
@@ -990,7 +990,7 @@
/**
* Sets the background color used to paint the highlighted rows and columns.
- *
+ *
* @param highlightBackgroundColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
* Pivot}.
@@ -1008,7 +1008,7 @@
* to occupy a cell if it is visible and either lives in the cell directly
* or spans the cell. Conversely, vacant cells do not have visible
* components within them or spanning them.
- *
+ *
* @return A grid of booleans, where occupied cells are denoted by
* <tt>true</tt>, and vacant cells are denoted by <tt>false</tt>
*/
@@ -1053,7 +1053,7 @@
* components that span multiple columns will not be considered in this
* calculation (even if they live in the column directly). It is up to the
* caller to factor such components into the column widths calculation.
- *
+ *
* @param columnIndex The index of the column whose preferred width we're
* calculating
*/
@@ -1085,7 +1085,7 @@
* if and only if one or more visible components occupies it. A component is
* said to occupy a cell if it either lives in the cell directly or spans
* the cell.
- *
+ *
* @param columnIndex The index of the column within the table pane
* @return <tt>true</tt> if the column is visible; <tt>false</tt> otherwise
*/
@@ -1114,7 +1114,7 @@
* not be considered in this calculation (even if they live in the column
* directly). It is up to the caller to factor such components into the row
* heights calculation.
- *
+ *
* @param rowIndex The index of the row whose preferred height we're
* calculating
* @param columnWidthsArgument An array of column width values corresponding
@@ -1149,7 +1149,7 @@
* and only if one or more visible components occupies it. A component is
* said to occupy a cell if it either lives in the cell directly or spans
* the cell.
- *
+ *
* @param rowIndex The index of the row within the table pane
* @return <tt>true</tt> if the row is visible; <tt>false</tt> otherwise
*/
@@ -1171,7 +1171,7 @@
/**
* Gets the width of each table pane column given the specified table pane
* width.
- *
+ *
* @param width The width constraint of the table pane
* @return An array containing the width of each column in the table pane
* given the specified constraint
@@ -1331,7 +1331,7 @@
/**
* Gets the height of each row of a table pane given the specified
* constraints.
- *
+ *
* @param height The height constraint of the table pane
* @param columnWidthsArgument The widths of the table pane's columns, which
* will be used as width constraints to the row heights when necessary, or
diff --git a/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java b/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java
index e169bdc..026274d 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java
@@ -526,7 +526,7 @@
/**
* Sets the font of the text
- *
+ *
* @param font A {@link ComponentSkin#decodeFont(String) font specification}
*/
public final void setFont(String font) {
@@ -539,7 +539,7 @@
/**
* Sets the font of the text
- *
+ *
* @param font A dictionary {@link Theme#deriveFont describing a font}
*/
public final void setFont(Dictionary<String, ?> font) {
@@ -571,7 +571,7 @@
/**
* Sets the foreground color of the text
- *
+ *
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
*/
@@ -726,7 +726,7 @@
/**
* Sets the amount of space between the edge of the TextArea and its text
- *
+ *
* @param margin A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -758,7 +758,7 @@
/**
* Sets the amount of space between the edge of the TextArea and its text
- *
+ *
* @param margin A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
@@ -790,7 +790,7 @@
/**
* Gets current value of style that determines the behavior of <tt>TAB</tt>
* and <tt>Ctrl-TAB</tt> characters.
- *
+ *
* @return <tt>true</tt> if <tt>TAB</tt> inserts an appropriate number of
* spaces, while <tt>Ctrl-TAB</tt> shifts focus to next component.
* <tt>false</tt> (default) means <tt>TAB</tt> shifts focus and
@@ -803,7 +803,7 @@
/**
* Sets current value of style that determines the behavior of <tt>TAB</tt>
* and <tt>Ctrl-TAB</tt> characters.
- *
+ *
* @param acceptsTab <tt>true</tt> if <tt>TAB</tt> inserts an appropriate
* number of spaces, while <tt>Ctrl-TAB</tt> shifts focus to next component.
* <tt>false</tt> (default) means <tt>TAB</tt> shifts focus and
diff --git a/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java b/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java
index bb645f3..1cf06f4 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java
@@ -417,7 +417,7 @@
/**
* Sets the font of the text
- *
+ *
* @param font A {@link ComponentSkin#decodeFont(String) font specification}
*/
public final void setFont(String font) {
@@ -430,7 +430,7 @@
/**
* Sets the font of the text
- *
+ *
* @param font A dictionary {@link Theme#deriveFont describing a font}
*/
public final void setFont(Dictionary<String, ?> font) {
@@ -462,7 +462,7 @@
/**
* Sets the foreground color of the text
- *
+ *
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
*/
@@ -603,7 +603,7 @@
/**
* Sets the amount of space between the edge of the TextPane and its
* Document
- *
+ *
* @param margin A dictionary with keys in the set {left, top, bottom,
* right}.
*/
@@ -638,7 +638,7 @@
/**
* Sets the amount of space between the edge of the TextPane and its
* Document
- *
+ *
* @param margin A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
*/
diff --git a/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinNodeView.java b/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinNodeView.java
index c6da566..bb7aca2 100644
--- a/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinNodeView.java
+++ b/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinNodeView.java
@@ -126,7 +126,7 @@
/**
* Set location of the NodeView relative to the skin component. This is
* needed by the ComponentViewNode to correctly position child Component's.
- *
+ *
* @param skinX the X coordinate in the skin's frame of reference
* @param skinY the Y coordinate in the skin's frame of reference
*/
diff --git a/wtk/src/org/apache/pivot/wtk/text/BlockListener.java b/wtk/src/org/apache/pivot/wtk/text/BlockListener.java
index 3ea64ca..4441e3b 100644
--- a/wtk/src/org/apache/pivot/wtk/text/BlockListener.java
+++ b/wtk/src/org/apache/pivot/wtk/text/BlockListener.java
@@ -33,7 +33,7 @@
/**
* Called when the horizontal alignment has changed.
- *
+ *
* @param block
* @param previousHorizontalAlignment
*/
diff --git a/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java b/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java
index ea58213..5035db2 100644
--- a/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java
+++ b/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java
@@ -30,7 +30,7 @@
/**
* Called when the list style has changed.
- *
+ *
* @param bulletedList
* @param previousStyle
*/
diff --git a/wtk/src/org/apache/pivot/wtk/text/Element.java b/wtk/src/org/apache/pivot/wtk/text/Element.java
index 1fe6164..a865283 100644
--- a/wtk/src/org/apache/pivot/wtk/text/Element.java
+++ b/wtk/src/org/apache/pivot/wtk/text/Element.java
@@ -478,7 +478,7 @@
/**
* Determines the index of the child node at a given offset.
- *
+ *
* @param offset
* @return The index of the child node at the given offset.
*/
@@ -500,7 +500,7 @@
/**
* Determines the path of the descendant node at a given offset.
- *
+ *
* @param offset
* @return The path to the descendant node at the given offset.
*/
@@ -524,7 +524,7 @@
/**
* Determines the descendant node at a given offset.
- *
+ *
* @param offset
* @return The descendant node at the given offset.
*/
@@ -627,7 +627,7 @@
/**
* Sets the currently foreground color.
- *
+ *
* @param foregroundColor The foreground color, or <tt>null</tt> to specify
* no selection
*/
@@ -642,7 +642,7 @@
/**
* Sets the currently foreground color.
- *
+ *
* @param foregroundColor The foreground color
*/
public void setForegroundColor(String foregroundColor) {
@@ -663,7 +663,7 @@
/**
* Sets the currently background color.
- *
+ *
* @param backgroundColor The background color, or <tt>null</tt> to specify
* no selection
*/
@@ -678,7 +678,7 @@
/**
* Sets the currently background color.
- *
+ *
* @param backgroundColor The background color
*/
public void setBackgroundColor(String backgroundColor) {
diff --git a/wtk/src/org/apache/pivot/wtk/text/ElementListener.java b/wtk/src/org/apache/pivot/wtk/text/ElementListener.java
index 8b2e871..579ce85 100644
--- a/wtk/src/org/apache/pivot/wtk/text/ElementListener.java
+++ b/wtk/src/org/apache/pivot/wtk/text/ElementListener.java
@@ -65,7 +65,7 @@
/**
* Called when a node has been inserted into an element.
- *
+ *
* @param element
* @param index
*/
@@ -73,7 +73,7 @@
/**
* Called when nodes have been removed from an element.
- *
+ *
* @param element
* @param index
* @param nodes
@@ -82,7 +82,7 @@
/**
* Called when the font has changed.
- *
+ *
* @param element
* @param previousFont
*/
@@ -90,7 +90,7 @@
/**
* Called when the background color has changed.
- *
+ *
* @param element
* @param previousBackgroundColor
*/
@@ -98,7 +98,7 @@
/**
* Called when the foreground color has changed.
- *
+ *
* @param element
* @param previousForegroundColor
*/
@@ -106,14 +106,14 @@
/**
* Called when underline style has changed.
- *
+ *
* @param element
*/
public void underlineChanged(Element element);
/**
* Called when strikethrough style has changed.
- *
+ *
* @param element
*/
public void strikethroughChanged(Element element);
diff --git a/wtk/src/org/apache/pivot/wtk/text/ImageNode.java b/wtk/src/org/apache/pivot/wtk/text/ImageNode.java
index 0897574..1cd405e 100644
--- a/wtk/src/org/apache/pivot/wtk/text/ImageNode.java
+++ b/wtk/src/org/apache/pivot/wtk/text/ImageNode.java
@@ -76,7 +76,7 @@
* exists in the application context resource cache, the cached value will
* be used. Otherwise, the icon will be loaded synchronously and added to
* the cache.
- *
+ *
* @param imageURL The location of the image to set.
*/
public void setImage(URL imageURL) {
@@ -90,7 +90,7 @@
/**
* Sets the image node's icon by
* {@linkplain ClassLoader#getResource(String) resource name}.
- *
+ *
* @param imageName The resource name of the image to set.
* @see #setImage(URL)
*/
diff --git a/wtk/src/org/apache/pivot/wtk/text/Node.java b/wtk/src/org/apache/pivot/wtk/text/Node.java
index 2e1057f..1ceb1f6 100644
--- a/wtk/src/org/apache/pivot/wtk/text/Node.java
+++ b/wtk/src/org/apache/pivot/wtk/text/Node.java
@@ -75,7 +75,7 @@
/**
* Returns the parent element of this node.
- *
+ *
* @return The node's parent, or <tt>null</tt> if the node does not have a
* parent.
*/
@@ -94,7 +94,7 @@
/**
* Returns the node's offset within its parent.
- *
+ *
* @return The integer offset of the node's first character within its
* parent element.
*/
@@ -121,7 +121,7 @@
/**
* Inserts a range into the node. Note that the contents of the range,
* rather than the range itself, is added to the node.
- *
+ *
* @param range
* @param offsetArgument
*/
@@ -129,7 +129,7 @@
/**
* Removes a range from the node.
- *
+ *
* @param offsetArgument
* @param characterCount
* @return The removed range. This will be a copy of the node structure
@@ -139,7 +139,7 @@
/**
* Replaces an existing range with a new range.
- *
+ *
* @param offsetArgument
* @param characterCount
* @param range
@@ -155,7 +155,7 @@
/**
* Returns a range from the node.
- *
+ *
* @param offsetArgument
* @param characterCount
* @return A node containing a copy of the node structure spanning the given
@@ -165,7 +165,7 @@
/**
* Returns the character at the given offset.
- *
+ *
* @param offsetArgument
*/
public abstract char getCharacterAt(int offsetArgument);
@@ -177,14 +177,14 @@
/**
* Creates a copy of this node.
- *
+ *
* @param recursive
*/
public abstract Node duplicate(boolean recursive);
/**
* Called to notify a node that a range has been inserted.
- *
+ *
* @param offsetArgument
* @param characterCount
*/
@@ -198,7 +198,7 @@
/**
* Called to notify a node that a range has been removed.
- *
+ *
* @param offsetArgument
* @param characterCount
*/
@@ -212,7 +212,7 @@
/**
* Called to notify a node that some child nodes has been removed.
- *
+ *
* @param removed
* @param offsetArgument
*/
@@ -226,7 +226,7 @@
/**
* Called to notify a node that a child node has been inserted.
- *
+ *
* @param offsetArgument
*/
protected void nodeInserted(int offsetArgument) {
diff --git a/wtk/src/org/apache/pivot/wtk/text/NodeListener.java b/wtk/src/org/apache/pivot/wtk/text/NodeListener.java
index 933fde2..8d74c7c 100644
--- a/wtk/src/org/apache/pivot/wtk/text/NodeListener.java
+++ b/wtk/src/org/apache/pivot/wtk/text/NodeListener.java
@@ -57,7 +57,7 @@
/**
* Called when a node's parent has changed, either as a result of being
* added to or removed from an element.
- *
+ *
* @param node
* @param previousParent
*/
@@ -65,7 +65,7 @@
/**
* Called when a node's offset has changed within it's parent element.
- *
+ *
* @param node
* @param previousOffset
*/
@@ -73,7 +73,7 @@
/**
* Called when a child node has been inserted into a node.
- *
+ *
* @param node
* @param offset
*/
@@ -81,7 +81,7 @@
/**
* Called when child nodes have been removed from a node.
- *
+ *
* @param node
* @param removed
* @param offset
@@ -90,7 +90,7 @@
/**
* Called when a text range has been inserted into a node.
- *
+ *
* @param node
* @param offset
* @param span
@@ -99,7 +99,7 @@
/**
* Called when a text range has been removed from a node.
- *
+ *
* @param node
* @param offset
* @param characterCount
diff --git a/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java b/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java
index c82bd7b..3212625 100644
--- a/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java
+++ b/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java
@@ -30,7 +30,7 @@
/**
* Called when the list style has changed.
- *
+ *
* @param numberedList
* @param previousStyle
*/
diff --git a/wtk/src/org/apache/pivot/wtk/text/Span.java b/wtk/src/org/apache/pivot/wtk/text/Span.java
index 78ab62e..fad55de 100644
--- a/wtk/src/org/apache/pivot/wtk/text/Span.java
+++ b/wtk/src/org/apache/pivot/wtk/text/Span.java
@@ -18,7 +18,7 @@
/**
* Element representing an inline range of styled characters.
- *
+ *
* @deprecated class has been renamed to TextSpan
*/
@Deprecated
diff --git a/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java b/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java
index 66a3b82..35a3f6e 100644
--- a/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java
+++ b/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java
@@ -22,7 +22,7 @@
public interface TextNodeListener {
/**
* Called when characters have been inserted into a text node.
- *
+ *
* @param textNode
* @param index
* @param count
@@ -31,7 +31,7 @@
/**
* Called when characters have been removed from a text node.
- *
+ *
* @param textNode
* @param index
* @param count
diff --git a/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java b/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java
index 194bdde..c1765a1 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java
@@ -80,7 +80,7 @@
/**
* tell the autoTrim mode
- *
+ *
* @return true if autoTrim is enabled, otherwise false (default)
*/
public boolean isAutoTrim() {
diff --git a/wtk/src/org/apache/pivot/wtk/validation/DoubleRangeValidator.java b/wtk/src/org/apache/pivot/wtk/validation/DoubleRangeValidator.java
index b9c5a85..a05f953 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/DoubleRangeValidator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/DoubleRangeValidator.java
@@ -19,7 +19,7 @@
* A validator for a double value limited to a range. <p> Beware that usual math
* rules for native primitive types (and related approximations) are applied
* here.
- *
+ *
* @see ComparableRangeValidator
*/
public class DoubleRangeValidator extends DoubleValidator {
diff --git a/wtk/src/org/apache/pivot/wtk/validation/DoubleValidator.java b/wtk/src/org/apache/pivot/wtk/validation/DoubleValidator.java
index edc9e06..f9e34a3 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/DoubleValidator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/DoubleValidator.java
@@ -18,7 +18,7 @@
/**
* A validator for a double value. <p> Beware that usual math rules for native
* primitive types (and related approximations) are applied here.
- *
+ *
* @see BigDecimalValidator
*/
public class DoubleValidator extends DecimalValidator {
diff --git a/wtk/src/org/apache/pivot/wtk/validation/FloatRangeValidator.java b/wtk/src/org/apache/pivot/wtk/validation/FloatRangeValidator.java
index 336afc7..074115f 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/FloatRangeValidator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/FloatRangeValidator.java
@@ -19,7 +19,7 @@
* A validator for a float value limited to a range. <p> Beware that usual math
* rules for native primitive types (and related approximations) are applied
* here.
- *
+ *
* @see ComparableRangeValidator
*/
public class FloatRangeValidator extends FloatValidator {
diff --git a/wtk/src/org/apache/pivot/wtk/validation/FloatValidator.java b/wtk/src/org/apache/pivot/wtk/validation/FloatValidator.java
index 5883788..40cd24b 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/FloatValidator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/FloatValidator.java
@@ -18,7 +18,7 @@
/**
* A validator for a float value. <p> Beware that usual math rules for native
* primitive types (and related approximations) are applied here.
- *
+ *
* @see BigDecimalValidator
*/
public class FloatValidator extends DecimalValidator {
diff --git a/wtk/src/org/apache/pivot/wtk/validation/IntRangeValidator.java b/wtk/src/org/apache/pivot/wtk/validation/IntRangeValidator.java
index c00ec6b..95bca51 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/IntRangeValidator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/IntRangeValidator.java
@@ -19,7 +19,7 @@
* A validator for an int value limited to a range. <p> Beware that usual math
* rules for native primitive types (and related approximations) are applied
* here.
- *
+ *
* @see ComparableRangeValidator
*/
public class IntRangeValidator extends IntValidator {
diff --git a/wtk/src/org/apache/pivot/wtk/validation/IntValidator.java b/wtk/src/org/apache/pivot/wtk/validation/IntValidator.java
index 45357cb..067bf13 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/IntValidator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/IntValidator.java
@@ -18,7 +18,7 @@
/**
* A validator for an int value. <p> Beware that usual math rules for native
* primitive types (and related approximations) are applied here.
- *
+ *
* @see BigIntegerValidator
*/
public class IntValidator extends DecimalValidator {
diff --git a/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java b/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java
index bb33c3c..d04b6e8 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java
@@ -18,7 +18,7 @@
/**
* A validator for a regular expression.
- *
+ *
* @see Pattern
*/
public class RegexTextValidator implements Validator {
diff --git a/wtk/src/org/apache/pivot/wtk/validation/Validator.java b/wtk/src/org/apache/pivot/wtk/validation/Validator.java
index 87d36d6..38a96e6 100644
--- a/wtk/src/org/apache/pivot/wtk/validation/Validator.java
+++ b/wtk/src/org/apache/pivot/wtk/validation/Validator.java
@@ -22,7 +22,7 @@
public interface Validator {
/**
* Determines if a text value is valid based on the rules of the validator.
- *
+ *
* @param text
* @return <tt>true</tt> if the value is valid; <tt>false</tt>, otherwise.
*/
