Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2285)

Unified Diff: sky/sdk/lib/base/README.md

Issue 1211573003: Fill out some more documentation about building RenderBox subclasses. (Closed) Base URL: https://github.com/domokit/mojo.git@master
Patch Set: Created 5 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | sky/sdk/lib/base/node.dart » ('j') | sky/sdk/lib/rendering/README.md » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sky/sdk/lib/base/README.md
diff --git a/sky/sdk/lib/base/README.md b/sky/sdk/lib/base/README.md
index 43cd23fb3afbe638522e8e461c6a4f22307a8ac2..7c533c105fc7c8746025bae55184fc6bade384f7 100644
--- a/sky/sdk/lib/base/README.md
+++ b/sky/sdk/lib/base/README.md
@@ -1,6 +1,44 @@
Sky Base
========
+AbstractNode
+------------
+
+The [node.dart](node.dart) file defines a class, `AbstractNode`, which
+can be used to build mutable trees.
+
+* When a subclass is changing the parent of a child, it should
+ call either parent.adoptChild(child) or parent.dropChild(child)
+ as appropriate. Subclasses should expose an API for
+ manipulating the tree if you want to (e.g. a setter for a
+ 'child' property, or an 'add()' method to manipulate a list).
+
+* You can see the current parent by querying 'parent'.
+
+* You can see the current attachment state by querying
+ 'attached'. The root of any tree that is to be considered
+ attached should be manually attached by calling 'attach()'.
+ Other than that, don't call 'attach()' or 'detach()'. This is
+ all managed automatically assuming you call the 'adoptChild()'
+ and 'dropChild()' methods appropriately.
+
+* Subclasses that have children must override 'attach()' and
+ 'detach()' as described below.
+
+* Nodes always have a 'depth' greater than their ancestors'.
+ There's no guarantee regarding depth between siblings. The
+ depth of a node is used to ensure that nodes are processed in
+ depth order. The 'depth' of a child can be more than one
+ greater than the 'depth' of the parent, because the 'depth'
+ values are never decreased: all that matters is that it's
+ greater than the parent. Consider a tree with a root node A, a
+ child B, and a grandchild C. Initially, A will have 'depth' 0,
+ B 'depth' 1, and C 'depth' 2. If C is moved to be a child of A,
+ sibling of B, then the numbers won't change. C's 'depth' will
+ still be 2. This is all managed automatically assuming you call
+ 'adoptChild()' and 'dropChild()' appropriately.
+
+
Dependencies
------------
« no previous file with comments | « no previous file | sky/sdk/lib/base/node.dart » ('j') | sky/sdk/lib/rendering/README.md » ('J')

Powered by Google App Engine
This is Rietveld 408576698