Repository: flex-sdk Updated Branches: refs/heads/develop 99be0d340 -> 7720f4304
FLEX-20313 Applied the asdoc changes suggested by the comment made on 28/Jan/12 00:20. Project: http://git-wip-us.apache.org/repos/asf/flex-sdk/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-sdk/commit/7720f430 Tree: http://git-wip-us.apache.org/repos/asf/flex-sdk/tree/7720f430 Diff: http://git-wip-us.apache.org/repos/asf/flex-sdk/diff/7720f430 Branch: refs/heads/develop Commit: 7720f43049189021bcc16baaefa7dd15b82db669 Parents: 99be0d3 Author: Mihai Chira <[email protected]> Authored: Thu Feb 11 13:33:27 2016 +0100 Committer: Mihai Chira <[email protected]> Committed: Thu Feb 11 13:33:27 2016 +0100 ---------------------------------------------------------------------- .../src/mx/collections/CursorBookmark.as | 13 +++++----- .../src/mx/collections/ListCollectionView.as | 14 ++++++----- .../mx/collections/ModifiedCollectionView.as | 26 +++++++++++--------- 3 files changed, 28 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/7720f430/frameworks/projects/framework/src/mx/collections/CursorBookmark.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/framework/src/mx/collections/CursorBookmark.as b/frameworks/projects/framework/src/mx/collections/CursorBookmark.as index f14681e..920150b 100644 --- a/frameworks/projects/framework/src/mx/collections/CursorBookmark.as +++ b/frameworks/projects/framework/src/mx/collections/CursorBookmark.as @@ -144,13 +144,12 @@ public class CursorBookmark //-------------------------------------------------------------------------- /** - * Gets the approximate index of the item represented by this bookmark - * in its view. If the item has been paged out, this method could throw an - * ItemPendingError. - * - * @return The index of the item. If the item is not in the current view, this method returns - * -1. This method also returns -1 if index-based location is not possible. - * + * Classes that extend CursorBookmark override this method to + * return the approximate index of the item represented by this + * bookmark in its view. + * + * @return -1 + * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/7720f430/frameworks/projects/framework/src/mx/collections/ListCollectionView.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/framework/src/mx/collections/ListCollectionView.as b/frameworks/projects/framework/src/mx/collections/ListCollectionView.as index 301796b..cdc4e4b 100644 --- a/frameworks/projects/framework/src/mx/collections/ListCollectionView.as +++ b/frameworks/projects/framework/src/mx/collections/ListCollectionView.as @@ -2751,12 +2751,14 @@ class ListCollectionViewBookmark extends CursorBookmark } /** - * Get the approximate index of the item represented by this bookmark - * in its view. If the item has been paged out this may throw an - * ItemPendingError. If the item is not in the current view -1 will be - * returned. This method may also return -1 if index-based location is not - * possible. - * + * Gets the approximate index of the item represented by this bookmark + * in its view. If the item has been paged out, this method could throw an + * ItemPendingError. + * + * @return The index of the item. If the item is not in the current view, + * this method returns -1. This method also returns -1 if index-based location + * retrieval is not possible. + * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/7720f430/frameworks/projects/framework/src/mx/collections/ModifiedCollectionView.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/framework/src/mx/collections/ModifiedCollectionView.as b/frameworks/projects/framework/src/mx/collections/ModifiedCollectionView.as index c8d98de..d6bc2c8 100644 --- a/frameworks/projects/framework/src/mx/collections/ModifiedCollectionView.as +++ b/frameworks/projects/framework/src/mx/collections/ModifiedCollectionView.as @@ -1647,18 +1647,20 @@ class ModifiedCollectionViewBookmark extends CursorBookmark this.internalIndex = internalIndex; } - /** - * Get the approximate index of the item represented by this bookmark - * in its view. If the item has been paged out this may throw an - * ItemPendingError. If the item is not in the current view -1 will be - * returned. This method may also return -1 if index-based location is not - * possible. - * - * @langversion 3.0 - * @playerversion Flash 9 - * @playerversion AIR 1.1 - * @productversion Flex 3 - */ + /** + * Gets the approximate index of the item represented by this bookmark + * in its view. If the item has been paged out, this method could throw an + * ItemPendingError. + * + * @return The index of the item. If the item is not in the current view, + * this method returns -1. This method also returns -1 if index-based location + * retrieval is not possible. + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ override public function getViewIndex():int { return view.getBookmarkIndex(this);
