You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by sm...@apache.org on 2013/10/05 01:57:57 UTC
svn commit: r1529353 [7/8] - in /pivot/trunk:
charts/src/org/apache/pivot/charts/ core/src/org/apache/pivot/beans/
core/src/org/apache/pivot/collections/ core/src/org/apache/pivot/io/
core/src/org/apache/pivot/json/ core/src/org/apache/pivot/serializat...
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java Fri Oct 4 23:57:51 2013
@@ -94,7 +94,7 @@ public class TreeView extends Component
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 @@ public class TreeView extends Component
/**
* 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 class TreeView extends Component
public interface NodeEditor {
/**
* Called to begin editing a tree node.
- *
+ *
* @param treeView
* @param path
*/
@@ -144,7 +144,7 @@ public class TreeView extends Component
/**
* Terminates an edit operation.
- *
+ *
* @param result <tt>true</tt> to perform the edit; <tt>false</tt> to
* cancel it.
*/
@@ -163,7 +163,7 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* [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 @@ public class TreeView extends Component
* <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 @@ public class TreeView extends Component
* <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 @@ public class TreeView extends Component
* <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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* Returns the current selection mode.
- *
+ *
* @return The current selection mode.
*/
public SelectMode getSelectMode() {
@@ -1030,7 +1030,7 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
/**
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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 @@ public class TreeView extends Component
* 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() {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java Fri Oct 4 23:57:51 2013
@@ -40,7 +40,7 @@ public interface TreeViewBranchListener
/**
* 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 @@ public interface TreeViewBranchListener
/**
* Called when a tree node is collapsed.
- *
+ *
* @param treeView The source of the event.
* @param path The path of the node that was collapsed.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java Fri Oct 4 23:57:51 2013
@@ -73,7 +73,7 @@ public interface TreeViewListener {
/**
* Called when a tree view's data has changed.
- *
+ *
* @param treeView
* @param previousTreeData
*/
@@ -81,7 +81,7 @@ public interface TreeViewListener {
/**
* Called when a tree view's node renderer has changed.
- *
+ *
* @param treeView
* @param previousNodeRenderer
*/
@@ -89,7 +89,7 @@ public interface TreeViewListener {
/**
* Called when a tree view's node editor has changed.
- *
+ *
* @param treeView
* @param previousNodeEditor
*/
@@ -97,7 +97,7 @@ public interface TreeViewListener {
/**
* Called when a tree view's select mode has changed.
- *
+ *
* @param treeView
* @param previousSelectMode
*/
@@ -105,21 +105,21 @@ public interface TreeViewListener {
/**
* 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 @@ public interface TreeViewListener {
/**
* Called when a tree view's disabled checkmark filter has changed.
- *
+ *
* @param treeView
* @param previousDisabledCheckmarkFilter
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java Fri Oct 4 23:57:51 2013
@@ -54,7 +54,7 @@ public interface TreeViewNodeListener {
/**
* Called when a node has been inserted into the tree view.
- *
+ *
* @param treeView
* @param path
* @param index
@@ -63,7 +63,7 @@ public interface TreeViewNodeListener {
/**
* Called when nodes have been removed from the tree view.
- *
+ *
* @param treeView
* @param path
* @param index
@@ -74,7 +74,7 @@ public interface TreeViewNodeListener {
/**
* Called when a node in the tree view has been updated.
- *
+ *
* @param treeView
* @param path
* @param index
@@ -83,14 +83,14 @@ public interface TreeViewNodeListener {
/**
* 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
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java Fri Oct 4 23:57:51 2013
@@ -24,7 +24,7 @@ import org.apache.pivot.collections.Sequ
public interface TreeViewNodeStateListener {
/**
* Called when a node's checked state has changed.
- *
+ *
* @param treeView
* @param path
* @param previousCheckState
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java Fri Oct 4 23:57:51 2013
@@ -50,7 +50,7 @@ public interface TreeViewSelectionListen
/**
* Called when a selected path has been added to a tree view.
- *
+ *
* @param treeView
* @param path
*/
@@ -58,7 +58,7 @@ public interface TreeViewSelectionListen
/**
* Called when a selected path has been removed from a tree view.
- *
+ *
* @param treeView
* @param path
*/
@@ -66,7 +66,7 @@ public interface TreeViewSelectionListen
/**
* Called when a tree view's selection state has been reset.
- *
+ *
* @param treeView
* @param previousSelectedPaths
*/
@@ -74,7 +74,7 @@ public interface TreeViewSelectionListen
/**
* Called when a tree view's selected node has changed.
- *
+ *
* @param treeView
* @param previousSelectedNode
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java Fri Oct 4 23:57:51 2013
@@ -122,7 +122,7 @@ public class VFSBrowser extends Containe
* 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 @@ public class VFSBrowser extends Containe
/**
* 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 @@ public class VFSBrowser extends Containe
/**
* Returns the current file system manager.
- *
+ *
* @return The current file system manager.
*/
public FileSystemManager getManager() {
@@ -186,7 +186,7 @@ public class VFSBrowser extends Containe
/**
* Returns the current root directory.
- *
+ *
* @return The current root directory.
*/
public FileObject getRootDirectory() {
@@ -196,7 +196,7 @@ public class VFSBrowser extends Containe
/**
* 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 @@ public class VFSBrowser extends Containe
/**
* Sets the root directory. Clears any existing file selection.
- *
+ *
* @param rootDirectory
*/
public void setRootDirectory(FileObject rootDirectory) throws FileSystemException {
@@ -228,7 +228,7 @@ public class VFSBrowser extends Containe
/**
* 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 @@ public class VFSBrowser extends Containe
/**
* 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 @@ public class VFSBrowser extends Containe
/**
* When in single-select mode, returns the currently selected file.
- *
+ *
* @return The currently selected file.
*/
public FileObject getSelectedFile() {
@@ -291,7 +291,7 @@ public class VFSBrowser extends Containe
/**
* Sets the selection to a single file.
- *
+ *
* @param file
*/
public void setSelectedFile(FileObject file) throws FileSystemException {
@@ -310,7 +310,7 @@ public class VFSBrowser extends Containe
/**
* 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 @@ public class VFSBrowser extends Containe
/**
* Sets the selected files.
- *
+ *
* @param selectedFiles The files to select.
* @return The files that were selected, with duplicates eliminated.
*/
@@ -389,7 +389,7 @@ public class VFSBrowser extends Containe
/**
* 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 @@ public class VFSBrowser extends Containe
/**
* 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 @@ public class VFSBrowser extends Containe
/**
* Sets the file filter.
- *
+ *
* @param disabledFileFilter The file filter to use, or <tt>null</tt> for no
* filter.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java Fri Oct 4 23:57:51 2013
@@ -70,7 +70,7 @@ public interface VFSBrowserListener {
/**
* 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 @@ public interface VFSBrowserListener {
/**
* Called when a file browser's root directory has changed.
- *
+ *
* @param fileBrowser
* @param previousRootDirectory
*/
@@ -86,7 +86,7 @@ public interface VFSBrowserListener {
/**
* Called when a file has been added to a file browser's selection.
- *
+ *
* @param fileBrowser
* @param file
*/
@@ -94,7 +94,7 @@ public interface VFSBrowserListener {
/**
* Called when a file has been removed from a file browser's selection.
- *
+ *
* @param fileBrowser
* @param file
*/
@@ -102,7 +102,7 @@ public interface VFSBrowserListener {
/**
* Called when a file browser's selection state has been reset.
- *
+ *
* @param fileBrowser
* @param previousSelectedFiles
*/
@@ -111,14 +111,14 @@ public interface VFSBrowserListener {
/**
* 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
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java Fri Oct 4 23:57:51 2013
@@ -106,7 +106,7 @@ public class VFSBrowserSheet extends She
/**
* 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 @@ public class VFSBrowserSheet extends She
/**
* 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 @@ public class VFSBrowserSheet extends She
/**
* 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 @@ public class VFSBrowserSheet extends She
/**
* When in single-select mode, returns the currently selected file.
- *
+ *
* @return The currently selected file.
*/
public FileObject getSelectedFile() {
@@ -266,7 +266,7 @@ public class VFSBrowserSheet extends She
/**
* Sets the selection to a single file.
- *
+ *
* @param file
*/
public void setSelectedFile(FileObject file) throws FileSystemException {
@@ -285,7 +285,7 @@ public class VFSBrowserSheet extends She
/**
* 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 @@ public class VFSBrowserSheet extends She
/**
* Sets the selected files.
- *
+ *
* @param selectedFiles The files to select.
* @return The files that were selected, with duplicates eliminated.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java Fri Oct 4 23:57:51 2013
@@ -62,7 +62,7 @@ public interface VFSBrowserSheetListener
/**
* 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 @@ public interface VFSBrowserSheetListener
/**
* Called when a file browser sheet's mode has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousMode
*/
@@ -78,7 +78,7 @@ public interface VFSBrowserSheetListener
/**
* Called when a file browser sheet's root directory has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousRootDirectory
*/
@@ -87,7 +87,7 @@ public interface VFSBrowserSheetListener
/**
* Called when a file browser sheet's selection state has been reset.
- *
+ *
* @param fileBrowserSheet
* @param previousSelectedFiles
*/
@@ -96,7 +96,7 @@ public interface VFSBrowserSheetListener
/**
* Called when a file browser sheet's disabled file filter has changed.
- *
+ *
* @param fileBrowserSheet
* @param previousDisabledFileFilter
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java Fri Oct 4 23:57:51 2013
@@ -151,7 +151,7 @@ public abstract class Viewport extends C
* 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 @@ public abstract class Viewport extends C
* 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 @@ public abstract class Viewport extends C
* 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 @@ public abstract class Viewport extends C
* 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
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java Fri Oct 4 23:57:51 2013
@@ -42,7 +42,7 @@ public interface ViewportListener {
/**
* Called when a viewport's scroll top has changed.
- *
+ *
* @param scrollPane
* @param previousScrollTop
*/
@@ -50,7 +50,7 @@ public interface ViewportListener {
/**
* Called when a viewport's scroll left has changed.
- *
+ *
* @param scrollPane
* @param previousScrollLeft
*/
@@ -58,7 +58,7 @@ public interface ViewportListener {
/**
* Called when a viewport's view component has changed.
- *
+ *
* @param scrollPane
* @param previousView
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java Fri Oct 4 23:57:51 2013
@@ -35,7 +35,7 @@ public interface Visual {
/**
* 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 @@ public interface Visual {
/**
* Paints the visual.
- *
+ *
* @param graphics The graphics context in which to paint the visual.
*/
public void paint(Graphics2D graphics);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Window.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Window.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Window.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Window.java Fri Oct 4 23:57:51 2013
@@ -544,7 +544,7 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* Returns this window's opening state.
- *
+ *
* @return <tt>true</tt> if the window is opening; <tt>false</tt>,
* otherwise.
*/
@@ -584,7 +584,7 @@ public class Window extends Container {
/**
* Opens the window.
- *
+ *
* @param display
*/
public final void open(Display display) {
@@ -593,7 +593,7 @@ public class Window extends Container {
/**
* Opens the window.
- *
+ *
* @param ownerArgument The window's owner. The window is opened on the
* owner's display.
*/
@@ -608,7 +608,7 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* Returns this window's closing state.
- *
+ *
* @return <tt>true</tt> if the window is closing; <tt>false</tt>,
* otherwise.
*/
@@ -747,7 +747,7 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
* 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 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* Called to notify a window that its active state has changed.
- *
+ *
* @param active
* @param obverseWindow
*/
@@ -882,7 +882,7 @@ public class Window extends Container {
/**
* 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 @@ public class Window extends Container {
/**
* 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.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java Fri Oct 4 23:57:51 2013
@@ -24,14 +24,14 @@ import org.apache.pivot.collections.Sequ
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 @@ public interface WindowActionMappingList
/**
* Called when an action mapping's keystroke has changed.
- *
+ *
* @param actionMapping
* @param previousKeyStroke
*/
@@ -50,7 +50,7 @@ public interface WindowActionMappingList
/**
* Called when an action mapping's action has changed.
- *
+ *
* @param actionMapping
* @param previousAction
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java Fri Oct 4 23:57:51 2013
@@ -22,7 +22,7 @@ package org.apache.pivot.wtk;
public interface WindowClassListener {
/**
* Called when the active window has changed.
- *
+ *
* @param previousActiveWindow
*/
public void activeWindowChanged(Window previousActiveWindow);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java Fri Oct 4 23:57:51 2013
@@ -65,7 +65,7 @@ public interface WindowListener {
/**
* Called when a window's title has changed.
- *
+ *
* @param window
* @param previousTitle
*/
@@ -73,7 +73,7 @@ public interface WindowListener {
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param addedIcon
*/
@@ -81,7 +81,7 @@ public interface WindowListener {
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param addedIcon
*/
@@ -89,7 +89,7 @@ public interface WindowListener {
/**
* Called when a window's icon has changed.
- *
+ *
* @param window
* @param index
* @param removed
@@ -98,7 +98,7 @@ public interface WindowListener {
/**
* Called when a window's content component has changed.
- *
+ *
* @param window
* @param previousContent
*/
@@ -106,7 +106,7 @@ public interface WindowListener {
/**
* Called when a window's active state has changed.
- *
+ *
* @param window
* @param obverseWindow
*/
@@ -114,7 +114,7 @@ public interface WindowListener {
/**
* Called when a window's maximized state has changed.
- *
+ *
* @param window
*/
public void maximizedChanged(Window window);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java Fri Oct 4 23:57:51 2013
@@ -59,28 +59,28 @@ public interface WindowStateListener {
/**
* 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 @@ public interface WindowStateListener {
/**
* Called when a window open event has been vetoed.
- *
+ *
* @param window
* @param reason
*/
@@ -96,7 +96,7 @@ public interface WindowStateListener {
/**
* Called when a window has closed.
- *
+ *
* @param window
* @param display
* @param owner
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ButtonData.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ButtonData.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ButtonData.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ButtonData.java Fri Oct 4 23:57:51 2013
@@ -57,7 +57,7 @@ public class ButtonData {
* 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 @@ public class ButtonData {
/**
* 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)
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java Fri Oct 4 23:57:51 2013
@@ -84,7 +84,7 @@ public class CalendarDateSpinnerData imp
/**
* 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 @@ public class CalendarDateSpinnerData imp
/**
* Gets the calendar date at the specified index.
- *
+ *
* @param index The index of the calendar date to retrieve.
*/
@Override
@@ -208,7 +208,7 @@ public class CalendarDateSpinnerData imp
/**
* Gets the number of entries in this list.
- *
+ *
* @return The number of calendar dates in this list.
*/
@Override
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListItem.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListItem.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListItem.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListItem.java Fri Oct 4 23:57:51 2013
@@ -57,7 +57,7 @@ public class ListItem {
* 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 @@ public class ListItem {
/**
* 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)
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListViewItemRenderer.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListViewItemRenderer.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListViewItemRenderer.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListViewItemRenderer.java Fri Oct 4 23:57:51 2013
@@ -156,7 +156,7 @@ public class ListViewItemRenderer extend
/**
* 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.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/MenuItemData.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/MenuItemData.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/MenuItemData.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/MenuItemData.java Fri Oct 4 23:57:51 2013
@@ -34,7 +34,7 @@ public class MenuItemData extends Button
/**
* Constructor.
- *
+ *
* @param icon The icon to display in the menu item.
*/
public MenuItemData(Image icon) {
@@ -43,7 +43,7 @@ public class MenuItemData extends Button
/**
* Constructor.
- *
+ *
* @param text The text to display in the menu item.
*/
public MenuItemData(String text) {
@@ -52,7 +52,7 @@ public class MenuItemData extends Button
/**
* 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 @@ public class MenuItemData extends Button
/**
* 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
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TableViewHeaderData.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TableViewHeaderData.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TableViewHeaderData.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TableViewHeaderData.java Fri Oct 4 23:57:51 2013
@@ -56,7 +56,7 @@ public class TableViewHeaderData {
* 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 @@ public class TableViewHeaderData {
/**
* 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)
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TableViewRowEditor.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TableViewRowEditor.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TableViewRowEditor.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TableViewRowEditor.java Fri Oct 4 23:57:51 2013
@@ -161,7 +161,7 @@ public class TableViewRowEditor extends
* 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 @@ public class TableViewRowEditor extends
/**
* 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 @@ public class TableViewRowEditor extends
/**
* 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 @@ public class TableViewRowEditor extends
/**
* Returns the edit effect duration.
- *
+ *
* @return The effect duration in milliseconds.
*/
public int getEditEffectDuration() {
@@ -321,7 +321,7 @@ public class TableViewRowEditor extends
/**
* Sets the edit effect duration.
- *
+ *
* @param effectDuration The effect duration in milliseconds.
*/
public void setEditEffectDuration(int effectDuration) {
@@ -330,7 +330,7 @@ public class TableViewRowEditor extends
/**
* Returns the edit effect rate.
- *
+ *
* @return The effect rate.
*/
public int getEditEffectRate() {
@@ -339,7 +339,7 @@ public class TableViewRowEditor extends
/**
* Sets the edit effect rate.
- *
+ *
* @param effectRate The effect rate.
*/
public void setEditEffectRate(int effectRate) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeBranch.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeBranch.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeBranch.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeBranch.java Fri Oct 4 23:57:51 2013
@@ -72,7 +72,7 @@ public class TreeBranch extends TreeNode
* 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 @@ public class TreeBranch extends TreeNode
/**
* 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)
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeNode.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeNode.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeNode.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeNode.java Fri Oct 4 23:57:51 2013
@@ -68,7 +68,7 @@ public class TreeNode {
* 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 @@ public class TreeNode {
/**
* 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)
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeViewNodeRenderer.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeViewNodeRenderer.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeViewNodeRenderer.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/content/TreeViewNodeRenderer.java Fri Oct 4 23:57:51 2013
@@ -182,7 +182,7 @@ public class TreeViewNodeRenderer extend
/**
* 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.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java Fri Oct 4 23:57:51 2013
@@ -50,7 +50,7 @@ public class BlurDecorator implements De
/**
* Creates a <tt>BlurDecorator</tt> with the default blur magnitude.
- *
+ *
* @see #BlurDecorator(int)
*/
public BlurDecorator() {
@@ -59,7 +59,7 @@ public class BlurDecorator implements De
/**
* Creates a <tt>BlurDecorator</tt> with the specified blur magnitude.
- *
+ *
* @param blurMagnitude The intensity of the blur.
*/
public BlurDecorator(int blurMagnitude) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Decorator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Decorator.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Decorator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Decorator.java Fri Oct 4 23:57:51 2013
@@ -49,7 +49,7 @@ public interface Decorator {
* 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 @@ public interface Decorator {
/**
* Returns the bounding area of the decorator.
- *
+ *
* @param component
* @return The decorator's bounds, relative to the component's origin.
*/
@@ -76,7 +76,7 @@ public interface Decorator {
/**
* Returns the transformation the decorator applies to the component's
* coordinate space.
- *
+ *
* @return The decorator's transform.
*/
public AffineTransform getTransform(Component component);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/DropShadowDecorator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/DropShadowDecorator.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/DropShadowDecorator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/DropShadowDecorator.java Fri Oct 4 23:57:51 2013
@@ -55,7 +55,7 @@ public class DropShadowDecorator impleme
/**
* Returns the color used to draw the shadow.
- *
+ *
* @return The color used to draw the shadow.
*/
public Color getShadowColor() {
@@ -64,7 +64,7 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
/**
* Returns the opacity used to draw the shadow.
- *
+ *
* @return The color used to draw the shadow.
*/
public float getShadowOpacity() {
@@ -97,7 +97,7 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
/**
* 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 @@ public class DropShadowDecorator impleme
* 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.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java Fri Oct 4 23:57:51 2013
@@ -37,7 +37,7 @@ public class RotationDecorator implement
/**
* Creates a new rotation decorator with the specified theta value.
- *
+ *
* @param theta The rotation angle, in radians.
*/
public RotationDecorator(double theta) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java Fri Oct 4 23:57:51 2013
@@ -54,7 +54,7 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
/**
* 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 @@ public class ScaleDecorator implements D
* 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 @@ public class ScaleDecorator implements D
* 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 @@ public class ScaleDecorator implements D
* 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 @@ public class ScaleDecorator implements D
* 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 @@ public class ScaleDecorator implements D
* 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 @@ public class ScaleDecorator implements D
* 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
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java Fri Oct 4 23:57:51 2013
@@ -48,7 +48,7 @@ public class ShadeDecorator implements D
/**
* 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 @@ public class ShadeDecorator implements D
/**
* 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 @@ public class ShadeDecorator implements D
/**
* 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 @@ public class ShadeDecorator implements D
/**
* Sets the color of the decorator
- *
+ *
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Transition.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Transition.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Transition.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Transition.java Fri Oct 4 23:57:51 2013
@@ -60,7 +60,7 @@ public abstract class Transition {
/**
* 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 @@ public abstract class Transition {
/**
* 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 @@ public abstract class Transition {
/**
* 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 @@ public abstract class Transition {
/**
* Returns the transition duration.
- *
+ *
* @return The duration of the transition, in milliseconds.
* @see #setDuration(int)
*/
@@ -114,7 +114,7 @@ public abstract class Transition {
/**
* 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 @@ public abstract class Transition {
/**
* Returns the transition rate.
- *
+ *
* @return The rate of the transition, in frames per second.
* @see #setRate(int)
*/
@@ -142,7 +142,7 @@ public abstract class Transition {
/**
* 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 @@ public abstract class Transition {
/**
* Returns the transition interval, the number of milliseconds between
* updates.
- *
+ *
* @return The transition interval, in milliseconds.
*/
public int getInterval() {
@@ -169,7 +169,7 @@ public abstract class Transition {
/**
* Returns the time at which the transition was started.
- *
+ *
* @return The transition's start time.
*/
public long getStartTime() {
@@ -178,7 +178,7 @@ public abstract class Transition {
/**
* Returns the last time the transition was updated.
- *
+ *
* @return The most recent update time.
*/
public long getCurrentTime() {
@@ -187,7 +187,7 @@ public abstract class Transition {
/**
* 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 @@ public abstract class Transition {
/**
* 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 @@ public abstract class Transition {
/**
* 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 @@ public abstract class Transition {
/**
* Starts the transition with no listener.
- *
+ *
* @see #start(TransitionListener)
*/
public final void start() {
@@ -246,7 +246,7 @@ public abstract class Transition {
* 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 @@ public abstract class Transition {
/**
* Tests whether the transition is reversed.
- *
+ *
* @return <tt>true</tt> if the transition is reversed; <tt>false</tt>,
* otherwise.
*/
@@ -313,7 +313,7 @@ public abstract class Transition {
/**
* Sets the transition's reversed flag.
- *
+ *
* @param reversed
*/
public void setReversed(boolean reversed) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java?rev=1529353&r1=1529352&r2=1529353&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java Fri Oct 4 23:57:51 2013
@@ -22,7 +22,7 @@ package org.apache.pivot.wtk.effects;
public interface TransitionListener {
/**
* Called when a transition has completed.
- *
+ *
* @param transition
*/
public void transitionCompleted(Transition transition);