diff --git a/appledoc/Blocks/ASDisplayNodeLayerBlock.html b/appledoc/Blocks/ASDisplayNodeLayerBlock.html new file mode 100644 index 00000000..03ebb870 --- /dev/null +++ b/appledoc/Blocks/ASDisplayNodeLayerBlock.html @@ -0,0 +1,128 @@ + + + + + + ASDisplayNodeLayerBlock Block Reference + + + + + + +
+
+ +

+ AsyncDisplayKit +

+ +

+ Facebook +

+ +
+
+ + + +
+
+
+
+

ASDisplayNodeLayerBlock Block Reference

+ + +
+ + + + +
Declared inASDisplayNode.h
+ + + + + + + + + + +

Block Definition

+

ASDisplayNodeLayerBlock

+ + +
+

CALayer creation block. Used to create the backing layer of a new display node.

+
+ + + +typedef CALayer* (^ASDisplayNodeLayerBlock) () + + + + + + + + + + + +
+

Declared In

+ ASDisplayNode.h
+
+ + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/appledoc/Blocks/ASDisplayNodeViewBlock.html b/appledoc/Blocks/ASDisplayNodeViewBlock.html new file mode 100644 index 00000000..1f123979 --- /dev/null +++ b/appledoc/Blocks/ASDisplayNodeViewBlock.html @@ -0,0 +1,128 @@ + + + + + + ASDisplayNodeViewBlock Block Reference + + + + + + +
+
+ +

+ AsyncDisplayKit +

+ +

+ Facebook +

+ +
+
+ + + +
+
+
+
+

ASDisplayNodeViewBlock Block Reference

+ + +
+ + + + +
Declared inASDisplayNode.h
+ + + + + + + + + + +

Block Definition

+

ASDisplayNodeViewBlock

+ + +
+

UIView creation block. Used to create the backing view of a new display node.

+
+ + + +typedef UIView* (^ASDisplayNodeViewBlock) () + + + + + + + + + + + +
+

Declared In

+ ASDisplayNode.h
+
+ + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/appledoc/Blocks/asimagenode_modification_block_t.html b/appledoc/Blocks/asimagenode_modification_block_t.html index 523a28a8..37af25f6 100644 --- a/appledoc/Blocks/asimagenode_modification_block_t.html +++ b/appledoc/Blocks/asimagenode_modification_block_t.html @@ -1,220 +1,128 @@ - + - - - asimagenode_modification_block_t Block Reference - - - - - - -
-
-

AsyncDisplayKit

- Facebook -
+ + + + asimagenode_modification_block_t Block Reference + + + + + + +
+
- - -
- + + +
+
+
+
+

asimagenode_modification_block_t Block Reference

- - - - -
-
- - - -
- - + +
Declared inASImageNode.hDeclared inASImageNode.h
+ - - - - + + - - - -

Block Definition

-

asimagenode_modification_block_t

+ + +

Block Definition

+

asimagenode_modification_block_t

-

Image modification block. Use to transform an image before display.

+

Image modification block. Use to transform an image before display.

typedef UIImage* (^asimagenode_modification_block_t) (UIImage *image) + + + + + + + + + + + +
+

Declared In

+ ASImageNode.h
+
+ + + +
- - - - - - - - - - -
-

Declared In

- ASImageNode.h
-
- - - - -
- - +
-
- - + + + + + \ No newline at end of file diff --git a/appledoc/Categories/ASControlNode+Subclassing.html b/appledoc/Categories/ASControlNode+Subclassing.html index 5ce7eab2..7c0594ea 100644 --- a/appledoc/Categories/ASControlNode+Subclassing.html +++ b/appledoc/Categories/ASControlNode+Subclassing.html @@ -1,136 +1,107 @@ - + - - - ASControlNode(Subclassing) Category Reference - - - - - - -
- + + + + ASControlNode(Subclassing) Category Reference + + + + + + +
+
- - -
- + + +
+
+
+
+

ASControlNode(Subclassing) Category Reference

- - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + +
    Declared inASControlNode+Subclasses.hDeclared inASControlNode+Subclasses.h
    - +
    @@ -143,494 +114,384 @@ overridden by custom nodes that subclass ASControlNode.

    - + - - - - - -
    - -

    Properties

    - -
    - -

    highlighted

    - - - -
    -

    Settable version of highlighted property.

    -
    - - - -
    @property (nonatomic, readwrite, assign, getter=isHighlighted) BOOL highlighted
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode+Subclasses.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    beginTrackingWithTouch:withEvent:

    - - - -
    -

    Sent to the control when tracking begins.

    -
    - - - -
    - (BOOL)beginTrackingWithTouch:(id)touch withEvent:(id)touchEvent
    - - - -
    -

    Parameters

    - -
    -
    touch
    -

    The touch on the receiving control.

    -
    - -
    -
    touchEvent
    -

    An event object encapsulating the information specific to the user event.

    -
    - -
    - - - -
    -

    Return Value

    -

    YES if the receiver should respond continuously (respond when touch is dragged); NO otherwise.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode+Subclasses.h
    -
    - - -
    - -
    - -

    cancelTrackingWithEvent:

    - - - -
    -

    Sent to the control when tracking should be cancelled.

    -
    - - - -
    - (void)cancelTrackingWithEvent:(id)touchEvent
    - - - -
    -

    Parameters

    - -
    -
    touchEvent
    -

    An event object encapsulating the information specific to the user event. This parameter may be nil, indicating that the cancelation was caused by something other than an event, such as the display node being removed from its supernode.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode+Subclasses.h
    -
    - - -
    - -
    - -

    continueTrackingWithTouch:withEvent:

    - - - -
    -

    Sent continuously to the control as it tracks a touch within the control’s bounds.

    -
    - - - -
    - (BOOL)continueTrackingWithTouch:(id)touch withEvent:(id)touchEvent
    - - - -
    -

    Parameters

    - -
    -
    touch
    -

    The touch on the receiving control.

    -
    - -
    -
    touchEvent
    -

    An event object encapsulating the information specific to the user event.

    -
    - -
    - - - -
    -

    Return Value

    -

    YES if touch tracking should continue; NO otherwise.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode+Subclasses.h
    -
    - - -
    - -
    - -

    endTrackingWithTouch:withEvent:

    - - - -
    -

    Sent to the control when the last touch completely ends, telling it to stop tracking.

    -
    - - - -
    - (void)endTrackingWithTouch:(id)touch withEvent:(id)touchEvent
    - - - -
    -

    Parameters

    - -
    -
    touch
    -

    The touch that ended.

    -
    - -
    -
    touchEvent
    -

    An event object encapsulating the information specific to the user event.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode+Subclasses.h
    -
    - - -
    - -
    +
    +
    -

    sendActionsForControlEvents:withEvent:

    - - - -
    -

    Sends action messages for the given control events.

    -
    - - +

    – sendActionsForControlEvents:withEvent: +

    -
    - (void)sendActionsForControlEvents:(id)controlEvents withEvent:(id)touchEvent
    +
    +
    - - -
    -

    Parameters

    - -
    -
    controlEvents
    -

    A bitmask whose set flags specify the control events for which action messages are sent. See “Control Events” in ASControlNode.h for bitmask constants.

    -
    - -
    -
    touchEvent
    -

    An event object encapsulating the information specific to the user event.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    ASControlNode implements this method to send all action messages associated with controlEvents. The list of targets is constructed from prior invocations of addTarget:action:forControlEvents:.

    -
    - - - - - - - -
    -

    Declared In

    - ASControlNode+Subclasses.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    Sends action messages for the given control events.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Categories/ASDisplayNode+Debugging.html b/appledoc/Categories/ASDisplayNode+Debugging.html index 2d73314a..8f0d5440 100644 --- a/appledoc/Categories/ASDisplayNode+Debugging.html +++ b/appledoc/Categories/ASDisplayNode+Debugging.html @@ -1,109 +1,93 @@ - + - - - ASDisplayNode(Debugging) Category Reference - - - - - - -
    - + + + + ASDisplayNode(Debugging) Category Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASDisplayNode(Debugging) Category Reference

    - - -
  • Tasks
      - -
  • - - - - - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + +
    Declared inASDisplayNode.hDeclared inASDisplayNode.h
    - +
    @@ -113,198 +97,89 @@
    - +
    -

    Tasks

    - + - - -
    - - - - - - - - - -
    - -

    Instance Methods

    - -
    +
    +
    -

    displayNodeRecursiveDescription

    - - - -
    -

    Return a description of the node hierarchy.

    -
    - - +

    – displayNodeRecursiveDescription +

    -
    - (NSString *)displayNodeRecursiveDescription
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    For debugging: (lldb) po [node displayNodeRecursiveDescription]

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    Return a description of the node hierarchy.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Categories/ASDisplayNode+Subclassing.html b/appledoc/Categories/ASDisplayNode+Subclassing.html index 3907a6ae..eb4682cc 100644 --- a/appledoc/Categories/ASDisplayNode+Subclassing.html +++ b/appledoc/Categories/ASDisplayNode+Subclassing.html @@ -1,255 +1,165 @@ - + - - - ASDisplayNode(Subclassing) Category Reference - - - - - - -
    - + + + + ASDisplayNode(Subclassing) Category Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASDisplayNode(Subclassing) Category Reference

    - - -
  • Tasks
  • - - - - - -
  • Properties
  • - - - -
  • Class Methods
  • - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + +
    Declared inASDisplayNode+Subclasses.hDeclared inASDisplayNode+Subclasses.h
    - +
    @@ -275,1758 +185,1940 @@ variables.

    - +
    -

    Tasks

    - + -

    View Configuration

    +

    View Configuration

    - - +
    +
    + +

    + viewClass +

    + +
    +
    + +
    + + +
    +

    The view class to use when creating a new display node instance. Defaults to _ASDisplayView.

    +
    + + + +
    + (Class)viewClass
    + + + + + +
    +

    Return Value

    +

    The view class to use when creating a new display node instance. Defaults to _ASDisplayView.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    +
    + -

    Properties

    +

    Properties

    - - - - -

    View Lifecycle

    - - - - - -

    Layout

    - - - - - -

    Sizing

    - - - - - -

    Drawing

    - - - - - -

    Touch handling

    - - - - - -

    Managing Gesture Recognizers

    - - - - - -

    Hit Testing

    - - - - - -

    Observing node-related changes

    - - - - - -

    Placeholders

    - - - - - -

    Description

    - - - -
    - - - - - -
    - -

    Properties

    - -
    +
    +
    -

    contentsScaleForDisplay

    - - - -
    -

    The scale factor to apply to the rendering.

    -
    - - +

      contentsScaleForDisplay +

    -
    @property (nonatomic, assign, readonly) CGFloat contentsScaleForDisplay
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    Use setNeedsDisplayAtScale: to set a value and then after display, the display node will set the layer’s +

    + + +
    +

    The scale factor to apply to the rendering.

    +
    + + + +
    @property (nonatomic, assign, readonly) CGFloat contentsScaleForDisplay
    + + + + + + + + + +
    +

    Discussion

    +

    Use setNeedsDisplayAtScale: to set a value and then after display, the display node will set the layer’s contentsScale. This is to prevent jumps when re-rasterizing at a different contentsScale. Read this property if you need to know the future contentsScale of your layer, eg in drawParameters.

    -
    - - - - - -
    -

    See Also

    -
      +
    -
  • - setNeedsDisplayAtScale:

  • + - + + +
    +

    See Also

    + +
    + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    +
    -

    inHierarchy

    - - - -
    -

    Whether the view or layer of this display node is currently in a window

    -
    - - +

      inHierarchy +

    -
    @property (nonatomic, readonly, assign, getter=isInHierarchy) BOOL inHierarchy
    +
    +
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - +
    + + +
    +

    Whether the view or layer of this display node is currently in a window

    +
    + + + +
    @property (nonatomic, readonly, assign, getter=isInHierarchy) BOOL inHierarchy
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

      calculatedLayout +

    + +
    +
    + +
    + + +
    +

    Return the calculated layout.

    +
    + + + +
    @property (nonatomic, readonly, assign) ASLayout *calculatedLayout
    + + + + + +
    +

    Return Value

    +

    Layout that wraps calculated size returned by -calculateSizeThatFits: (in manual layout mode), +or layout already calculated from layout spec returned by -layoutSpecThatFits: (in automatic layout mode).

    +
    + + + + + +
    +

    Discussion

    +

    For node subclasses that implement manual layout (e.g., they have a custom -layout method), +calculatedLayout may be accessed on subnodes to retrieved cached information about their size. +This allows -layout to be very fast, saving time on the main thread. +Note: .calculatedLayout will only be set for nodes that have had -measure: called on them. +For manual layout, make sure you call -measure: in your implementation of -calculateSizeThatFits:.

    + +

    For node subclasses that use automatic layout (e.g., they implement -layoutSpecThatFits:), +it is typically not necessary to use .calculatedLayout at any point. For these nodes, +the ASLayoutSpec implementation will automatically call -measureWithSizeRange: on all of the subnodes, +and the ASDisplayNode base class implementation of -layout will automatically make use of .calculatedLayout on the subnodes.

    Warning: Subclasses must not override this; it returns the last cached layout and is never expensive.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    -
    - - - -
    - -

    Class Methods

    - -
    - -

    displayWithParameters:isCancelled:

    - - - -
    -

    @summary Delegate override to provide new layer contents as a UIImage.

    -
    - - -
    + (UIImage *)displayWithParameters:(id)parameters isCancelled:(id)isCancelledBlock
    + +

    View Lifecycle

    - - -
    -

    Parameters

    - -
    -
    parameters
    -

    An object describing all of the properties you need to draw. Return this from --drawParametersForAsyncLayer:

    -
    - -
    -
    isCancelledBlock
    -

    Execute this block to check whether the current drawing operation has been cancelled to avoid -unnecessary work. A return value of YES means cancel drawing and return.

    -
    - -
    - - - -
    -

    Return Value

    -

    A UIImage with contents that are ready to display on the main thread. Make sure that the image is already -decoded before returning it here.

    -
    - - - - - -
    -

    Discussion

    -

    Note: Called on the display queue and/or main queue (MUST BE THREAD SAFE)

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    drawRect:withParameters:isCancelled:isRasterizing:

    - - - -
    -

    @summary Delegate method to draw layer contents into a CGBitmapContext. The current UIGraphics context will be set -to an appropriate context.

    -
    - - - -
    + (void)drawRect:(id)bounds withParameters:(id)parameters isCancelled:(id)isCancelledBlock isRasterizing:(id)isRasterizing
    - - - -
    -

    Parameters

    - -
    -
    bounds
    -

    Region to draw in.

    -
    - -
    -
    parameters
    -

    An object describing all of the properties you need to draw. Return this from --drawParametersForAsyncLayer:

    -
    - -
    -
    isCancelledBlock
    -

    Execute this block to check whether the current drawing operation has been cancelled to avoid -unnecessary work. A return value of YES means cancel drawing and return.

    -
    - -
    -
    isRasterizing
    -

    YES if the layer is being rasterized into another layer, in which case drawRect: probably wants -to avoid doing things like filling its bounds with a zero-alpha color to clear the backing store.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Note: Called on the display queue and/or main queue (MUST BE THREAD SAFE)

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    viewClass

    - - - -
    -

    The view class to use when creating a new display node instance. Defaults to _ASDisplayView.

    -
    - - - -
    + (Class)viewClass
    - - - - - -
    -

    Return Value

    -

    The view class to use when creating a new display node instance. Defaults to _ASDisplayView.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - - - -
    - -

    Instance Methods

    - -
    - -

    calculateSizeThatFits:

    - - - -
    -

    Return the calculated size.

    -
    - - - -
    - (CGSize)calculateSizeThatFits:(id)constrainedSize
    - - - -
    -

    Parameters

    - -
    -
    constrainedSize
    -

    The maximum size the receiver should fit in.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Subclasses that override should expect this method to be called on a non-main thread. The returned size -is cached by ASDisplayNode for quick access during -layout, via -calculatedSize. Other expensive work that needs to -be done before display can be performed here, and using ivars to cache any valuable intermediate results is -encouraged.

    Note: This method should not be called directly outside of ASDisplayNode; use -measure: or -calculatedSize instead.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    descriptionForRecursiveDescription

    - - - -
    -

    Return a description of the node

    -
    - - - -
    - (NSString *)descriptionForRecursiveDescription
    - - - - - - - - - -
    -

    Discussion

    -

    The function that gets called for each display node in -recursiveDescription

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    didExitHierarchy

    - - - -
    -

    Called after the view is removed from the window.

    -
    - - - -
    - (void)didExitHierarchy
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    +
    +
    -

    didLoad

    - - - -
    -

    Called on the main thread immediately after self.view is created.

    -
    - - +

    – didLoad +

    -
    - (void)didLoad
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    This is the best time to add gesture recognizers to the view.

    +
    + + +
    +

    Called on the main thread immediately after self.view is created.

    +
    + + + +
    - (void)didLoad
    + + + + + + + + + +
    +

    Discussion

    +

    This is the best time to add gesture recognizers to the view.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - -
    +
    -
    - -

    displayDidFinish

    - - - -
    -

    Indicates that the receiver has finished displaying.

    -
    - - -
    - (void)displayDidFinish
    + +

    Layout

    - - - - - - - - -
    -

    Discussion

    -

    Subclasses may override this method to be notified when display (asynchronous or synchronous) has -completed.

    +
    +
    + +

    – layout +

    + +
    +
    + +
    + + +
    +

    Called on the main thread by the view’s -layoutSubviews.

    +
    + + + +
    - (void)layout
    + + + + + + + + + +
    +

    Discussion

    +

    Subclasses override this method to layout all subnodes or subviews.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    displayWillStart

    - - - -
    -

    Indicates that the receiver is about to display.

    -
    - - +
    + +

    – layoutDidFinish +

    -
    - (void)displayWillStart
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    Subclasses may override this method to be notified when display (asynchronous or synchronous) is -about to begin.

    +
    + + +
    +

    Called on the main thread by the view’s -layoutSubviews, after -layout.

    +
    + + + +
    - (void)layoutDidFinish
    + + + + + + + + + +
    +

    Discussion

    +

    Gives a chance for subclasses to perform actions after the subclass and superclass have finished laying +out.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - -
    +
    -
    + + +

    Layout calculation

    + +
    +
    + +

    – calculateLayoutThatFits: +

    + +
    +
    + +
    + + +
    +

    Calculate a layout based on given size range.

    +
    + + + +
    - (ASLayout *)calculateLayoutThatFits:(ASSizeRange)constrainedSize
    + + + +
    +

    Parameters

    + + + + + + + +
    constrainedSize

    The minimum and maximum sizes the receiver should fit in.

    +
    + + + +
    +

    Return Value

    +

    An ASLayout instance defining the layout of the receiver (and its children, if the box layout model is used).

    +
    + + + + + +
    +

    Discussion

    +

    This method is called on a non-main thread. The default implementation calls either -layoutSpecThatFits: +or -calculateSizeThatFits:, whichever method is overriden. Subclasses rarely need to override this method, +override -layoutSpecThatFits: or -calculateSizeThatFits: instead.

    Note: This method should not be called directly outside of ASDisplayNode; use -measure: or -calculatedLayout instead.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – calculateSizeThatFits: +

    + +
    +
    + +
    + + +
    +

    Return the calculated size.

    +
    + + + +
    - (CGSize)calculateSizeThatFits:(CGSize)constrainedSize
    + + + +
    +

    Parameters

    + + + + + + + +
    constrainedSize

    The maximum size the receiver should fit in.

    +
    + + + + + + + +
    +

    Discussion

    +

    Subclasses that override should expect this method to be called on a non-main thread. The returned size +is wrapped in an ASLayout and cached for quick access during -layout. Other expensive work that needs to +be done before display can be performed here, and using ivars to cache any valuable intermediate results is +encouraged.

    Note: Subclasses that override are committed to manual layout. Therefore, -layout: must be overriden to layout all subnodes or subviews.

    Note: This method should not be called directly outside of ASDisplayNode; use -measure: or -calculatedLayout instead.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – layoutSpecThatFits: +

    + +
    +
    + +
    + + +
    +

    Return a layout spec that describes the layout of the receiver and its children.

    +
    + + + +
    - (ASLayoutSpec *)layoutSpecThatFits:(ASSizeRange)constrainedSize
    + + + +
    +

    Parameters

    + + + + + + + +
    constrainedSize

    The minimum and maximum sizes the receiver should fit in.

    +
    + + + + + + + +
    +

    Discussion

    +

    Subclasses that override should expect this method to be called on a non-main thread. The returned layout spec +is used to calculate an ASLayout and cached by ASDisplayNode for quick access during -layout. Other expensive work that needs to +be done before display can be performed here, and using ivars to cache any valuable intermediate results is +encouraged.

    Note: This method should not be called directly outside of ASDisplayNode; use -measure: or -calculatedLayout instead.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – invalidateCalculatedLayout +

    + +
    +
    + +
    + + +
    +

    Invalidate previously measured and cached layout.

    +
    + + + +
    - (void)invalidateCalculatedLayout
    + + + + + + + + + +
    +

    Discussion

    +

    Subclasses should call this method to invalidate the previously measured and cached layout for the display +node, when the contents of the node change in such a way as to require measuring it again.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    +
    + + + +

    Drawing

    + +
    +
    + +

    + drawRect:withParameters:isCancelled:isRasterizing: +

    + +
    +
    + +
    + + +
    +

    @summary Delegate method to draw layer contents into a CGBitmapContext. The current UIGraphics context will be set +to an appropriate context.

    +
    + + + +
    + (void)drawRect:(CGRect)bounds withParameters:(id<NSObject>)parameters isCancelled:(asdisplaynode_iscancelled_block_t)isCancelledBlock isRasterizing:(BOOL)isRasterizing
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + +
    bounds

    Region to draw in.

    parameters

    An object describing all of the properties you need to draw. Return this from +-drawParametersForAsyncLayer:

    isCancelledBlock

    Execute this block to check whether the current drawing operation has been cancelled to avoid +unnecessary work. A return value of YES means cancel drawing and return.

    isRasterizing

    YES if the layer is being rasterized into another layer, in which case drawRect: probably wants +to avoid doing things like filling its bounds with a zero-alpha color to clear the backing store.

    +
    + + + + + + + +
    +

    Discussion

    +

    Note: Called on the display queue and/or main queue (MUST BE THREAD SAFE)

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    + displayWithParameters:isCancelled: +

    + +
    +
    + +
    + + +
    +

    @summary Delegate override to provide new layer contents as a UIImage.

    +
    + + + +
    + (UIImage *)displayWithParameters:(id<NSObject>)parameters isCancelled:(asdisplaynode_iscancelled_block_t)isCancelledBlock
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    parameters

    An object describing all of the properties you need to draw. Return this from +-drawParametersForAsyncLayer:

    isCancelledBlock

    Execute this block to check whether the current drawing operation has been cancelled to avoid +unnecessary work. A return value of YES means cancel drawing and return.

    +
    + + + +
    +

    Return Value

    +

    A UIImage with contents that are ready to display on the main thread. Make sure that the image is already +decoded before returning it here.

    +
    + + + + + +
    +

    Discussion

    +

    Note: Called on the display queue and/or main queue (MUST BE THREAD SAFE)

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    -

    drawParametersForAsyncLayer:

    - - - -
    -

    Delegate override for drawParameters

    -
    - - +

    – drawParametersForAsyncLayer: +

    -
    - (NSObject *)drawParametersForAsyncLayer:(id)layer
    +
    +
    - - -
    -

    Parameters

    - -
    -
    layer
    -

    The layer that will be drawn into.

    -
    - +
    + + +
    +

    Delegate override for drawParameters

    +
    + + + +
    - (NSObject *)drawParametersForAsyncLayer:(_ASDisplayLayer *)layer
    + + + +
    +

    Parameters

    + + + + + + + +
    layer

    The layer that will be drawn into.

    +
    + + + + + + + +
    +

    Discussion

    +

    Note: Called on the main thread only

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    - - - - - - - -
    -

    Discussion

    -

    Note: Called on the main thread only

    +
    + +

    – displayWillStart +

    + +
    +
    + +
    + + +
    +

    Indicates that the receiver is about to display.

    +
    + + + +
    - (void)displayWillStart
    + + + + + + + + + +
    +

    Discussion

    +

    Subclasses may override this method to be notified when display (asynchronous or synchronous) is +about to begin.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – displayDidFinish +

    + +
    +
    + +
    + + +
    +

    Indicates that the receiver has finished displaying.

    +
    + + + +
    - (void)displayDidFinish
    + + + + + + + + + +
    +

    Discussion

    +

    Subclasses may override this method to be notified when display (asynchronous or synchronous) has +completed.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – fetchData +

    + +
    +
    + +
    + + +
    +

    Indicates that the node should fetch any external data, such as images.

    +
    + + + +
    - (void)fetchData
    + + + + + + + + + +
    +

    Discussion

    +

    Subclasses may override this method to be notified when they should begin to fetch data. Fetching +should be done asynchronously. The node is also responsible for managing the memory of any data. +The data may be remote and accessed via the network, but could also be a local database query.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – subnodeDisplayWillStart: +

    + +
    +
    + +
    + + +
    +

    Indicates that the receiver is about to display its subnodes. This method is not called if there are no +subnodes present.

    +
    + + + +
    - (void)subnodeDisplayWillStart:(ASDisplayNode *)subnode
    + + + +
    +

    Parameters

    + + + + + + + +
    subnode

    The subnode of which display is about to begin.

    +
    + + + + + + + +
    +

    Discussion

    +

    Subclasses may override this method to be notified when subnode display (asynchronous or synchronous) is +about to begin.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – subnodeDisplayDidFinish: +

    + +
    +
    + +
    + + +
    +

    Indicates that the receiver is finished displaying its subnodes. This method is not called if there are +no subnodes present.

    +
    + + + +
    - (void)subnodeDisplayDidFinish:(ASDisplayNode *)subnode
    + + + +
    +

    Parameters

    + + + + + + + +
    subnode

    The subnode of which display is about to completed.

    +
    + + + + + + + +
    +

    Discussion

    +

    Subclasses may override this method to be notified when subnode display (asynchronous or synchronous) has +completed.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – setNeedsDisplayAtScale: +

    + +
    +
    + +
    + + +
    +

    Marks the receiver’s bounds as needing to be redrawn, with a scale value.

    +
    + + + +
    - (void)setNeedsDisplayAtScale:(CGFloat)contentsScale
    + + + +
    +

    Parameters

    + + + + + + + +
    contentsScale

    The scale at which the receiver should be drawn.

    +
    + + + + + + + +
    +

    Discussion

    +

    Subclasses should override this if they don’t want their contentsScale changed.

    Note: This changes an internal property. +-setNeedsDisplay is also available to trigger display without changing contentsScaleForDisplay.

    +
    + + + + + +
    +

    See Also

    + +
    + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – recursivelySetNeedsDisplayAtScale: +

    + +
    +
    + +
    + + +
    +

    Recursively calls setNeedsDisplayAtScale: on subnodes.

    +
    + + + +
    - (void)recursivelySetNeedsDisplayAtScale:(CGFloat)contentsScale
    + + + +
    +

    Parameters

    + + + + + + + +
    contentsScale

    The scale at which the receiver’s subnode hierarchy should be drawn.

    +
    + + + + + + + +
    +

    Discussion

    +

    Subclasses may override this if they require modifying the scale set on their child nodes.

    Note: Only the node tree is walked, not the view or layer trees.

    +
    + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - -
    +
    -
    + + +

    Touch handling

    + +
    +
    + +

    – touchesBegan:withEvent: +

    + +
    +
    + +
    + + +
    +

    Tells the node when touches began in its view.

    +
    + + + +
    - (void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    touches

    A set of UITouch instances.

    event

    A UIEvent associated with the touch.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – touchesMoved:withEvent: +

    + +
    +
    + +
    + + +
    +

    Tells the node when touches moved in its view.

    +
    + + + +
    - (void)touchesMoved:(NSSet *)touches withEvent:(UIEvent *)event
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    touches

    A set of UITouch instances.

    event

    A UIEvent associated with the touch.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – touchesEnded:withEvent: +

    + +
    +
    + +
    + + +
    +

    Tells the node when touches ended in its view.

    +
    + + + +
    - (void)touchesEnded:(NSSet *)touches withEvent:(UIEvent *)event
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    touches

    A set of UITouch instances.

    event

    A UIEvent associated with the touch.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    + +

    – touchesCancelled:withEvent: +

    + +
    +
    + +
    + + +
    +

    Tells the node when touches was cancelled in its view.

    +
    + + + +
    - (void)touchesCancelled:(NSSet *)touches withEvent:(UIEvent *)event
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    touches

    A set of UITouch instances.

    event

    A UIEvent associated with the touch.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    +
    +
    +
    + + + +

    Managing Gesture Recognizers

    + +
    +
    -

    gestureRecognizerShouldBegin:

    - - - -
    -

    Asks the node if a gesture recognizer should continue tracking touches.

    -
    - - +

    – gestureRecognizerShouldBegin: +

    -
    - (BOOL)gestureRecognizerShouldBegin:(id)gestureRecognizer
    +
    +
    - - -
    -

    Parameters

    - -
    -
    gestureRecognizer
    -

    A gesture recognizer trying to recognize a gesture.

    -
    - +
    + + +
    +

    Asks the node if a gesture recognizer should continue tracking touches.

    +
    + + + +
    - (BOOL)gestureRecognizerShouldBegin:(UIGestureRecognizer *)gestureRecognizer
    + + + +
    +

    Parameters

    + + + + + + + +
    gestureRecognizer

    A gesture recognizer trying to recognize a gesture.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode+Subclasses.h

    +
    + + +
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - -
    +
    -
    + + +

    Hit Testing

    + +
    +
    -

    hitTest:withEvent:

    - - - -
    -

    Returns the view that contains the point.

    -
    - - +

    – hitTest:withEvent: +

    -
    - (UIView *)hitTest:(id)point withEvent:(id)event
    +
    +
    - - -
    -

    Parameters

    - -
    -
    point
    -

    A point specified in the node’s local coordinate system (bounds).

    -
    - -
    -
    event
    -

    The event that warranted a call to this method.

    -
    - -
    - - - -
    -

    Return Value

    -

    Returns a UIView, not ASDisplayNode, for two reasons: +

    + + +
    +

    Returns the view that contains the point.

    +
    + + + +
    - (UIView *)hitTest:(CGPoint)point withEvent:(UIEvent *)event
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    point

    A point specified in the node’s local coordinate system (bounds).

    event

    The event that warranted a call to this method.

    +
    + + + +
    +

    Return Value

    +

    Returns a UIView, not ASDisplayNode, for two reasons: 1) allows sending events to plain UIViews that don’t have attached nodes, 2) hitTest: is never called before the views are created.

    -
    - - - - - -
    -

    Discussion

    -

    Override to make this node respond differently to touches: (e.g. hide touches from subviews, send all -touches to certain subviews (hit area maximizing), etc.)

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    invalidateCalculatedSize

    - - - -
    -

    Invalidate previously measured and cached size.

    -
    - - - -
    - (void)invalidateCalculatedSize
    - - - - - - - - - -
    -

    Discussion

    -

    Subclasses should call this method to invalidate the previously measured and cached size for the display -node, when the contents of the node change in such a way as to require measuring it again.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    layout

    - - - -
    -

    Called on the main thread by the view’s -layoutSubviews.

    -
    - - - -
    - (void)layout
    - - - - - - - - - -
    -

    Discussion

    -

    Subclasses override this method to layout all subnodes or subviews.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    layoutDidFinish

    - - - -
    -

    Called on the main thread by the view’s -layoutSubviews, after -layout.

    -
    - - - -
    - (void)layoutDidFinish
    - - - - - - - - - -
    -

    Discussion

    -

    Gives a chance for subclasses to perform actions after the subclass and superclass have finished laying -out.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    placeholderImage

    - - - -
    -

    Optionally provide an image to serve as the placeholder for the backing store while the contents are being -displayed.

    -
    - - - -
    - (UIImage *)placeholderImage
    - - - - - - - - - -
    -

    Discussion

    -

    Note: Called on the display queue and/or main queue (MUST BE THREAD SAFE)

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    reclaimMemory

    - - - -
    -

    Provides an opportunity to clear backing store and other memory-intensive intermediates, such as text layout managers -or downloaded content that can be written to a disk cache.

    -
    - - - -
    - (void)reclaimMemory
    - - - - - - - - - -
    -

    Discussion

    -

    Called by -recursivelyReclaimMemory. Base class implements self.contents = nil, clearing any backing -store, for asynchronous regeneration when needed.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    recursivelySetNeedsDisplayAtScale:

    - - - -
    -

    Recursively calls setNeedsDisplayAtScale: on subnodes.

    -
    - - - -
    - (void)recursivelySetNeedsDisplayAtScale:(id)contentsScale
    - - - -
    -

    Parameters

    - -
    -
    contentsScale
    -

    The scale at which the receiver’s subnode hierarchy should be drawn.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Subclasses may override this if they require modifying the scale set on their child nodes.

    Note: Only the node tree is walked, not the view or layer trees.

    -
    - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    setNeedsDisplayAtScale:

    - - - -
    -

    Marks the receiver’s bounds as needing to be redrawn, with a scale value.

    -
    - - - -
    - (void)setNeedsDisplayAtScale:(id)contentsScale
    - - - -
    -

    Parameters

    - -
    -
    contentsScale
    -

    The scale at which the receiver should be drawn.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Subclasses should override this if they don’t want their contentsScale changed.

    Note: This changes an internal property. --setNeedsDisplay is also available to trigger display without changing contentsScaleForDisplay.

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    subnodeDisplayDidFinish:

    - - - -
    -

    Indicates that the receiver is finished displaying its subnodes. This method is not called if there are -no subnodes present.

    -
    - - - -
    - (void)subnodeDisplayDidFinish:(id)subnode
    - - - - - - - - - -
    -

    Discussion

    -

    Subclasses may override this method to be notified when subnode display (asynchronous or synchronous) is -about to begin.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    subnodeDisplayWillStart:

    - - - -
    -

    Indicates that the receiver is about to display its subnodes. This method is not called if there are no -subnodes present.

    -
    - - - -
    - (void)subnodeDisplayWillStart:(id)subnode
    - - - - - - - - - -
    -

    Discussion

    -

    Subclasses may override this method to be notified when subnode display (asynchronous or synchronous) is -about to begin.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    touchesBegan:withEvent:

    - - - -
    -

    Tells the node when touches began in its view.

    -
    - - - -
    - (void)touchesBegan:(id)touches withEvent:(id)event
    - - - -
    -

    Parameters

    - -
    -
    touches
    -

    A set of UITouch instances.

    -
    - -
    -
    event
    -

    A UIEvent associated with the touch.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    touchesCancelled:withEvent:

    - - - -
    -

    Tells the node when touches was cancelled in its view.

    -
    - - - -
    - (void)touchesCancelled:(id)touches withEvent:(id)event
    - - - -
    -

    Parameters

    - -
    -
    touches
    -

    A set of UITouch instances.

    -
    - -
    -
    event
    -

    A UIEvent associated with the touch.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    touchesEnded:withEvent:

    - - - -
    -

    Tells the node when touches ended in its view.

    -
    - - - -
    - (void)touchesEnded:(id)touches withEvent:(id)event
    - - - -
    -

    Parameters

    - -
    -
    touches
    -

    A set of UITouch instances.

    -
    - -
    -
    event
    -

    A UIEvent associated with the touch.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    touchesMoved:withEvent:

    - - - -
    -

    Tells the node when touches moved in its view.

    -
    - - - -
    - (void)touchesMoved:(id)touches withEvent:(id)event
    - - - -
    -

    Parameters

    - -
    -
    touches
    -

    A set of UITouch instances.

    -
    - -
    -
    event
    -

    A UIEvent associated with the touch.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - -

    willEnterHierarchy

    - - - -
    -

    Called just before the view is added to a superview.

    -
    - - - -
    - (void)willEnterHierarchy
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode+Subclasses.h
    -
    - - -
    - -
    - - - - - - - -
    - -
    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Categories/ASDisplayNode+UIViewBridge.html b/appledoc/Categories/ASDisplayNode+UIViewBridge.html index cfaced8a..10197f70 100644 --- a/appledoc/Categories/ASDisplayNode+UIViewBridge.html +++ b/appledoc/Categories/ASDisplayNode+UIViewBridge.html @@ -1,113 +1,95 @@ - + - - - ASDisplayNode(UIViewBridge) Category Reference - - - - - - -
    - + + + + ASDisplayNode(UIViewBridge) Category Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASDisplayNode(UIViewBridge) Category Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - - - - -
    -
    - - - -
    - - + +
    Declared inASDisplayNode.hDeclared inASDisplayNode.h
    - +
    @@ -126,249 +108,139 @@ or layer property is accessed).

    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    +
    +
    -

    backgroundColor

    - - - -
    -

    The node view’s background color.

    -
    - - +

      backgroundColor +

    -
    @property (atomic, retain) UIColor *backgroundColor
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    In contrast to UIView, setting a transparent color will not set opaque = NO. +

    + + +
    +

    The node view’s background color.

    +
    + + + +
    @property (atomic, retain) UIColor *backgroundColor
    + + + + + + + + + +
    +

    Discussion

    +

    In contrast to UIView, setting a transparent color will not set opaque = NO. This only affects nodes that implement +drawRect like ASTextNode.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    +
    -

    contentMode

    - - - -
    -

    A flag used to determine how a node lays out its content when its bounds change.

    -
    - - +

      contentMode +

    -
    @property (atomic, assign) UIViewContentMode contentMode
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    This is like UIView’s contentMode property, but better. We do our own mapping to layer.contentsGravity in +

    + + +
    +

    A flag used to determine how a node lays out its content when its bounds change.

    +
    + + + +
    @property (atomic, assign) UIViewContentMode contentMode
    + + + + + + + + + +
    +

    Discussion

    +

    This is like UIView’s contentMode property, but better. We do our own mapping to layer.contentsGravity in _ASDisplayView. You can set needsDisplayOnBoundsChange independently. Thus, UIViewContentModeRedraw is not allowed; use needsDisplayOnBoundsChange = YES instead, and pick an appropriate contentMode for your content while it’s being re-rendered.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - - - - - - - - - - - -
    - -
    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Categories/CALayer+AsyncDisplayKit.html b/appledoc/Categories/CALayer+AsyncDisplayKit.html new file mode 100644 index 00000000..214613b4 --- /dev/null +++ b/appledoc/Categories/CALayer+AsyncDisplayKit.html @@ -0,0 +1,192 @@ + + + + + + CALayer(AsyncDisplayKit) Category Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    CALayer(AsyncDisplayKit) Category Reference

    + + +
    + + + + +
    Declared inASDisplayNode.h
    + + + + +
    + +

    Overview

    +

    CALayer(AsyncDisplayKit) defines convenience method for adding sub-ASDisplayNode to a CALayer.

    +
    + + + + + +
    + + + + + + +
    +
    + +

    – addSubnode: +

    + +
    +
    + +
    + + +
    +

    Convenience method, equivalent to [layer addSublayer:node.layer].

    +
    + + + +
    - (void)addSubnode:(ASDisplayNode *)node
    + + + +
    +

    Parameters

    + + + + + + + +
    node

    The node to be added.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Categories/UIView+AsyncDisplayKit.html b/appledoc/Categories/UIView+AsyncDisplayKit.html new file mode 100644 index 00000000..b8029eeb --- /dev/null +++ b/appledoc/Categories/UIView+AsyncDisplayKit.html @@ -0,0 +1,192 @@ + + + + + + UIView(AsyncDisplayKit) Category Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    UIView(AsyncDisplayKit) Category Reference

    + + +
    + + + + +
    Declared inASDisplayNode.h
    + + + + +
    + +

    Overview

    +

    UIVIew(AsyncDisplayKit) defines convenience method for adding sub-ASDisplayNode to an UIView.

    +
    + + + + + +
    + + + + + + +
    +
    + +

    – addSubnode: +

    + +
    +
    + +
    + + +
    +

    Convenience method, equivalent to [view addSubview:node.view] or [view.layer addSublayer:node.layer] if layer-backed.

    +
    + + + +
    - (void)addSubnode:(ASDisplayNode *)node
    + + + +
    +

    Parameters

    + + + + + + + +
    node

    The node to be added.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASBackgroundLayoutSpec.html b/appledoc/Classes/ASBackgroundLayoutSpec.html new file mode 100644 index 00000000..9ced6fc4 --- /dev/null +++ b/appledoc/Classes/ASBackgroundLayoutSpec.html @@ -0,0 +1,202 @@ + + + + + + ASBackgroundLayoutSpec Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASBackgroundLayoutSpec Class Reference

    + + +
    + + + + + + + +
    Inherits fromASLayoutSpec : NSObject
    Declared inASBackgroundLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    Lays out a single layoutable child, then lays out a background layoutable instance behind it stretched to its size.

    +
    + + + + + +
    + + + + + + +
    +
    + +

    + newWithChild:background: +

    + +
    +
    + +
    + + +
    +

    A child that is laid out to determine the size of this spec. If this is nil, then this method + returns nil.

    +
    + + + +
    + (instancetype)newWithChild:(id<ASLayoutable>)child background:(id<ASLayoutable>)background
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    child

    A child that is laid out to determine the size of this spec. If this is nil, then this method + returns nil.

    background

    A layoutable object that is laid out behind the child. May be nil, in which case the background is omitted.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASBackgroundLayoutSpec.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASCellNode.html b/appledoc/Classes/ASCellNode.html index b5c6a6bd..8c0dae72 100644 --- a/appledoc/Classes/ASCellNode.html +++ b/appledoc/Classes/ASCellNode.html @@ -1,95 +1,88 @@ - + - - - ASCellNode Class Reference - - - - - - -
    - + + + + ASCellNode Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASCellNode Class Reference

    - - - - - - - - - - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromASDisplayNode : ASDealloc2MainObjectInherits fromASDisplayNode : ASDealloc2MainObject
    Declared inASCellNode.hDeclared inASCellNode.h
    - +
    @@ -99,131 +92,30 @@
    - - - - - - - - - - - - - - - - -
    - -
    + +
    +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASCenterLayoutSpec.html b/appledoc/Classes/ASCenterLayoutSpec.html new file mode 100644 index 00000000..5f5c7f0c --- /dev/null +++ b/appledoc/Classes/ASCenterLayoutSpec.html @@ -0,0 +1,205 @@ + + + + + + ASCenterLayoutSpec Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASCenterLayoutSpec Class Reference

    + + +
    + + + + + + + +
    Inherits fromASLayoutSpec : NSObject
    Declared inASCenterLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    Lays out a single layoutable child and position it so that it is centered into the layout bounds.

    +
    + + + + + +
    + + + + + + +
    +
    + +

    + newWithCenteringOptions:sizingOptions:child: +

    + +
    +
    + +
    + + +
    +

    Initializer.

    +
    + + + +
    + (instancetype)newWithCenteringOptions:(ASCenterLayoutSpecCenteringOptions)centeringOptions sizingOptions:(ASCenterLayoutSpecSizingOptions)sizingOptions child:(id<ASLayoutable>)child
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    centeringOptions

    How the child is centered.

    sizingOptions

    How much space will be taken up.

    child

    The child to center.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASCenterLayoutSpec.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASCollectionView.html b/appledoc/Classes/ASCollectionView.html index 83784dea..4dfe3e40 100644 --- a/appledoc/Classes/ASCollectionView.html +++ b/appledoc/Classes/ASCollectionView.html @@ -1,135 +1,136 @@ - + - - - ASCollectionView Class Reference - - - - - - -
    - + + + + ASCollectionView Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASCollectionView Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromUICollectionViewInherits fromUICollectionView
    Declared inASCollectionView.hDeclared inASCollectionView.h
    - +
    @@ -142,399 +143,1128 @@ pre-rendering instead of synchronously loading UICollectionViewCells.

    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    - -

    rangeTuningParameters

    - - - -
    -

    Tuning parameters for the working range.

    -
    - - +
    +
    + +

    – tuningParametersForRangeType: +

    -
    @property (nonatomic, assign) ASRangeTuningParameters rangeTuningParameters
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    Defaults to a trailing buffer of one screenful and a leading buffer of two screenfuls.

    -
    - - - - - - - -
    -

    Declared In

    - ASCollectionView.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    calculatedSizeForNodeAtIndexPath:

    - - - -
    -

    Query the sized node at indexPath for its calculatedSize.

    -
    - - - -
    - (CGSize)calculatedSizeForNodeAtIndexPath:(id)indexPath
    - - - -
    -

    Parameters

    - -
    -
    indexPath
    -

    The index path for the node of interest.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASCollectionView.h
    -
    - - -
    - -
    - -

    insertItemsAtIndexPaths:

    - - - -
    -

    Items updating.

    -
    - - - -
    - (void)insertItemsAtIndexPaths:(id)indexPaths
    - - - - - - - - - -
    -

    Discussion

    -

    All operations are asynchronous and thread safe. You can call it from background thread (it is recommendated) and the UI table -view will be updated asynchronously. The asyncDataSource must be updated to reflect the changes before these methods are called.

    -
    - - - - - - - -
    -

    Declared In

    - ASCollectionView.h
    -
    - - -
    - -
    - -

    insertSections:

    - - - -
    -

    Section updating.

    -
    - - - -
    - (void)insertSections:(id)sections
    - - - - - - - - - -
    -

    Discussion

    -

    All operations are asynchronous and thread safe. You can call it from background thread (it is recommendated) and the UI table -view will be updated asynchronously. The asyncDataSource must be updated to reflect the changes before these methods are called.

    -
    - - - - - - - -
    -

    Declared In

    - ASCollectionView.h
    -
    - - -
    - -
    - -

    reloadData

    - - - -
    -

    Reload everything from scratch, destroying the working range and all cached nodes.

    -
    - - - -
    - (void)reloadData
    - - - - - - - - - -
    -

    Discussion

    -

    Warning: This method is substantially more expensive than UICollectionView’s version.

    -
    - - - - - - - -
    -

    Declared In

    - ASCollectionView.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    Tuning parameters for a range type.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASControlNode.html b/appledoc/Classes/ASControlNode.html index 6a11024a..1f1a4a36 100644 --- a/appledoc/Classes/ASControlNode.html +++ b/appledoc/Classes/ASControlNode.html @@ -1,151 +1,116 @@ - + - - - ASControlNode Class Reference - - - - - - -
    - + + + + ASControlNode Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASControlNode Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromASDisplayNode : ASDealloc2MainObjectInherits fromASDisplayNode : ASDealloc2MainObject
    Declared inASControlNode.hDeclared inASControlNode.h
    - +
    @@ -155,640 +120,525 @@
    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    +
    +
    -

    enabled

    - - - -
    -

    Indicates whether or not the receiver is enabled.

    -
    - - +

      enabled +

    -
    @property (nonatomic, assign, getter=isEnabled) BOOL enabled
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    Specify YES to make the control enabled; otherwise, specify NO to make it disabled. The default value is YES. If the enabled state is NO, the control ignores touch events and subclasses may draw differently.

    -
    - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - -

    highlighted

    - - - -
    -

    Indicates whether or not the receiver is highlighted.

    -
    - - - -
    @property (nonatomic, readonly, assign, getter=isHighlighted) BOOL highlighted
    - - - - - - - - - -
    -

    Discussion

    -

    This is set automatically when the there is a touch inside the control and removed on exit or touch up. This is different from touchInside in that it includes an area around the control, rather than just for touches inside the control.

    -
    - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - -

    touchInside

    - - - -
    -

    Indicates whether or not a touch is inside the bounds of the receiver.

    -
    - - - -
    @property (nonatomic, readonly, assign, getter=isTouchInside) BOOL touchInside
    - - - - - - - - - -
    -

    Discussion

    -

    YES if a touch is inside the receiver’s bounds; NO otherwise.

    -
    - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - -

    tracking

    - - - -
    -

    Indicates whether or not the receiver is currently tracking touches related to an event.

    -
    - - - -
    @property (nonatomic, readonly, assign, getter=isTracking) BOOL tracking
    - - - - - - - - - -
    -

    Discussion

    -

    YES if the receiver is tracking touches; NO otherwise.

    -
    - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    actionsForTarget:forControlEvent:

    - - - -
    -

    Returns the actions that are associated with a target and a particular control event.

    -
    - - - -
    - (NSArray *)actionsForTarget:(id)target forControlEvent:(id)controlEvent
    - - - -
    -

    Parameters

    - -
    -
    target
    -

    The target object. May not be nil.

    -
    - -
    -
    controlEvent
    -

    A single constant of type ASControlNodeEvent that specifies a particular user action on the control; for a list of these constants, see “Control Events”. May not be 0 or ASControlNodeEventAllEvents.

    -
    - -
    - - - -
    -

    Return Value

    -

    An array of selector names as NSString objects, or nil if there are no action selectors associated with controlEvent.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - -

    addTarget:action:forControlEvents:

    - - - -
    -

    Adds a target-action pair for a particular event (or events).

    -
    - - - -
    - (void)addTarget:(id)target action:(id)action forControlEvents:(id)controlEvents
    - - - -
    -

    Parameters

    - -
    -
    target
    -

    The object to which the action message is sent. If this is nil, the responder chain is searched for an object willing to respond to the action message. target is not retained.

    -
    - -
    -
    action
    -

    A selector identifying an action message. May optionally include the sender and the event as parameters, in that order. May not be NULL.

    -
    - -
    -
    controlEvents
    -

    A bitmask specifying the control events for which the action message is sent. May not be 0. See “Control Events” for bitmask constants.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    You may call this method multiple times, and you may specify multiple target-action pairs for a particular event. Targets are held weakly.

    -
    - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - -

    allTargets

    - - - -
    -

    Returns all target objects associated with the receiver.

    -
    - - - -
    - (NSSet *)allTargets
    - - - - - -
    -

    Return Value

    -

    A set of all targets for the receiver. The set may include NSNull to indicate at least one nil target (meaning, the responder chain is searched for a target.)

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - -

    removeTarget:action:forControlEvents:

    - - - -
    -

    Removes a target-action pair for a particular event.

    -
    - - - -
    - (void)removeTarget:(id)target action:(id)action forControlEvents:(id)controlEvents
    - - - -
    -

    Parameters

    - -
    -
    target
    -

    The target object. Pass nil to remove all targets paired with action and the specified control events.

    -
    - -
    -
    action
    -

    A selector identifying an action message. Pass NULL to remove all action messages paired with target.

    -
    - -
    -
    controlEvents
    -

    A bitmask specifying the control events associated with target and action. See “Control Events” for bitmask constants. May not be 0.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - -

    sendActionsForControlEvents:withEvent:

    - - - -
    -

    Sends the actions for the control events for a particular event.

    -
    - - - -
    - (void)sendActionsForControlEvents:(id)controlEvents withEvent:(id)event
    - - - -
    -

    Parameters

    - -
    -
    controlEvents
    -

    A bitmask specifying the control events for which to send actions. See “Control Events” for bitmask constants. May not be 0.

    -
    - -
    -
    event
    -

    The event which triggered these control actions. May be nil.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASControlNode.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    Indicates whether or not the receiver is enabled.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASDisplayNode.html b/appledoc/Classes/ASDisplayNode.html index 2bcf81ba..9014497e 100644 --- a/appledoc/Classes/ASDisplayNode.html +++ b/appledoc/Classes/ASDisplayNode.html @@ -1,259 +1,171 @@ - + - - - ASDisplayNode Class Reference - - - - - - -
    - + + + + ASDisplayNode Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASDisplayNode Class Reference

    - - -
  • Tasks
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + + + + +
    Inherits fromASDealloc2MainObjectInherits fromASDealloc2MainObject
    Declared inASDisplayNode.hConforms toASLayoutable
    Declared inASDisplayNode.h
    - +
    @@ -274,446 +186,1187 @@ display.

    - +
    -

    Tasks

    - + -

    Initializing a node object

    +

    Initializing a node object

    - - +
    +
    + +

    – init +

    + +
    +
    + +
    + + +
    +

    Designated initializer.

    +
    + + + +
    - (id)init
    + + + + + +
    +

    Return Value

    +

    An ASDisplayNode instance whose view will be a subclass that enables asynchronous rendering, and passes +through -layout and touch handling methods.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – initWithViewBlock: +

    + +
    +
    + +
    + + +
    +

    Alternative initializer with a block to create the backing view.

    +
    + + + +
    - (id)initWithViewBlock:(ASDisplayNodeViewBlock)viewBlock
    + + + +
    +

    Parameters

    + + + + + + + +
    viewBlock

    The block that will be used to create the backing view.

    +
    + + + +
    +

    Return Value

    +

    An ASDisplayNode instance that loads its view with the given block that is guaranteed to run on the main +queue. The view will render synchronously and -layout and touch handling methods on the node will not be called.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – initWithLayerBlock: +

    + +
    +
    + +
    + + +
    +

    Alternative initializer with a block to create the backing layer.

    +
    + + + +
    - (id)initWithLayerBlock:(ASDisplayNodeLayerBlock)viewBlock
    + + + +
    +

    Parameters

    + + + + + + + +
    viewBlock

    The block that will be used to create the backing layer.

    +
    + + + +
    +

    Return Value

    +

    An ASDisplayNode instance that loads its layer with the given block that is guaranteed to run on the main +queue. The layer will render synchronously and -layout and touch handling methods on the node will not be called.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    +
    + -

    Properties

    +

    Properties

    - - +
    +
    + +

      synchronous +

    + +
    +
    + +
    + + +
    +

    Returns whether the node is synchronous.

    +
    + + + +
    @property (nonatomic, readonly, assign, getter=isSynchronous) BOOL synchronous
    + + + + + +
    +

    Return Value

    +

    NO if the node wraps a _ASDisplayView, YES otherwise.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    +
    + -

    Getting view and layer

    +

    Getting view and layer

    - - +
    +
    + +

      view +

    + +
    +
    + +
    + + +
    +

    Returns a view.

    +
    + + + +
    @property (nonatomic, readonly, retain) UIView *view
    + + + + + + + + + +
    +

    Discussion

    +

    The view property is lazily initialized, similar to UIViewController. +To go the other direction, use ASViewToDisplayNode() in ASDisplayNodeExtras.h.

    Warning: The first access to it must be on the main thread, and should only be used on the main thread thereafter as +well.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      nodeLoaded +

    + +
    +
    + +
    + + +
    +

    Returns whether a node’s backing view or layer is loaded.

    +
    + + + +
    @property (atomic, readonly, assign, getter=isNodeLoaded) BOOL nodeLoaded
    + + + + + +
    +

    Return Value

    +

    YES if a view is loaded, or if layerBacked is YES and layer is not nil; NO otherwise.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      layerBacked +

    + +
    +
    + +
    + + +
    +

    Returns whether the node rely on a layer instead of a view.

    +
    + + + +
    @property (nonatomic, assign, getter=isLayerBacked) BOOL layerBacked
    + + + + + +
    +

    Return Value

    +

    YES if the node rely on a layer, NO otherwise.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      layer +

    + +
    +
    + +
    + + +
    +

    Returns a layer.

    +
    + + + +
    @property (nonatomic, readonly, retain) CALayer *layer
    + + + + + + + + + +
    +

    Discussion

    +

    The layer property is lazily initialized, similar to the view property. +To go the other direction, use ASLayerToDisplayNode() in ASDisplayNodeExtras.h.

    Warning: The first access to it must be on the main thread, and should only be used on the main thread thereafter as +well.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    +
    + -

    Managing dimensions

    +

    Managing dimensions

    - - - - -

    Managing the nodes hierarchy

    +
    +
    + +

    – measure: +

    - - - - -

    Drawing and Updating the View

    +
    +
    - - - - -

    Hit Testing

    +
    + + +
    +

    Asks the node to measure and return the size that best fits its subnodes.

    +
    + + - - - - -

    Converting Between View Coordinate Systems

    +
    - (CGSize)measure:(CGSize)constrainedSize
    - - -
    + + +
    +

    Parameters

    + + + + + + + +
    constrainedSize

    The maximum size the receiver should fit in.

    +
    + + + +
    +

    Return Value

    +

    A new size that fits the receiver’s subviews.

    +
    + + + + + +
    +

    Discussion

    +

    Though this method does not set the bounds of the view, it does have side effects–caching both the +constraint and the result.

    Warning: Subclasses must not override this; it calls -measureWithSizeRange: with zero min size. +-measureWithSizeRange: caches results from -calculateLayoutThatFits:. Calling this method may +be expensive if result is not cached.

    +
    + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – measureWithSizeRange: +

    + +
    +
    + +
    + + +
    +

    Asks the node to measure a layout based on given size range.

    +
    + + + +
    - (ASLayout *)measureWithSizeRange:(ASSizeRange)constrainedSize
    + + + +
    +

    Parameters

    + + + + + + + +
    constrainedSize

    The minimum and maximum sizes the receiver should fit in.

    +
    + + + +
    +

    Return Value

    +

    An ASLayout instance defining the layout of the receiver (and its children, if the box layout model is used).

    +
    + + + + + +
    +

    Discussion

    +

    Though this method does not set the bounds of the view, it does have side effects–caching both the +constraint and the result.

    Warning: Subclasses must not override this; it caches results from -calculateLayoutThatFits:. Calling this method may +be expensive if result is not cached.

    +
    + + + + + +
    +

    See Also

    + +
    + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    -

    calculatedSize

    - - - -
    -

    Return the calculated size.

    -
    - - +

      calculatedSize +

    -
    @property (nonatomic, readonly, assign) CGSize calculatedSize
    +
    +
    - - - - -
    -

    Return Value

    -

    Size already calculated by calculateSizeThatFits:.

    +
    + + +
    +

    Return the calculated size.

    +
    + + + +
    @property (nonatomic, readonly, assign) CGSize calculatedSize
    + + + + + +
    +

    Return Value

    +

    Size already calculated by -calculateLayoutThatFits:.

    +
    + + + + + +
    +

    Discussion

    +

    Ideal for use by subclasses in -layout, having already prompted their subnodes to calculate their size by +calling -measure: on them in -calculateLayoutThatFits.

    Warning: Subclasses must not override this; it returns the last cached measurement and is never expensive.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    - - - - - -
    -

    Discussion

    -

    Ideal for use by subclasses in -layout, having already prompted their subnodes to calculate their size by -calling -measure: on them in -calculateSizeThatFits:.

    Warning: Subclasses must not override this; it returns the last cached size calculated and is never expensive.

    +
    + +

      constrainedSizeForCalculatedLayout +

    + +
    +
    + +
    + + +
    +

    Return the constrained size range used for calculating layout.

    +
    + + + +
    @property (nonatomic, readonly, assign) ASSizeRange constrainedSizeForCalculatedLayout
    + + + + + +
    +

    Return Value

    +

    The minimum and maximum constrained sizes used by calculateLayoutThatFits:.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - -
    +
    -
    - -

    constrainedSizeForCalculatedSize

    - - - -
    -

    Return the constrained size used for calculating size.

    -
    - - -
    @property (nonatomic, readonly, assign) CGSize constrainedSizeForCalculatedSize
    + +

    Managing the nodes hierarchy

    - - - - -
    -

    Return Value

    -

    The constrained size used by calculateSizeThatFits:.

    +
    +
    + +

    – addSubnode: +

    + +
    +
    + +
    + + +
    +

    Add a node as a subnode to this node.

    +
    + + + +
    - (void)addSubnode:(ASDisplayNode *)subnode
    + + + +
    +

    Parameters

    + + + + + + + +
    subnode

    The node to be added.

    +
    + + + + + + + +
    +

    Discussion

    +

    The subnode’s view will automatically be added to this node’s view, lazily if the views are not created +yet.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    displaySuspended

    - - - -
    -

    Prevent the node’s layer from displaying.

    -
    - - +
    + +

    – insertSubnode:belowSubnode: +

    -
    @property (nonatomic, assign) BOOL displaySuspended
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    A subclass may check this flag during -display or -drawInContext: to cancel a display that is already in -progress.

    +
    + + +
    +

    Insert a subnode before a given subnode in the list.

    +
    + + -

    Defaults to NO. Does not control display for any child or descendant nodes; for that, use --recursivelySetDisplaySuspended:.

    +
    - (void)insertSubnode:(ASDisplayNode *)subnode belowSubnode:(ASDisplayNode *)below
    -

    If a setNeedsDisplay occurs while displaySuspended is YES, and displaySuspended is set to NO, then the -layer will be automatically displayed.

    + + +
    +

    Parameters

    + + + + + + + + + + + + +
    subnode

    The node to insert below another node.

    below

    The sibling node that will be above the inserted node.

    +
    + + + + + + + +
    +

    Discussion

    +

    If the views are loaded, the subnode’s view will be inserted below the given node’s view in the hierarchy +even if there are other non-displaynode views.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – insertSubnode:aboveSubnode: +

    + +
    +
    + +
    + + +
    +

    Insert a subnode after a given subnode in the list.

    +
    + + + +
    - (void)insertSubnode:(ASDisplayNode *)subnode aboveSubnode:(ASDisplayNode *)above
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    subnode

    The node to insert below another node.

    above

    The sibling node that will be behind the inserted node.

    +
    + + + + + + + +
    +

    Discussion

    +

    If the views are loaded, the subnode’s view will be inserted above the given node’s view in the hierarchy +even if there are other non-displaynode views.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – insertSubnode:atIndex: +

    + +
    +
    + +
    + + +
    +

    Insert a subnode at a given index in subnodes.

    +
    + + + +
    - (void)insertSubnode:(ASDisplayNode *)subnode atIndex:(NSInteger)idx
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    subnode

    The node to insert.

    idx

    The index in the array of the subnodes property at which to insert the node. Subnodes indices start at 0 +and cannot be greater than the number of subnodes.

    +
    + + + + + + + +
    +

    Discussion

    +

    If this node’s view is loaded, ASDisplayNode insert the subnode’s view after the subnode at index - 1’s +view even if there are other non-displaynode views.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – replaceSubnode:withSubnode: +

    + +
    +
    + +
    + + +
    +

    Replace subnode with replacementSubnode.

    +
    + + + +
    - (void)replaceSubnode:(ASDisplayNode *)subnode withSubnode:(ASDisplayNode *)replacementSubnode
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    subnode

    A subnode of self.

    replacementSubnode

    A node with which to replace subnode.

    +
    + + + + + + + +
    +

    Discussion

    +

    Should both subnode and replacementSubnode already be subnodes of self, subnode is removed and +replacementSubnode inserted in its place. +If subnode is not a subnode of self, this method will throw an exception. +If replacementSubnode is nil, this method will throw an exception

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – removeFromSupernode +

    + +
    +
    + +
    + + +
    +

    Remove this node from its supernode.

    +
    + + + +
    - (void)removeFromSupernode
    + + + + + + + + + +
    +

    Discussion

    +

    The node’s view will be automatically removed from the supernode’s view.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      subnodes +

    + +
    +
    + +
    + + +
    +

    The receiver’s immediate subnodes.

    +
    + + + +
    @property (nonatomic, readonly, retain) NSArray *subnodes
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      supernode +

    + +
    +
    + +
    + + +
    +

    The receiver’s supernode.

    +
    + + + +
    @property (nonatomic, readonly, weak) ASDisplayNode *supernode
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - -
    +
    -
    + + +

    Drawing and Updating the View

    + +
    +
    -

    displaysAsynchronously

    - - - -
    -

    Whether this node’s view performs asynchronous rendering.

    -
    - - +

      displaysAsynchronously +

    -
    @property (nonatomic, assign) BOOL displaysAsynchronously
    +
    +
    - - - - -
    -

    Return Value

    -

    Defaults to YES, except for synchronous views (ie, those created with -initWithViewClass: / --initWithLayerClass:), which are always NO.

    -
    - - - - - -
    -

    Discussion

    -

    If this flag is set, then the node will participate in the current asyncdisplaykit_async_transaction and +

    + + +
    +

    Whether this node’s view performs asynchronous rendering.

    +
    + + + +
    @property (nonatomic, assign) BOOL displaysAsynchronously
    + + + + + +
    +

    Return Value

    +

    Defaults to YES, except for synchronous views (ie, those created with -initWithViewBlock: / +-initWithLayerBlock:), which are always NO.

    +
    + + + + + +
    +

    Discussion

    +

    If this flag is set, then the node will participate in the current asyncdisplaykit_async_transaction and do its rendering on the displayQueue instead of the main thread.

    Asynchronous rendering proceeds as follows:

    @@ -734,1535 +1387,853 @@ After layout, Core Animation will call -display on the _ASDisplayLayer -display sets the layer contents immediately with the result

    Note: this has nothing to do with -[CALayer drawsAsynchronously].

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      shouldRasterizeDescendants +

    + +
    +
    + +
    + + +
    +

    Whether to draw all descendant nodes' layers/views into this node’s layer/view’s backing store.

    +
    + + + +
    @property (nonatomic, assign) BOOL shouldRasterizeDescendants
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      displaySuspended +

    + +
    +
    + +
    + + +
    +

    Prevent the node’s layer from displaying.

    +
    + + + +
    @property (nonatomic, assign) BOOL displaySuspended
    + + + + + + + + + +
    +

    Discussion

    +

    A subclass may check this flag during -display or -drawInContext: to cancel a display that is already in +progress.

    + +

    Defaults to NO. Does not control display for any child or descendant nodes; for that, use +-recursivelySetDisplaySuspended:.

    + +

    If a setNeedsDisplay occurs while displaySuspended is YES, and displaySuspended is set to NO, then the +layer will be automatically displayed.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – recursivelySetDisplaySuspended: +

    + +
    +
    + +
    + + +
    +

    Prevent the node and its descendants' layer from displaying.

    +
    + + + +
    - (void)recursivelySetDisplaySuspended:(BOOL)flag
    + + + +
    +

    Parameters

    + + + + + + + +
    flag

    YES if display should be prevented or cancelled; NO otherwise.

    +
    + + + + + + + + + + + +
    +

    See Also

    + +
    + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – recursivelyClearContents +

    + +
    +
    + +
    + + +
    +

    Calls -clearContents on the receiver and its subnode hierarchy.

    +
    + + + +
    - (void)recursivelyClearContents
    + + + + + + + + + +
    +

    Discussion

    +

    Clears backing stores and other memory-intensive intermediates. +If the node is removed from a visible hierarchy and then re-added, it will automatically trigger a new asynchronous display, +as long as displaySuspended is not set. +If the node remains in the hierarchy throughout, -setNeedsDisplay is required to trigger a new asynchronous display.

    +
    + + + + + +
    +

    See Also

    + +
    + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – recursivelyClearFetchedData +

    + +
    +
    + +
    + + +
    +

    Calls -clearFetchedData on the receiver and its subnode hierarchy.

    +
    + + + +
    - (void)recursivelyClearFetchedData
    + + + + + + + + + +
    +

    Discussion

    +

    Clears any memory-intensive fetched content. +This method is used to notify the node that it should purge any content that is both expensive to fetch and to +retain in memory.

    +
    + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

    – recursivelyFetchData +

    + +
    +
    + +
    + + +
    +

    Calls -fetchData on the receiver and its subnode hierarchy.

    +
    + + + +
    - (void)recursivelyFetchData
    + + + + + + + + + +
    +

    Discussion

    +

    Fetches content from remote sources for the current node and all subnodes.

    +
    + + + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      placeholderEnabled +

    + +
    +
    + +
    + + +
    +

    Toggle displaying a placeholder over the node that covers content until the node and all subnodes are +displayed.

    +
    + + + +
    @property (nonatomic, assign) BOOL placeholderEnabled
    + + + + + + + + + +
    +

    Discussion

    +

    Defaults to NO.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    +
    +
    + +

      placeholderFadeDuration +

    + +
    +
    + +
    + + +
    +

    Set the time it takes to fade out the placeholder when a node’s contents are finished displaying.

    +
    + + + +
    @property (nonatomic, assign) NSTimeInterval placeholderFadeDuration
    + + + + + + + + + +
    +

    Discussion

    +

    Defaults to 0 seconds.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASDisplayNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - -
    +
    -
    + + +

    Hit Testing

    + +
    +
    -

    hitTestSlop

    - - - -
    -

    Bounds insets for hit testing.

    -
    - - +

      hitTestSlop +

    -
    @property (nonatomic, assign) UIEdgeInsets hitTestSlop
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    When set to a non-zero inset, increases the bounds for hit testing to make it easier to tap or perform +

    + + +
    +

    Bounds insets for hit testing.

    +
    + + + +
    @property (nonatomic, assign) UIEdgeInsets hitTestSlop
    + + + + + + + + + +
    +

    Discussion

    +

    When set to a non-zero inset, increases the bounds for hit testing to make it easier to tap or perform gestures on this node. Default is UIEdgeInsetsZero.

    This affects the default implementation of -hitTest and -pointInside, so subclasses should call super if you override it and want hitTestSlop applied.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    layer

    - - - -
    -

    Returns a layer.

    -
    - - - -
    @property (nonatomic, readonly, retain) CALayer *layer
    - - - - - - - - - -
    -

    Discussion

    -

    The layer property is lazily initialized, similar to the view property. -To go the other direction, use ASLayerToDisplayNode() in ASDisplayNodeExtras.h.

    Warning: The first access to it must be on the main thread, and should only be used on the main thread thereafter as -well.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    layerBacked

    - - - -
    -

    Returns whether the node rely on a layer instead of a view.

    -
    - - - -
    @property (nonatomic, assign, getter=isLayerBacked) BOOL layerBacked
    - - - - - -
    -

    Return Value

    -

    YES if the node rely on a layer, NO otherwise.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    nodeLoaded

    - - - -
    -

    Returns whether a node’s backing view or layer is loaded.

    -
    - - - -
    @property (atomic, readonly, assign, getter=isNodeLoaded) BOOL nodeLoaded
    - - - - - -
    -

    Return Value

    -

    YES if a view is loaded, or if layerBacked is YES and layer is not nil; NO otherwise.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    placeholderEnabled

    - - - -
    -

    Toggle displaying a placeholder over the node that covers content until the node and all subnodes are -displayed.

    -
    - - - -
    @property (nonatomic, assign) BOOL placeholderEnabled
    - - - - - - - - - -
    -

    Discussion

    -

    Defaults to NO.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    placeholderFadesOut

    - - - -
    -

    Toggle to fade-out the placeholder when a node’s contents are finished displaying.

    -
    - - - -
    @property (nonatomic, assign) BOOL placeholderFadesOut
    - - - - - - - - - -
    -

    Discussion

    -

    Defaults to NO.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    shouldRasterizeDescendants

    - - - -
    -

    Whether to draw all descendant nodes' layers/views into this node’s layer/view’s backing store.

    -
    - - - -
    @property (nonatomic, assign) BOOL shouldRasterizeDescendants
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    subnodes

    - - - -
    -

    The receiver’s immediate subnodes.

    -
    - - - -
    @property (nonatomic, readonly, retain) NSArray *subnodes
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    supernode

    - - - -
    -

    The receiver’s supernode.

    -
    - - - -
    @property (nonatomic, readonly, weak) ASDisplayNode *supernode
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    synchronous

    - - - -
    -

    Returns whether the node is synchronous.

    -
    - - - -
    @property (nonatomic, readonly, assign, getter=isSynchronous) BOOL synchronous
    - - - - - -
    -

    Return Value

    -

    NO if the node wraps a _ASDisplayView, YES otherwise.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    view

    - - - -
    -

    Returns a view.

    -
    - - - -
    @property (nonatomic, readonly, retain) UIView *view
    - - - - - - - - - -
    -

    Discussion

    -

    The view property is lazily initialized, similar to UIViewController. -To go the other direction, use ASViewToDisplayNode() in ASDisplayNodeExtras.h.

    Warning: The first access to it must be on the main thread, and should only be used on the main thread thereafter as -well.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    addSubnode:

    - - - -
    -

    Add a node as a subnode to this node.

    -
    - - - -
    - (void)addSubnode:(id)subnode
    - - - -
    -

    Parameters

    - -
    -
    subnode
    -

    The node to be added.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    The subnode’s view will automatically be added to this node’s view, lazily if the views are not created -yet.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    convertPoint:fromNode:

    - - - -
    -

    Converts a point from the coordinate system of a given node to that of the receiver.

    -
    - - - -
    - (CGPoint)convertPoint:(id)point fromNode:(id)node
    - - - -
    -

    Parameters

    - -
    -
    point
    -

    A point specified in the local coordinate system (bounds) of node.

    -
    - -
    -
    node
    -

    The node with point in its coordinate system.

    -
    - -
    - - - -
    -

    Return Value

    -

    The point converted to the local coordinate system (bounds) of the receiver.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    convertPoint:toNode:

    - - - -
    -

    Converts a point from the receiver’s coordinate system to that of the specified node.

    -
    - - - -
    - (CGPoint)convertPoint:(id)point toNode:(id)node
    - - - -
    -

    Parameters

    - -
    -
    point
    -

    A point specified in the local coordinate system (bounds) of the receiver.

    -
    - -
    -
    node
    -

    The node into whose coordinate system point is to be converted.

    -
    - -
    - - - -
    -

    Return Value

    -

    The point converted to the coordinate system of node.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    convertRect:fromNode:

    - - - -
    -

    Converts a rectangle from the coordinate system of another node to that of the receiver.

    -
    - - - -
    - (CGRect)convertRect:(id)rect fromNode:(id)node
    - - - -
    -

    Parameters

    - -
    -
    rect
    -

    A rectangle specified in the local coordinate system (bounds) of node.

    -
    - -
    -
    node
    -

    The node with rect in its coordinate system.

    -
    - -
    - - - -
    -

    Return Value

    -

    The converted rectangle.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    convertRect:toNode:

    - - - -
    -

    Converts a rectangle from the receiver’s coordinate system to that of another view.

    -
    - - - -
    - (CGRect)convertRect:(id)rect toNode:(id)node
    - - - -
    -

    Parameters

    - -
    -
    rect
    -

    A rectangle specified in the local coordinate system (bounds) of the receiver.

    -
    - -
    -
    node
    -

    The node that is the target of the conversion operation.

    -
    - -
    - - - -
    -

    Return Value

    -

    The converted rectangle.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    init

    - - - -
    -

    Designated initializer.

    -
    - - - -
    - (id)init
    - - - - - -
    -

    Return Value

    -

    An ASDisplayNode instance whose view will be a subclass that enables asynchronous rendering, and passes -through -layout and touch handling methods.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    initWithLayerClass:

    - - - -
    -

    Alternative initializer with a layer class.

    -
    - - - -
    - (id)initWithLayerClass:(id)layerClass
    - - - -
    -

    Parameters

    - -
    -
    layerClass
    -

    Any CALayer subclass, such as CATransformLayer.

    -
    - -
    - - - -
    -

    Return Value

    -

    An ASDisplayNode instance whose layer will be of class layerClass.

    -
    - - - - - -
    -

    Discussion

    -

    If layerClass is not a subclass of _ASDisplayLayer, it will still render synchronously and -layout on the -node will not be called. -The layer instance will be created with alloc/init.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    initWithViewClass:

    - - - -
    -

    Alternative initializer with a view class.

    -
    - - - -
    - (id)initWithViewClass:(id)viewClass
    - - - -
    -

    Parameters

    - -
    -
    viewClass
    -

    Any UIView subclass, such as UIScrollView.

    -
    - -
    - - - -
    -

    Return Value

    -

    An ASDisplayNode instance whose view will be of class viewClass.

    -
    - - - - - -
    -

    Discussion

    -

    If viewClass is not a subclass of _ASDisplayView, it will still render synchronously and -layout and -touch handling methods on the node will not be called. -The view instance will be created with alloc/init.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    insertSubnode:aboveSubnode:

    - - - -
    -

    Insert a subnode after a given subnode in the list.

    -
    - - - -
    - (void)insertSubnode:(id)subnode aboveSubnode:(id)above
    - - - -
    -

    Parameters

    - -
    -
    subnode
    -

    The node to insert below another node.

    -
    - -
    -
    above
    -

    The sibling node that will be behind the inserted node.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    If the views are loaded, the subnode’s view will be inserted above the given node’s view in the hierarchy -even if there are other non-displaynode views.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    insertSubnode:atIndex:

    - - - -
    -

    Insert a subnode at a given index in subnodes.

    -
    - - - -
    - (void)insertSubnode:(id)subnode atIndex:(id)idx
    - - - -
    -

    Parameters

    - -
    -
    subnode
    -

    The node to insert.

    -
    - -
    -
    idx
    -

    The index in the array of the subnodes property at which to insert the node. Subnodes indices start at 0 -and cannot be greater than the number of subnodes.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    If this node’s view is loaded, ASDisplayNode insert the subnode’s view after the subnode at index - 1’s -view even if there are other non-displaynode views.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    insertSubnode:belowSubnode:

    - - - -
    -

    Insert a subnode before a given subnode in the list.

    -
    - - - -
    - (void)insertSubnode:(id)subnode belowSubnode:(id)below
    - - - -
    -

    Parameters

    - -
    -
    subnode
    -

    The node to insert below another node.

    -
    - -
    -
    below
    -

    The sibling node that will be above the inserted node.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    If the views are loaded, the subnode’s view will be inserted below the given node’s view in the hierarchy -even if there are other non-displaynode views.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    measure:

    - - - -
    -

    Asks the node to calculate and return the size that best fits its subnodes.

    -
    - - - -
    - (CGSize)measure:(id)constrainedSize
    - - - -
    -

    Parameters

    - -
    -
    constrainedSize
    -

    The maximum size the receiver should fit in.

    -
    - -
    - - - -
    -

    Return Value

    -

    A new size that fits the receiver’s subviews.

    -
    - - - - - -
    -

    Discussion

    -

    Though this method does not set the bounds of the view, it does have side effects–caching both the -constraint and the result.

    Warning: Subclasses must not override this; it caches results from -calculateSizeThatFits:. Calling this method may -be expensive if result is not cached.

    -
    - - - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    pointInside:withEvent:

    - - - -
    -

    Returns a Boolean value indicating whether the receiver contains the specified point.

    -
    - - - -
    - (BOOL)pointInside:(id)point withEvent:(id)event
    - - - -
    -

    Parameters

    - -
    -
    point
    -

    A point that is in the receiver’s local coordinate system (bounds).

    -
    - -
    -
    event
    -

    The event that warranted a call to this method.

    -
    - -
    - - - -
    -

    Return Value

    -

    YES if point is inside the receiver’s bounds; otherwise, NO.

    -
    - - - - - -
    -

    Discussion

    -

    Includes the “slop” factor specified with hitTestSlop.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    recursivelyReclaimMemory

    - - - -
    -

    Calls -reclaimMemory on the receiver and its subnode hierarchy.

    -
    - - - -
    - (void)recursivelyReclaimMemory
    - - - - - - - - - -
    -

    Discussion

    -

    Clears backing stores and other memory-intensive intermediates. -If the node is removed from a visible hierarchy and then re-added, it will automatically trigger a new asynchronous display, -as long as displaySuspended is not set. -If the node remains in the hierarchy throughout, -setNeedsDisplay is required to trigger a new asynchronous display.

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    recursivelySetDisplaySuspended:

    - - - -
    -

    Prevent the node and its descendants' layer from displaying.

    -
    - - - -
    - (void)recursivelySetDisplaySuspended:(id)flag
    - - - -
    -

    Parameters

    - -
    -
    flag
    -

    YES if display should be prevented or cancelled; NO otherwise.

    -
    - -
    - - - - - - - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    removeFromSupernode

    - - - -
    -

    Remove this node from its supernode.

    -
    - - - -
    - (void)removeFromSupernode
    - - - - - - - - - -
    -

    Discussion

    -

    The node’s view will be automatically removed from the supernode’s view.

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - -

    replaceSubnode:withSubnode:

    - - - -
    -

    Replace subnode with replacementSubnode.

    -
    - - - -
    - (void)replaceSubnode:(id)subnode withSubnode:(id)replacementSubnode
    - - - -
    -

    Parameters

    - -
    -
    subnode
    -

    A subnode of self.

    -
    - -
    -
    replacementSubnode
    -

    A node with which to replace subnode.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Should both subnode and replacementSubnode already be subnodes of self, subnode is removed and -replacementSubnode inserted in its place. -If subnode is not a subnode of self, this method will throw an exception. -If replacementSubnode is nil, this method will throw an exception

    -
    - - - - - - - -
    -

    Declared In

    - ASDisplayNode.h
    -
    - - -
    - -
    - - - - - - - -
    - -
    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASEditableTextNode.html b/appledoc/Classes/ASEditableTextNode.html new file mode 100644 index 00000000..99e5afc6 --- /dev/null +++ b/appledoc/Classes/ASEditableTextNode.html @@ -0,0 +1,400 @@ + + + + + + ASEditableTextNode Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASEditableTextNode Class Reference

    + + +
    + + + + + + + +
    Inherits fromASDisplayNode : ASDealloc2MainObject
    Declared inASEditableTextNode.h
    + + + + + + + + +
    + + + + + + +
    +
    + +

    – isDisplayingPlaceholder +

    + +
    +
    + +
    + + +
    +

    Indicates if the receiver is displaying the placeholder text.

    +
    + + + +
    - (BOOL)isDisplayingPlaceholder
    + + + + + +
    +

    Return Value

    +

    YES if the placeholder is currently displayed; NO otherwise.

    +
    + + + + + +
    +

    Discussion

    +

    To update the placeholder, see the attributedPlaceholderText property.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    + +

      attributedPlaceholderText +

    + +
    +
    + +
    + + +
    +

    The styled placeholder text displayed by the text node while no text is entered

    +
    + + + +
    @property (nonatomic, readwrite, strong) NSAttributedString *attributedPlaceholderText
    + + + + + + + + + +
    +

    Discussion

    +

    The placeholder is displayed when the user has not entered any text and the keyboard is not visible.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    + +

      attributedText +

    + +
    +
    + +
    + + +
    +

    The styled text displayed by the receiver.

    +
    + + + +
    @property (nonatomic, readwrite, copy) NSAttributedString *attributedText
    + + + + + + + + + +
    +

    Discussion

    +

    When the placeholder is displayed (as indicated by -isDisplayingPlaceholder), this value is nil. Otherwise, this value is the attributed text the user has entered. This value can be modified regardless of whether the receiver is the first responder (and thus, editing) or not. Changing this value from nil to non-nil will result in the placeholder being hidden, and the new value being displayed.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    + +

    – isFirstResponder +

    + +
    +
    + +
    + + +
    +

    Indicates whether the receiver’s text view is the first responder, and thus has the keyboard visible and is prepared for editing by the user.

    +
    + + + +
    - (BOOL)isFirstResponder
    + + + + + +
    +

    Return Value

    +

    YES if the receiver’s text view is the first-responder; NO otherwise.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    + +

    – frameForTextRange: +

    + +
    +
    + +
    + + +
    +

    Returns the frame of the given range of characters.

    +
    + + + +
    - (CGRect)frameForTextRange:(NSRange)textRange
    + + + +
    +

    Parameters

    + + + + + + + +
    textRange

    A range of characters.

    +
    + + + +
    +

    Return Value

    +

    A CGRect that is the bounding box of the glyphs covered by the given range of characters, in the coordinate system of the receiver.

    +
    + + + + + +
    +

    Discussion

    +

    This method raises an exception if textRange is not a valid range of characters within the receiver’s attributed text.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASImageNode.html b/appledoc/Classes/ASImageNode.html index 552e5483..43877f18 100644 --- a/appledoc/Classes/ASImageNode.html +++ b/appledoc/Classes/ASImageNode.html @@ -1,147 +1,112 @@ - + - - - ASImageNode Class Reference - - - - - - -
    - + + + + ASImageNode Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASImageNode Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromASControlNode : ASDisplayNode : ASDealloc2MainObjectInherits fromASControlNode : ASDisplayNode : ASDealloc2MainObject
    Declared inASImageNode.hDeclared inASImageNode.h
    - +
    @@ -151,574 +116,415 @@
    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    - -

    cropEnabled

    - - - -
    -

    Indicates whether efficient cropping of the receiver is enabled.

    -
    - - +
    +
    + +

      image +

    -
    @property (nonatomic, assign, getter=isCropEnabled) BOOL cropEnabled
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    Defaults to YES. See -setCropEnabled:recropImmediately:inBounds: for more -information.

    +
    + + +
    +

    The image to display.

    +
    + + + +
    @property (atomic, retain) UIImage *image
    + + + + + + + + + +
    +

    Discussion

    +

    The node will efficiently display stretchable images by using +the layer’s contentsCenter property. Non-stretchable images work too, of +course.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASImageNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - -
    - -
    +
    + +

      placeholderColor +

    + +
    +
    + +
    + + +
    +

    The placeholder color.

    +
    + + + +
    @property (nonatomic, strong) UIColor *placeholderColor
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASImageNode.h

    +
    + + +
    +
    +
    + +

      cropEnabled +

    + +
    +
    + +
    + + +
    +

    Indicates whether efficient cropping of the receiver is enabled.

    +
    + + + +
    @property (nonatomic, assign, getter=isCropEnabled) BOOL cropEnabled
    + + + + + + + + + +
    +

    Discussion

    +

    Defaults to YES. See -setCropEnabled:recropImmediately:inBounds: for more +information.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASImageNode.h

    +
    + + +
    +
    +
    + +

    – setCropEnabled:recropImmediately:inBounds: +

    + +
    +
    + +
    + + +
    +

    Enables or disables efficient cropping.

    +
    + + + +
    - (void)setCropEnabled:(BOOL)cropEnabled recropImmediately:(BOOL)recropImmediately inBounds:(CGRect)cropBounds
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    cropEnabled

    YES to efficiently crop the receiver’s contents such that +contents outside of its bounds are not included; NO otherwise.

    recropImmediately

    If the receiver has an image, YES to redisplay the +receiver immediately; NO otherwise.

    cropBounds

    The bounds into which the receiver will be cropped. Useful +if bounds are to change in response to cropping (but have not yet done so).

    +
    + + + + + + + +
    +

    Discussion

    +

    Efficient cropping is only performed when the receiver’s view’s +contentMode is UIViewContentModeScaleAspectFill. By default, cropping is +enabled. The crop alignment may be controlled via cropAlignmentFactor.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASImageNode.h

    +
    + + +
    +
    +
    -

    cropRect

    - - - -
    -

    A value that controls how the receiver’s efficient cropping is aligned.

    -
    - - +

      cropRect +

    -
    @property (nonatomic, readwrite, assign) CGRect cropRect
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    This value defines a rectangle that is to be featured by the +

    + + +
    +

    A value that controls how the receiver’s efficient cropping is aligned.

    +
    + + + +
    @property (nonatomic, readwrite, assign) CGRect cropRect
    + + + + + + + + + +
    +

    Discussion

    +

    This value defines a rectangle that is to be featured by the receiver. The rectangle is specified as a “unit rectangle,” using percentages of the source image’s width and height, e.g. CGRectMake(0.5, 0, 0.5, 1.0) will feature the full right half a photo. If the cropRect is empty, the content mode of the receiver will be used to determine its dimensions, and only the cropRect’s origin will be used for positioning. The default value of this property is CGRectMake(0.5, 0.5, 0.0, 0.0).

    -
    - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - -
    - -
    - -

    image

    - - - -
    -

    The image to display.

    -
    - - +
    + -
    @property (atomic, retain) UIImage *image
    + - - - - - - - - -
    -

    Discussion

    -

    The node will efficiently display stretchable images by using -the layer’s contentsCenter property. Non-stretchable images work too, of -course.

    + + + +
    +

    Declared In

    +

    ASImageNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - -
    - -
    +
    -

    imageModificationBlock

    - - - -
    -

    An optional block which can perform drawing operations on image +

      imageModificationBlock +

    + +
    +
    + +
    + + +
    +

    An optional block which can perform drawing operations on image during the display phase.

    -
    - - +
    + + -
    @property (nonatomic, readwrite, copy) asimagenode_modification_block_t imageModificationBlock
    +
    @property (nonatomic, readwrite, copy) asimagenode_modification_block_t imageModificationBlock
    - - - - - - - - -
    -

    Discussion

    -

    Can be used to add image effects (such as rounding, adding + + + + + + + + +

    +

    Discussion

    +

    Can be used to add image effects (such as rounding, adding borders, or other pattern overlays) without extraneous display calls.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASImageNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - -
    - -
    - -

    placeholderColor

    - - - -
    -

    The placeholder color.

    -
    - - - -
    @property (nonatomic, strong) UIColor *placeholderColor
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - -
    - -
    - -

    tint

    - - - -
    -

    Simple way to tint the image.

    -
    - - - -
    @property (nonatomic, assign) ASImageNodeTint tint
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    setCropEnabled:recropImmediately:inBounds:

    - - - -
    -

    Enables or disables efficient cropping.

    -
    - - - -
    - (void)setCropEnabled:(id)cropEnabled recropImmediately:(id)recropImmediately inBounds:(id)cropBounds
    - - - -
    -

    Parameters

    - -
    -
    cropEnabled
    -

    YES to efficiently crop the receiver’s contents such that -contents outside of its bounds are not included; NO otherwise.

    -
    - -
    -
    recropImmediately
    -

    If the receiver has an image, YES to redisplay the -receiver immediately; NO otherwise.

    -
    - -
    -
    cropBounds
    -

    The bounds into which the receiver will be cropped. Useful -if bounds are to change in response to cropping (but have not yet done so).

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Efficient cropping is only performed when the receiver’s view’s -contentMode is UIViewContentModeScaleAspectFill. By default, cropping is -enabled. The crop alignment may be controlled via cropAlignmentFactor.

    -
    - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - -
    - -
    +
    -

    setNeedsDisplayWithCompletion:

    - - - -
    -

    Marks the receiver as needing display and performs a block after +

    – setNeedsDisplayWithCompletion: +

    + +
    +
    + +
    + + +
    +

    Marks the receiver as needing display and performs a block after display has finished.

    -
    - - +
    + + -
    - (void)setNeedsDisplayWithCompletion:(id)displayCompletionBlock
    +
    - (void)setNeedsDisplayWithCompletion:(void ( ^ ) ( BOOL canceled ))displayCompletionBlock
    - - -
    -

    Parameters

    - -
    -
    displayCompletionBlock
    -

    The block to be performed after display has + + +

    +

    Parameters

    + + + + + + + +
    displayCompletionBlock

    The block to be performed after display has finished. Its canceled property will be YES if display was prevented or -canceled (via displaySuspended); NO otherwise.

    - - - - - - - - - - -
    -

    Discussion

    -

    displayCompletionBlock will be performed on the main-thread. If +canceled (via displaySuspended); NO otherwise.

    +
    + + + + + + + +
    +

    Discussion

    +

    displayCompletionBlock will be performed on the main-thread. If displaySuspended is YES, displayCompletionBlock is will be performed immediately and YES will be passed for canceled.

    -
    - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - -
    - -
    - - - - - - - -
    - -
    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASInsetLayoutSpec.html b/appledoc/Classes/ASInsetLayoutSpec.html new file mode 100644 index 00000000..7725fec3 --- /dev/null +++ b/appledoc/Classes/ASInsetLayoutSpec.html @@ -0,0 +1,214 @@ + + + + + + ASInsetLayoutSpec Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASInsetLayoutSpec Class Reference

    + + +
    + + + + + + + +
    Inherits fromASLayoutSpec : NSObject
    Declared inASInsetLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    A layout spec that wraps another layoutable child, applying insets around it.

    + +

    If the child has a size specified as a percentage, the percentage is resolved against this spec’s parent +size after applying insets.

    + +

    @example ASOuterLayoutSpec contains an ASInsetLayoutSpec with an ASInnerLayoutSpec. Suppose that: +- ASOuterLayoutSpec is 200pt wide. +- ASInnerLayoutSpec specifies its width as 100%. +- The ASInsetLayoutSpec has insets of 10pt on every side. +ASInnerLayoutSpec will have size 180pt, not 200pt, because it receives a parent size that has been adjusted for insets.

    + +

    If you’re familiar with CSS: ASInsetLayoutSpec’s child behaves similarly to “box-sizing: border-box”.

    + +

    An infinite inset is resolved as an inset equal to all remaining space after applying the other insets and child size. +@example An ASInsetLayoutSpec with an infinite left inset and 10px for all other edges will position it’s child 10px from the right edge.

    +
    + + + + + +
    + + + + + + +
    +
    + +

    + newWithInsets:child: +

    + +
    +
    + +
    + + +
    +

    The amount of space to inset on each side.

    +
    + + + +
    + (instancetype)newWithInsets:(UIEdgeInsets)insets child:(id<ASLayoutable>)child
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    insets

    The amount of space to inset on each side.

    child

    The wrapped child to inset. If nil, this method returns nil.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASInsetLayoutSpec.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASLayout.html b/appledoc/Classes/ASLayout.html new file mode 100644 index 00000000..0945645d --- /dev/null +++ b/appledoc/Classes/ASLayout.html @@ -0,0 +1,502 @@ + + + + + + ASLayout Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASLayout Class Reference

    + + +
    + + + + + + + +
    Inherits fromNSObject
    Declared inASLayout.h
    + + + + +
    + +

    Overview

    +

    Represents a computed immutable layout tree.

    +
    + + + + + +
    + + + + + + +
    +
    + +

      position +

    + +
    +
    + +
    + + +
    +

    Position in parent. Default to CGPointNull.

    +
    + + + +
    @property (nonatomic, readwrite) CGPoint position
    + + + + + + + + + +
    +

    Discussion

    +

    When being used as a sublayout, this property must not equal CGPointNull.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASLayout.h

    +
    + + +
    +
    +
    + +

      sublayouts +

    + +
    +
    + +
    + + +
    +

    Array of ASLayouts. Each must have a valid non-null position.

    +
    + + + +
    @property (nonatomic, readonly) NSArray *sublayouts
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayout.h

    +
    + + +
    +
    +
    + +

    + newWithLayoutableObject:size:position:sublayouts: +

    + +
    +
    + +
    + + +
    +

    Initializer.

    +
    + + + +
    + (instancetype)newWithLayoutableObject:(id<ASLayoutable>)layoutableObject size:(CGSize)size position:(CGPoint)position sublayouts:(NSArray *)sublayouts
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + +
    layoutableObject

    The backing ASLayoutable object.

    size

    The size of this layout.

    position

    The posiion of this layout within its parent (if available).

    sublayouts

    Sublayouts belong to the new layout.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayout.h

    +
    + + +
    +
    +
    + +

    + newWithLayoutableObject:size:sublayouts: +

    + +
    +
    + +
    + + +
    +

    Convenience initializer that has CGPointNull position. +Best used by ASDisplayNode subclasses that are manually creating a layout for -calculateLayoutThatFits:, +or for ASLayoutSpec subclasses that are referencing the “self” level in the layout tree, +or for creating a sublayout of which the position is yet to be determined.

    +
    + + + +
    + (instancetype)newWithLayoutableObject:(id<ASLayoutable>)layoutableObject size:(CGSize)size sublayouts:(NSArray *)sublayouts
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    layoutableObject

    The backing ASLayoutable object.

    size

    The size of this layout.

    sublayouts

    Sublayouts belong to the new layout.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayout.h

    +
    + + +
    +
    +
    + +

    + newWithLayoutableObject:size: +

    + +
    +
    + +
    + + +
    +

    Convenience that has CGPointNull position and no sublayouts. +Best used for creating a layout that has no sublayouts, and is either a root one +or a sublayout of which the position is yet to be determined.

    +
    + + + +
    + (instancetype)newWithLayoutableObject:(id<ASLayoutable>)layoutableObject size:(CGSize)size
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    layoutableObject

    The backing ASLayoutable object.

    size

    The size of this layout.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayout.h

    +
    + + +
    +
    +
    + +

    – flattenedLayoutUsingPredicateBlock: +

    + +
    +
    + +
    + + +
    +

    Evaluates a given predicate block against each object in the receiving layout tree +and returns a new, 1-level deep layout containing the objects for which the predicate block returns true.

    +
    + + + +
    - (ASLayout *)flattenedLayoutUsingPredicateBlock:(BOOL ( ^ ) ( ASLayout *evaluatedLayout ))predicateBlock
    + + + +
    +

    Parameters

    + + + + + + + +
    predicateBlock

    The block is applied to a layout to be evaluated. +The block takes 1 argument: evaluatedLayout - the layout to be evaluated. +The block returns YES if evaluatedLayout evaluates to true, otherwise NO.

    +
    + + + +
    +

    Return Value

    +

    A new, 1-level deep layout containing the layouts for which the predicate block returns true.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayout.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASLayoutSpec.html b/appledoc/Classes/ASLayoutSpec.html new file mode 100644 index 00000000..40b44aad --- /dev/null +++ b/appledoc/Classes/ASLayoutSpec.html @@ -0,0 +1,124 @@ + + + + + + ASLayoutSpec Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASLayoutSpec Class Reference

    + + +
    + + + + + + + + + + +
    Inherits fromNSObject
    Conforms toASLayoutable
    Declared inASLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    A layout spec is an immutable object that describes a layout, loosely inspired by React.

    +
    + + + + + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASMultiplexImageNode.html b/appledoc/Classes/ASMultiplexImageNode.html index 59f768f5..451cd9f7 100644 --- a/appledoc/Classes/ASMultiplexImageNode.html +++ b/appledoc/Classes/ASMultiplexImageNode.html @@ -1,147 +1,114 @@ - + - - - ASMultiplexImageNode Class Reference - - - - - - -
    - + + + + ASMultiplexImageNode Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASMultiplexImageNode Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromASImageNode : ASControlNode : ASDisplayNode : ASDealloc2MainObjectInherits fromASImageNode : ASControlNode : ASDisplayNode : ASDealloc2MainObject
    Declared inASMultiplexImageNode.hDeclared inASMultiplexImageNode.h
    - +
    @@ -152,555 +119,435 @@ identifier, the data source can either return a UIImage directly, or a URL the i
    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    - -

    dataSource

    - - - -
    -

    The data source, which must conform to the ASMultiplexImageNodeDataSource protocol.

    -
    - - +
    +
    + +

    – initWithCache:downloader: +

    -
    @property (nonatomic, readwrite, weak) id<ASMultiplexImageNodeDataSource> dataSource
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    This value is required for ASMultiplexImageNode to load images.

    +
    + + +
    +

    The designated initializer.

    +
    + + + +
    - (instancetype)initWithCache:(id<ASImageCacheProtocol>)cache downloader:(id<ASImageDownloaderProtocol>)downloader
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    cache

    The object that implements a cache of images for the image node.

    downloader

    The object that implements image downloading for the image node.

    +
    + + + +
    +

    Return Value

    +

    An initialized ASMultiplexImageNode.

    +
    + + + + + +
    +

    Discussion

    +

    If cache is nil, the receiver will not attempt to retrieve images from a cache before downloading them.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASMultiplexImageNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    +
    -

    delegate

    - - - -
    -

    The delegate, which must conform to the ASMultiplexImageNodeDelegate protocol.

    -
    - - +

      delegate +

    -
    @property (nonatomic, readwrite, weak) id<ASMultiplexImageNodeDelegate> delegate
    +
    +
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - -

    displayedImageIdentifier

    - - - -
    -

    The identifier for the image that the receiver is currently displaying, or nil.

    -
    - - +
    + + +
    +

    The delegate, which must conform to the ASMultiplexImageNodeDelegate protocol.

    +
    + + -
    @property (nonatomic, readonly) id displayedImageIdentifier
    +
    @property (nonatomic, readwrite, weak) id<ASMultiplexImageNodeDelegate> delegate
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASMultiplexImageNode.h

    +
    + + +
    +
    +
    + +

      dataSource +

    + +
    +
    + +
    + + +
    +

    The data source, which must conform to the ASMultiplexImageNodeDataSource protocol.

    +
    + + + +
    @property (nonatomic, readwrite, weak) id<ASMultiplexImageNodeDataSource> dataSource
    + + + + + + + + + +
    +

    Discussion

    +

    This value is required for ASMultiplexImageNode to load images.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASMultiplexImageNode.h

    +
    + + +
    +
    +
    -

    downloadsIntermediateImages

    - - - -
    -

    Whether the receiver should download more than just its highest-quality image. Defaults to NO.

    -
    - - +

      downloadsIntermediateImages +

    -
    @property (nonatomic, readwrite, assign) BOOL downloadsIntermediateImages
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    ASMultiplexImageNode immediately loads and displays the first image specified in imageIdentifiers (its +

    + + +
    +

    Whether the receiver should download more than just its highest-quality image. Defaults to NO.

    +
    + + + +
    @property (nonatomic, readwrite, assign) BOOL downloadsIntermediateImages
    + + + + + + + + + +
    +

    Discussion

    +

    ASMultiplexImageNode immediately loads and displays the first image specified in imageIdentifiers (its highest-quality image). If that image is not immediately available or cached, the node can download and display lesser-quality images. Set downloadsIntermediateImages to YES to enable this behaviour.

    -
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - -

    imageIdentifiers

    - - - -
    -

    An array of identifiers representing various versions of an image for ASMultiplexImageNode to display.

    -
    - - - -
    @property (nonatomic, readwrite, copy) NSArray *imageIdentifiers
    - - - - - - - - - -
    -

    Discussion

    -

    An identifier can be any object that conforms to NSObject and NSCopying. The array should be in -decreasing order of image quality – that is, the first identifier in the array represents the best version.

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - -

    loadedImageIdentifier

    - - - -
    -

    The identifier for the last image that the receiver loaded, or nil.

    -
    - - - -
    @property (nonatomic, readonly) id loadedImageIdentifier
    - - - - - - - - - -
    -

    Discussion

    -

    This value may differ from displayedImageIdentifier if the image hasn’t yet been displayed.

    -
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    initWithCache:downloader:

    - - - -
    -

    The designated initializer.

    -
    - - - -
    - (instancetype)initWithCache:(id)cache downloader:(id)downloader
    - - - -
    -

    Parameters

    - -
    -
    cache
    -

    The object that implements a cache of images for the image node.

    -
    - -
    -
    downloader
    -

    The object that implements image downloading for the image node.

    -
    - -
    - - - -
    -

    Return Value

    -

    An initialized ASMultiplexImageNode.

    -
    - - - - - -
    -

    Discussion

    -

    If cache is nil, the receiver will not attempt to retrieve images from a cache before downloading them.

    -
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - -

    reloadImageIdentifierSources

    - - - -
    -

    Notify the receiver that its data source has new UIImages or NSURLs available for imageIdentifiers.

    -
    - - - -
    - (void)reloadImageIdentifierSources
    - - - - - - - - - -
    -

    Discussion

    -

    If a higher-quality image than is currently displayed is now available, it will be loaded.

    -
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - - - - - - - -
    - -
    -
    - - +
    +

    Notify the receiver that its data source has new UIImages or NSURLs available for imageIdentifiers.

    +
    + + + +
    - (void)reloadImageIdentifierSources
    + + + + + + + + + +
    +

    Discussion

    +

    If a higher-quality image than is currently displayed is now available, it will be loaded.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASMultiplexImageNode.h

    +
    + + +
    +
    +
    + +

      loadedImageIdentifier +

    + +
    +
    + +
    + + +
    +

    The identifier for the last image that the receiver loaded, or nil.

    +
    + + + +
    @property (nonatomic, readonly) id loadedImageIdentifier
    + + + + + + + + + +
    +

    Discussion

    +

    This value may differ from displayedImageIdentifier if the image hasn’t yet been displayed.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASMultiplexImageNode.h

    +
    + + +
    +
    +
    + +

      displayedImageIdentifier +

    + +
    +
    + +
    + + +
    +

    The identifier for the image that the receiver is currently displaying, or nil.

    +
    + + + +
    @property (nonatomic, readonly) id displayedImageIdentifier
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASMultiplexImageNode.h

    +
    + + +
    +
    +
    + + + + + + + + + + + + + + +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASNetworkImageNode.html b/appledoc/Classes/ASNetworkImageNode.html index 7f8dd40d..aa06c4f1 100644 --- a/appledoc/Classes/ASNetworkImageNode.html +++ b/appledoc/Classes/ASNetworkImageNode.html @@ -1,143 +1,112 @@ - + - - - ASNetworkImageNode Class Reference - - - - - - -
    - + + + + ASNetworkImageNode Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASNetworkImageNode Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromASImageNode : ASControlNode : ASDisplayNode : ASDealloc2MainObjectInherits fromASImageNode : ASControlNode : ASDisplayNode : ASDealloc2MainObject
    Declared inASNetworkImageNode.hDeclared inASNetworkImageNode.h
    - +
    @@ -149,496 +118,384 @@ placeholder image (defaultImage). The cu
    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    - -

    URL

    - - - -
    -

    The URL of a new image to download and display.

    -
    - - - -
    @property (atomic, strong, readwrite) NSURL *URL
    - - - - - - - - - -
    -

    Discussion

    -

    Changing this property will reset the displayed image to a placeholder (defaultImage) while loading.

    -
    - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    - -

    defaultImage

    - - - -
    -

    A placeholder image to display while the URL is loading.

    -
    - - - -
    @property (atomic, strong, readwrite) UIImage *defaultImage
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    - -

    delegate

    - - - -
    -

    The delegate, which must conform to the ASNetworkImageNodeDelegate protocol.

    -
    - - - -
    @property (atomic, weak, readwrite) id<ASNetworkImageNodeDelegate> delegate
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    - -

    shouldCacheImage

    - - - -
    -

    If URL is a local file, set this property to YES to take advantage of UIKit’s image cacheing. Defaults to YES.

    -
    - - - -
    @property (nonatomic, assign, readwrite) BOOL shouldCacheImage
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    init

    - - - -
    -

    Convenience initialiser.

    -
    - - - -
    - (instancetype)init
    - - - - - -
    -

    Return Value

    -

    An ASNetworkImageNode configured to use the NSURLSession-powered ASBasicImageDownloader, and no extra cache.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    +
    +
    -

    initWithCache:downloader:

    - - - -
    -

    The designated initializer.

    -
    - - +

    – initWithCache:downloader: +

    -
    - (instancetype)initWithCache:(id)cache downloader:(id)downloader
    +
    +
    - - -
    -

    Parameters

    - -
    -
    cache
    -

    The object that implements a cache of images for the image node.

    -
    - -
    -
    downloader
    -

    The object that implements image downloading for the image node. Must not be nil.

    -
    - -
    - - - -
    -

    Return Value

    -

    An initialized ASNetworkImageNode.

    -
    - - - - - -
    -

    Discussion

    -

    If cache is nil, the receiver will not attempt to retrieve images from a cache before downloading them.

    -
    - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    - -

    setURL:resetToDefault:

    - - - -
    -

    Download and display a new image.

    -
    - - - -
    - (void)setURL:(id)URL resetToDefault:(id)reset
    - - - -
    -

    Parameters

    - -
    -
    reset
    -

    Whether to display a placeholder (defaultImage) while loading the new image.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    The designated initializer.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASOverlayLayoutSpec.html b/appledoc/Classes/ASOverlayLayoutSpec.html new file mode 100644 index 00000000..12fe312f --- /dev/null +++ b/appledoc/Classes/ASOverlayLayoutSpec.html @@ -0,0 +1,121 @@ + + + + + + ASOverlayLayoutSpec Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASOverlayLayoutSpec Class Reference

    + + +
    + + + + + + + +
    Inherits fromASLayoutSpec : NSObject
    Declared inASOverlayLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    This layout spec lays out a single layoutable child and then overlays a layoutable object on top of it streched to its size

    +
    + + + + + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASRangeController.html b/appledoc/Classes/ASRangeController.html index 610263ab..c77f7f26 100644 --- a/appledoc/Classes/ASRangeController.html +++ b/appledoc/Classes/ASRangeController.html @@ -1,130 +1,107 @@ - + - - - ASRangeController Class Reference - - - - - - -
    - + + + + ASRangeController Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASRangeController Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + + - - + +
    Inherits fromASDealloc2MainObjectInherits fromASDealloc2MainObject
    Conforms toASDataControllerDelegateConforms toASDataControllerDelegate
    Declared inASRangeController.hDeclared inASRangeController.h
    - +
    @@ -132,313 +109,212 @@

    Overview

    Working range controller.

    -

    Used internally by ASTableView and potentially by a future ASCollectionView. Observes the visible range, maintains -a working range, and is responsible for handling AsyncDisplayKit machinery (sizing cell nodes, enqueueing and -cancelling their asynchronous layout and display, and so on).

    +

    Used internally by ASTableView and ASCollectionView. It is paired with ASDataController. +It is designed to support custom scrolling containers as well. Observes the visible range, maintains +“working ranges” to trigger network calls and rendering, and is responsible for driving asynchronous layout of cells. +This includes cancelling those asynchronous operations as cells fall outside of the working ranges.

    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    - -

    delegate

    - - - -
    -

    Delegate and ultimate data source. Must not be nil.

    -
    - - - -
    @property (nonatomic, weak) id<ASRangeControllerDelegate> delegate
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    configureContentView:forCellNode:

    - - - -
    -

    Add the sized node for indexPath as a subview of contentView.

    -
    - - - -
    - (void)configureContentView:(id)contentView forCellNode:(id)node
    - - - -
    -

    Parameters

    - -
    -
    contentView
    -

    UIView to add a (sized) node’s view to.

    -
    - -
    -
    node
    -

    The ASCellNode to be added.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    +
    +
    -

    visibleNodeIndexPathsDidChangeWithScrollDirection:

    - - - -
    -

    Notify the receiver that the visible range has been updated.

    -
    - - +

    – visibleNodeIndexPathsDidChangeWithScrollDirection: +

    -
    - (void)visibleNodeIndexPathsDidChangeWithScrollDirection:(id)scrollDirection
    +
    +
    - - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    +

    Notify the range controller that the visible range has been updated. +This is the primary input call that drives updating the working ranges, and triggering their actions.

    -
    - - +
    +

    Add the sized node for indexPath as a subview of contentView.

    +
    + + + +
    - (void)configureContentView:(UIView *)contentView forCellNode:(ASCellNode *)node
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    contentView

    UIView to add a (sized) node’s view to.

    node

    The ASCellNode to be added.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASRangeController.h

    +
    + + +
    +
    +
    + +

      delegate +

    + +
    +
    + +
    + + +
    +

    Delegate and ultimate data source. Must not be nil.

    +
    + + + +
    @property (nonatomic, weak) id<ASRangeControllerDelegate> delegate
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASRangeController.h

    +
    + + +
    +
    +
    + + + + + + + + + + + + + + +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASRatioLayoutSpec.html b/appledoc/Classes/ASRatioLayoutSpec.html new file mode 100644 index 00000000..4632b7a1 --- /dev/null +++ b/appledoc/Classes/ASRatioLayoutSpec.html @@ -0,0 +1,139 @@ + + + + + + ASRatioLayoutSpec Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASRatioLayoutSpec Class Reference

    + + +
    + + + + + + + +
    Inherits fromASLayoutSpec : NSObject
    Declared inASRatioLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    Ratio layout spec +For when the content should respect a certain inherent ratio but can be scaled (think photos or videos) +The ratio passed is the ratio of height / width you expect

    + +

    For a ratio 0.5, the spec will have a flat rectangle shape

    + +
    + +

    | | +| _ _ |

    + +

    For a ratio 2.0, the spec will be twice as tall as it is wide + _ _ +| | +| | +| | +| |

    + +

    *

    +
    + + + + + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASScrollNode.html b/appledoc/Classes/ASScrollNode.html new file mode 100644 index 00000000..862a142e --- /dev/null +++ b/appledoc/Classes/ASScrollNode.html @@ -0,0 +1,183 @@ + + + + + + ASScrollNode Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASScrollNode Class Reference

    + + +
    + + + + + + + +
    Inherits fromASDisplayNode : ASDealloc2MainObject
    Declared inASScrollNode.h
    + + + + +
    + +

    Overview

    +

    Simple node that wraps UIScrollView.

    +
    + + + + + +
    + + + + + + +
    +
    + +

      view +

    + +
    +
    + +
    + + +
    +

    The node’s UIScrollView.

    +
    + + + +
    @property (nonatomic, readonly, strong) UIScrollView *view
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASScrollNode.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASStackLayoutSpec.html b/appledoc/Classes/ASStackLayoutSpec.html new file mode 100644 index 00000000..3843606f --- /dev/null +++ b/appledoc/Classes/ASStackLayoutSpec.html @@ -0,0 +1,228 @@ + + + + + + ASStackLayoutSpec Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASStackLayoutSpec Class Reference

    + + +
    + + + + + + + +
    Inherits fromASLayoutSpec : NSObject
    Declared inASStackLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    A simple layout spec that stacks a list of children vertically or horizontally.

    + +
      +
    • All children are initially laid out with the an infinite available size in the stacking direction.
    • +
    • In the other direction, this spec’s constraint is passed.
    • +
    • The children’s sizes are summed in the stacking direction. + +
        +
      • If this sum is less than this spec’s minimum size in stacking direction, children with flexGrow are flexed.
      • +
      • If it is greater than this spec’s maximum size in the stacking direction, children with flexShrink are flexed.
      • +
      • If, even after flexing, the sum is still greater than this spec’s maximum size in the stacking direction, +justifyContent determines how children are laid out.
      • +
      +
    • +
    + + +

    For example:

    + +
      +
    • Suppose stacking direction is Vertical, min-width=100, max-width=300, min-height=200, max-height=500.
    • +
    • All children are laid out with min-width=100, max-width=300, min-height=0, max-height=INFINITY.
    • +
    • If the sum of the childrens' heights is less than 200, children with flexGrow are flexed larger.
    • +
    • If the sum of the childrens' heights is greater than 500, children with flexShrink are flexed smaller. + Each child is shrunk by ((sum of heights) - 500)/(number of flexShrink-able children).
    • +
    • If the sum of the childrens' heights is greater than 500 even after flexShrink-able children are flexed, + justifyContent determines how children are laid out.
    • +
    + +
    + + + + + +
    + + + + + + +
    +
    + +

    + newWithStyle:children: +

    + +
    +
    + +
    + + +
    +

    Specifies how children are laid out.

    +
    + + + +
    + (instancetype)newWithStyle:(ASStackLayoutSpecStyle)style children:(NSArray *)children
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    style

    Specifies how children are laid out.

    children

    ASLayoutable children to be positioned.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASStackLayoutSpec.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASStaticLayoutSpec.html b/appledoc/Classes/ASStaticLayoutSpec.html new file mode 100644 index 00000000..848e1d01 --- /dev/null +++ b/appledoc/Classes/ASStaticLayoutSpec.html @@ -0,0 +1,197 @@ + + + + + + ASStaticLayoutSpec Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASStaticLayoutSpec Class Reference

    + + +
    + + + + + + + +
    Inherits fromASLayoutSpec : NSObject
    Declared inASStaticLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    A layout spec that positions children at fixed positions.

    + +

    Computes a size that is the union of all childrens' frames.

    +
    + + + + + +
    + + + + + + +
    +
    + +

    + newWithChildren: +

    + +
    +
    + +
    + + +
    +

    Children to be positioned at fixed positions, each is of type ASStaticLayoutSpecChild.

    +
    + + + +
    + (instancetype)newWithChildren:(NSArray *)children
    + + + +
    +

    Parameters

    + + + + + + + +
    children

    Children to be positioned at fixed positions, each is of type ASStaticLayoutSpecChild.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASStaticLayoutSpec.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASStaticLayoutSpecChild.html b/appledoc/Classes/ASStaticLayoutSpecChild.html new file mode 100644 index 00000000..99674d28 --- /dev/null +++ b/appledoc/Classes/ASStaticLayoutSpecChild.html @@ -0,0 +1,314 @@ + + + + + + ASStaticLayoutSpecChild Class Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASStaticLayoutSpecChild Class Reference

    + + +
    + + + + + + + +
    Inherits fromNSObject
    Declared inASStaticLayoutSpec.h
    + + + + +
    + +

    Overview

    +

    An ASStaticLayoutSpecChild object wraps an ASLayoutable object and provides position and size information, +to be used as a child of an ASStaticLayoutSpec.

    +
    + + + + + +
    + + + + + + +
    +
    + +

      size +

    + +
    +
    + +
    + + +
    +

    If specified, the child’s size is restricted according to this size. Percentages are resolved relative to the static layout spec.

    +
    + + + +
    @property (nonatomic, readonly) ASRelativeSizeRange size
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASStaticLayoutSpec.h

    +
    + + +
    +
    +
    + +

    + newWithPosition:layoutableObject:size: +

    + +
    +
    + +
    + + +
    +

    Initializer.

    +
    + + + +
    + (instancetype)newWithPosition:(CGPoint)position layoutableObject:(id<ASLayoutable>)layoutableObject size:(ASRelativeSizeRange)size
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    position

    The position of this child within its parent spec.

    layoutableObject

    The backing ASLayoutable object of this child.

    size

    The size range that this child’s size is trstricted according to.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASStaticLayoutSpec.h

    +
    + + +
    +
    +
    + +

    + newWithPosition:layoutableObject: +

    + +
    +
    + +
    + + +
    +

    Convenience initializer with default size is Unconstrained in both dimensions, which sets the child’s min size to zero +and max size to the maximum available space it can consume without overflowing the spec’s bounds.

    +
    + + + +
    + (instancetype)newWithPosition:(CGPoint)position layoutableObject:(id<ASLayoutable>)layoutableObject
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    position

    The position of this child within its parent spec.

    layoutableObject

    The backing ASLayoutable object of this child.

    +
    + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASStaticLayoutSpec.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Classes/ASTableView.html b/appledoc/Classes/ASTableView.html index a22d674a..466cce59 100644 --- a/appledoc/Classes/ASTableView.html +++ b/appledoc/Classes/ASTableView.html @@ -1,135 +1,132 @@ - + - - - ASTableView Class Reference - - - - - - -
    - + + + + ASTableView Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASTableView Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromUITableViewInherits fromUITableView
    Declared inASTableView.hDeclared inASTableView.h
    - +
    @@ -142,394 +139,1058 @@ pre-rendering instead of synchronously loading UITableViewCells.

    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    - -

    rangeTuningParameters

    - - - -
    -

    Tuning parameters for the working range.

    -
    - - +
    +
    + +

    – tuningParametersForRangeType: +

    -
    @property (nonatomic, assign) ASRangeTuningParameters rangeTuningParameters
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    Defaults to a trailing buffer of one screenful and a leading buffer of two screenfuls.

    -
    - - - - - - - -
    -

    Declared In

    - ASTableView.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    beginUpdates

    - - - -
    -

    We don’t support the these methods for animation yet.

    -
    - - - -
    - (void)beginUpdates
    - - - - - - - - - -
    -

    Discussion

    -

    TODO: support animations.

    -
    - - - - - - - -
    -

    Declared In

    - ASTableView.h
    -
    - - -
    - -
    - -

    insertRowsAtIndexPaths:withRowAnimation:

    - - - -
    -

    Row updating.

    -
    - - - -
    - (void)insertRowsAtIndexPaths:(id)indexPaths withRowAnimation:(id)animation
    - - - - - - - - - -
    -

    Discussion

    -

    All operations are asynchronous and thread safe. You can call it from background thread (it is recommendated) and the UI collection -view will be updated asynchronously. The asyncDataSource must be updated to reflect the changes before these methods are called.

    -
    - - - - - - - -
    -

    Declared In

    - ASTableView.h
    -
    - - -
    - -
    - -

    insertSections:withRowAnimation:

    - - - -
    -

    Section updating.

    -
    - - - -
    - (void)insertSections:(id)sections withRowAnimation:(id)animation
    - - - - - - - - - -
    -

    Discussion

    -

    All operations are asynchronous and thread safe. You can call it from background thread (it is recommendated) and the UI collection -view will be updated asynchronously. The asyncDataSource must be updated to reflect the changes before these methods are called.

    -
    - - - - - - - -
    -

    Declared In

    - ASTableView.h
    -
    - - -
    - -
    - -

    reloadData

    - - - -
    -

    Reload everything from scratch, destroying the working range and all cached nodes.

    -
    - - - -
    - (void)reloadData
    - - - - - - - - - -
    -

    Discussion

    -

    Warning: This method is substantially more expensive than UITableView’s version.

    -
    - - - - - - - -
    -

    Declared In

    - ASTableView.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    Tuning parameters for a range.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASTextCellNode.html b/appledoc/Classes/ASTextCellNode.html index 4f2b977e..92ed89a0 100644 --- a/appledoc/Classes/ASTextCellNode.html +++ b/appledoc/Classes/ASTextCellNode.html @@ -1,112 +1,96 @@ - + - - - ASTextCellNode Class Reference - - - - - - -
    - + + + + ASTextCellNode Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASTextCellNode Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromASCellNode : ASDisplayNode : ASDealloc2MainObjectInherits fromASCellNode : ASDisplayNode : ASDealloc2MainObject
    Declared inASCellNode.hDeclared inASCellNode.h
    - +
    @@ -116,193 +100,84 @@
    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    +
    +
    -

    text

    - - - -
    -

    Text to display.

    -
    - - +

      text +

    -
    @property (nonatomic, copy) NSString *text
    +
    +
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASCellNode.h
    -
    - - -
    - -
    - - - - - - - - - - - -
    - - +
    + + +
    +

    Text to display.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Classes/ASTextNode.html b/appledoc/Classes/ASTextNode.html index ff85340d..4a1b63b4 100644 --- a/appledoc/Classes/ASTextNode.html +++ b/appledoc/Classes/ASTextNode.html @@ -1,191 +1,142 @@ - + - - - ASTextNode Class Reference - - - - - - -
    - + + + + ASTextNode Class Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASTextNode Class Reference

    - - -
  • Tasks
      - -
  • - - - - - -
  • Properties
  • - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Inherits fromASControlNode : ASDisplayNode : ASDealloc2MainObjectInherits fromASControlNode : ASDisplayNode : ASDealloc2MainObject
    Declared inASTextNode.hDeclared inASTextNode.h
    - +
    @@ -195,1084 +146,1085 @@
    - +
    -

    Tasks

    - + - - -
    - - - - - -
    - -

    Properties

    - -
    - -

    additionalTruncationMessage

    - - - -
    -

    @summary The second attributed string appended for truncation.

    -
    - - - -
    @property (nonatomic, copy) NSAttributedString *additionalTruncationMessage
    - - - - - - - - - -
    -

    Discussion

    -

    This string will be highlighted on touches. -@default nil

    -
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    +
    +
    -

    attributedString

    - - - -
    -

    The attributed string to show.

    -
    - - +

      attributedString +

    -
    @property (nonatomic, copy) NSAttributedString *attributedString
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    Defaults to nil, no text is shown. +

    + + +
    +

    The attributed string to show.

    +
    + + + +
    @property (nonatomic, copy) NSAttributedString *attributedString
    + + + + + + + + + +
    +

    Discussion

    +

    Defaults to nil, no text is shown. For inline image attachments, add an attribute of key NSAttachmentAttributeName, with a value of an NSTextAttachment.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    delegate

    - - - -
    -

    Responds to actions from links in the text node.

    -
    - - +
    + +

      truncationAttributedString +

    -
    @property (nonatomic, weak) id<ASTextNodeDelegate> delegate
    +
    +
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    highlightRange

    - - - -
    -

    The range of text highlighted by the receiver. Changes to this property are not animated by default.

    -
    - - +
    + + +
    +

    The attributedString to use when the text must be truncated.

    +
    + + -
    @property (nonatomic, assign) NSRange highlightRange
    +
    @property (nonatomic, copy) NSAttributedString *truncationAttributedString
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    highlightStyle

    - - - -
    -

    The style to use when highlighting text.

    -
    - - + + -
    @property (nonatomic, assign) ASTextNodeHighlightStyle highlightStyle
    + - - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    + + + +
    +

    Discussion

    +

    Defaults to a localized ellipsis character.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    +
    +
    + +

      additionalTruncationMessage +

    + +
    +
    + +
    + + +
    +

    @summary The second attributed string appended for truncation.

    +
    + + + +
    @property (nonatomic, copy) NSAttributedString *additionalTruncationMessage
    + + + + + + + + + +
    +

    Discussion

    +

    This string will be highlighted on touches. +@default nil

    +
    + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    +
    +
    + +

      truncationMode +

    + +
    +
    + +
    + + +
    +

    Determines how the text is truncated to fit within the receiver’s maximum size.

    +
    + + + +
    @property (nonatomic, assign) NSLineBreakMode truncationMode
    + + + + + + + + + +
    +

    Discussion

    +

    Defaults to NSLineBreakByWordWrapping.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    +
    +
    + +

      truncated +

    + +
    +
    + +
    + + +
    +

    If the text node is truncated. Text must have been sized first.

    +
    + + + +
    @property (nonatomic, readonly, assign, getter=isTruncated) BOOL truncated
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    +
    +
    + +

      maximumLineCount +

    + +
    +
    + +
    + + +
    +

    The maximum number of lines to render of the text before truncation. +@default 0 (No limit)

    +
    + + + +
    @property (nonatomic, assign) NSUInteger maximumLineCount
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    +
    +
    -

    lineCount

    - - - -
    -

    The number of lines in the text. Text must have been sized first.

    -
    - - +

      lineCount +

    -
    @property (nonatomic, readonly, assign) NSUInteger lineCount
    +
    +
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    linkAttributeNames

    - - - -
    -

    The set of attribute names to consider links. Defaults to NSLinkAttributeName.

    -
    - - +
    + + +
    +

    The number of lines in the text. Text must have been sized first.

    +
    + + -
    @property (nonatomic, copy) NSArray *linkAttributeNames
    +
    @property (nonatomic, readonly, assign) NSUInteger lineCount
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    +
    +
    -

    placeholderColor

    - - - -
    -

    The placeholder color.

    -
    - - +

      placeholderColor +

    -
    @property (nonatomic, strong) UIColor *placeholderColor
    +
    +
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    +
    + + +
    +

    The placeholder color.

    +
    + + + +
    @property (nonatomic, strong) UIColor *placeholderColor
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    +
    +
    -

    placeholderInsets

    - - - -
    -

    Inset each line of the placeholder.

    -
    - - +

      placeholderInsets +

    -
    @property (nonatomic, assign) UIEdgeInsets placeholderInsets
    +
    +
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    +
    + + +
    +

    Inset each line of the placeholder.

    +
    + + + +
    @property (nonatomic, assign) UIEdgeInsets placeholderInsets
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    +
    +
    -

    shadowPadding

    - - - -
    -

    The number of pixels used for shadow padding on each side of the receiver.

    -
    - - +

      shadowPadding +

    -
    @property (nonatomic, readonly, assign) UIEdgeInsets shadowPadding
    +
    +
    - - - - - - - - -
    -

    Discussion

    -

    Each inset will be less than or equal to zero, so that applying +

    + + +
    +

    The number of pixels used for shadow padding on each side of the receiver.

    +
    + + + +
    @property (nonatomic, readonly, assign) UIEdgeInsets shadowPadding
    + + + + + + + + + +
    +

    Discussion

    +

    Each inset will be less than or equal to zero, so that applying UIEdgeInsetsRect(boundingRectForText, shadowPadding) will return a CGRect large enough to fit both the text and the appropriate shadow padding.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    truncated

    - - - -
    -

    If the text node is truncated. Text must have been sized first.

    -
    - - +
    + +

    – rectsForTextRange: +

    -
    @property (nonatomic, readonly, assign, getter=isTruncated) BOOL truncated
    +
    +
    - - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    truncationAttributedString

    - - - -
    -

    The attributedString to use when the text must be truncated.

    -
    - - +
    + + +
    +

    Returns an array of rects bounding the characters in a given text range.

    +
    + + -
    @property (nonatomic, copy) NSAttributedString *truncationAttributedString
    +
    - (NSArray *)rectsForTextRange:(NSRange)textRange
    - - - - - - - - -
    -

    Discussion

    -

    Defaults to a localized ellipsis character.

    + + +
    +

    Parameters

    + + + + + + + +
    textRange

    A range of text. Must be valid for the receiver’s string.

    +
    + + + + + + + +
    +

    Discussion

    +

    Use this method to detect all the different rectangles a given range of text occupies. +The rects returned are not guaranteed to be contiguous (for example, if the given text range spans +a line break, the rects returned will be on opposite sides and different lines). The rects returned +are in the coordinate system of the receiver.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASTextNode.h

    +
    + + +
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    truncationMode

    - - - -
    -

    Determines how the text is truncated to fit within the receiver’s maximum size.

    -
    - - - -
    @property (nonatomic, assign) NSLineBreakMode truncationMode
    - - - - - - - - - -
    -

    Discussion

    -

    Defaults to NSLineBreakByWordWrapping.

    -
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - - - - - -
    - -

    Instance Methods

    - -
    - -

    frameForTextRange:

    - - - -
    -

    Returns a bounding rect for the given text range.

    -
    - - - -
    - (CGRect)frameForTextRange:(id)textRange
    - - - -
    -

    Parameters

    - -
    -
    textRange
    -

    A range of text. Must be valid for the receiver’s string.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    The height of the frame returned is that of the receiver’s line-height; adjustment for -cap-height and descenders is not performed. This method raises an exception if textRange is not -a valid substring range of the receiver’s string.

    -
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    +
    -

    highlightRectsForTextRange:

    - - - -
    -

    Returns an array of rects used for highlighting the characters in a given text range.

    -
    - - +

    – highlightRectsForTextRange: +

    -
    - (NSArray *)highlightRectsForTextRange:(id)textRange
    +
    +
    - - -
    -

    Parameters

    - -
    -
    textRange
    -

    A range of text. Must be valid for the receiver’s string.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Use this method to detect all the different rectangles the highlights of a given range of text occupies. +

    + + +
    +

    Returns an array of rects used for highlighting the characters in a given text range.

    +
    + + + +
    - (NSArray *)highlightRectsForTextRange:(NSRange)textRange
    + + + +
    +

    Parameters

    + + + + + + + +
    textRange

    A range of text. Must be valid for the receiver’s string.

    +
    + + + + + + + +
    +

    Discussion

    +

    Use this method to detect all the different rectangles the highlights of a given range of text occupies. The rects returned are not guaranteed to be contiguous (for example, if the given text range spans a line break, the rects returned will be on opposite sides and different lines). The rects returned are in the coordinate system of the receiver. This method is useful for visual coordination with a highlighted range of text.

    -
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    linkAttributeValueAtPoint:attributeName:range:

    - - - -
    -

    Indicates whether the receiver has an entity at a given point.

    -
    - - - -
    - (id)linkAttributeValueAtPoint:(id)point attributeName:(id)attributeNameOut range:(id)rangeOut
    - - - -
    -

    Parameters

    - -
    -
    point
    -

    The point, in the receiver’s coordinate system.

    -
    - -
    -
    attributeNameOut
    -

    The name of the attribute at the point. Can be NULL.

    -
    - -
    -
    rangeOut
    -

    The ultimate range of the found text. Can be NULL.

    -
    - -
    - - - -
    -

    Return Value

    -

    YES if an entity exists at point; NO otherwise.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    rectsForTextRange:

    - - - -
    -

    Returns an array of rects bounding the characters in a given text range.

    -
    - - - -
    - (NSArray *)rectsForTextRange:(id)textRange
    - - - -
    -

    Parameters

    - -
    -
    textRange
    -

    A range of text. Must be valid for the receiver’s string.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Use this method to detect all the different rectangles a given range of text occupies. -The rects returned are not guaranteed to be contiguous (for example, if the given text range spans -a line break, the rects returned will be on opposite sides and different lines). The rects returned -are in the coordinate system of the receiver.

    -
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    setHighlightRange:animated:

    - - - -
    -

    Set the range of text to highlight, with optional animation.

    -
    - - - -
    - (void)setHighlightRange:(id)highlightRange animated:(id)animated
    - - - -
    -

    Parameters

    - -
    -
    highlightRange
    -

    The range of text to highlight.

    -
    - -
    -
    animated
    -

    Whether the text should be highlighted with an animation.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    trailingRect

    - - - -
    -

    Returns the trailing rectangle of space in the receiver, after the final character.

    -
    - - - -
    - (CGRect)trailingRect
    - - - - - - - - - -
    -

    Discussion

    -

    Use this method to detect which portion of the receiver is not occupied by characters. -The rect returned is in the coordinate system of the receiver.

    -
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - - - - - - - -
    - -
    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Constants/ASCenterLayoutSpecCenteringOptions.html b/appledoc/Constants/ASCenterLayoutSpecCenteringOptions.html new file mode 100644 index 00000000..6b9c2d26 --- /dev/null +++ b/appledoc/Constants/ASCenterLayoutSpecCenteringOptions.html @@ -0,0 +1,213 @@ + + + + + + ASCenterLayoutSpecCenteringOptions Constants Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASCenterLayoutSpecCenteringOptions Constants Reference

    + + +
    + + + + +
    Declared inASCenterLayoutSpec.h
    + + + + + + + +

    ASCenterLayoutSpecCenteringOptions

    + + +
    +

    How the child is centered within the spec.

    +
    + + +
    + + +

    Definition

    + typedef NS_OPTIONS(NSUInteger, ASCenterLayoutSpecCenteringOptions ) {
    + +    ASCenterLayoutSpecCenteringNone = 0,
    + +    ASCenterLayoutSpecCenteringX = 1 < < 0,
    + +    ASCenterLayoutSpecCenteringY = 1 < < 1,
    + +    ASCenterLayoutSpecCenteringXY = ASCenterLayoutSpecCenteringX | ASCenterLayoutSpecCenteringY,
    + + };
    + +
    + +
    +

    Constants

    +
    + +
    ASCenterLayoutSpecCenteringNone
    +
    + + +

    The child is positioned in {0,0} relatively to the layout bounds

    + + + + + + +

    + Declared In ASCenterLayoutSpec.h. +

    + +
    + +
    ASCenterLayoutSpecCenteringX
    +
    + + +

    The child is centered along the X axis

    + + + + + + +

    + Declared In ASCenterLayoutSpec.h. +

    + +
    + +
    ASCenterLayoutSpecCenteringY
    +
    + + +

    The child is centered along the Y axis

    + + + + + + +

    + Declared In ASCenterLayoutSpec.h. +

    + +
    + +
    ASCenterLayoutSpecCenteringXY
    +
    + + +

    Convenience option to center both along the X and Y axis

    + + + + + + +

    + Declared In ASCenterLayoutSpec.h. +

    + +
    + +
    +
    + + + + + + + + +
    +

    Declared In

    +

    ASCenterLayoutSpec.h

    +
    + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASCenterLayoutSpecSizingOptions.html b/appledoc/Constants/ASCenterLayoutSpecSizingOptions.html new file mode 100644 index 00000000..29b351f1 --- /dev/null +++ b/appledoc/Constants/ASCenterLayoutSpecSizingOptions.html @@ -0,0 +1,213 @@ + + + + + + ASCenterLayoutSpecSizingOptions Constants Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASCenterLayoutSpecSizingOptions Constants Reference

    + + +
    + + + + +
    Declared inASCenterLayoutSpec.h
    + + + + + + + +

    ASCenterLayoutSpecSizingOptions

    + + +
    +

    How much space the spec will take up.

    +
    + + +
    + + +

    Definition

    + typedef NS_OPTIONS(NSUInteger, ASCenterLayoutSpecSizingOptions ) {
    + +    ASCenterLayoutSpecSizingOptionDefault,
    + +    ASCenterLayoutSpecSizingOptionMinimumX = 1 < < 0,
    + +    ASCenterLayoutSpecSizingOptionMinimumY = 1 < < 1,
    + +    ASCenterLayoutSpecSizingOptionMinimumXY = ASCenterLayoutSpecSizingOptionMinimumX | ASCenterLayoutSpecSizingOptionMinimumY,
    + + };
    + +
    + +
    +

    Constants

    +
    + +
    ASCenterLayoutSpecSizingOptionDefault
    +
    + + +

    The spec will take up the maximum size possible

    + + + + + + +

    + Declared In ASCenterLayoutSpec.h. +

    + +
    + +
    ASCenterLayoutSpecSizingOptionMinimumX
    +
    + + +

    The spec will take up the minimum size possible along the X axis

    + + + + + + +

    + Declared In ASCenterLayoutSpec.h. +

    + +
    + +
    ASCenterLayoutSpecSizingOptionMinimumY
    +
    + + +

    The spec will take up the minimum size possible along the Y axis

    + + + + + + +

    + Declared In ASCenterLayoutSpec.h. +

    + +
    + +
    ASCenterLayoutSpecSizingOptionMinimumXY
    +
    + + +

    Convenience option to take up the minimum size along both the X and Y axis

    + + + + + + +

    + Declared In ASCenterLayoutSpec.h. +

    + +
    + +
    +
    + + + + + + + + +
    +

    Declared In

    +

    ASCenterLayoutSpec.h

    +
    + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASControlNodeEvent.html b/appledoc/Constants/ASControlNodeEvent.html index e39d91ce..075a8037 100644 --- a/appledoc/Constants/ASControlNodeEvent.html +++ b/appledoc/Constants/ASControlNodeEvent.html @@ -1,78 +1,79 @@ - + - - - ASControlNodeEvent Constants Reference - - - - - - -
    - + + + + ASControlNodeEvent Constants Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASControlNodeEvent Constants Reference

    - - - - -
    -
    - - - -
    - - + +
    Declared inASControlNode.hDeclared inASControlNode.h
    + - + - - - - +

    ASControlNodeEvent

    @@ -86,23 +87,23 @@

    Definition

    - typedef NS_OPTIONS(NSUInteger, ASControlNodeEvent ) {
    + typedef NS_OPTIONS(NSUInteger, ASControlNodeEvent ) {
    -    ASControlNodeEventTouchDown = 1 < < 0,
    +    ASControlNodeEventTouchDown = 1 < < 0,
    -    ASControlNodeEventTouchDownRepeat = 1 < < 1,
    +    ASControlNodeEventTouchDownRepeat = 1 < < 1,
    -    ASControlNodeEventTouchDragInside = 1 < < 2,
    +    ASControlNodeEventTouchDragInside = 1 < < 2,
    -    ASControlNodeEventTouchDragOutside = 1 < < 3,
    +    ASControlNodeEventTouchDragOutside = 1 < < 3,
    -    ASControlNodeEventTouchUpInside = 1 < < 4,
    +    ASControlNodeEventTouchUpInside = 1 < < 4,
    -    ASControlNodeEventTouchUpOutside = 1 < < 5,
    +    ASControlNodeEventTouchUpOutside = 1 < < 5,
    -    ASControlNodeEventTouchCancel = 1 < < 6,
    +    ASControlNodeEventTouchCancel = 1 < < 6,
    -    ASControlNodeEventAllEvents = 0 xFFFFFFFF,
    +    ASControlNodeEventAllEvents = 0 xFFFFFFFF,
    };
    @@ -116,7 +117,7 @@
    -

    Kinds of events possible for control nodes.

    +

    A touch-down event in the control node.

    @@ -133,7 +134,7 @@
    -

    Kinds of events possible for control nodes.

    +

    A repeated touch-down event in the control node; for this event the value of the UITouch tapCount method is greater than one.

    @@ -150,7 +151,7 @@
    -

    Kinds of events possible for control nodes.

    +

    An event where a finger is dragged inside the bounds of the control node.

    @@ -167,7 +168,7 @@
    -

    Kinds of events possible for control nodes.

    +

    An event where a finger is dragged just outside the bounds of the control.

    @@ -184,7 +185,7 @@
    -

    Kinds of events possible for control nodes.

    +

    A touch-up event in the control node where the finger is inside the bounds of the node.

    @@ -201,7 +202,7 @@
    -

    Kinds of events possible for control nodes.

    +

    A touch-up event in the control node where the finger is outside the bounds of the node.

    @@ -218,7 +219,7 @@
    -

    Kinds of events possible for control nodes.

    +

    A system event canceling the current touches for the control node.

    @@ -235,7 +236,7 @@
    -

    Kinds of events possible for control nodes.

    +

    All events, including system events.

    @@ -251,131 +252,38 @@
    - + - +

    Declared In

    - ASControlNode.h
    -
    - +

    ASControlNode.h

    +
    + +
    -
    - - +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASImageNodeTint.html b/appledoc/Constants/ASImageNodeTint.html deleted file mode 100644 index 267ed1c0..00000000 --- a/appledoc/Constants/ASImageNodeTint.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - ASImageNodeTint Constants Reference - - - - - - -
    - - - - -
    - -
    -
    - - - -
    - -
    - - - - -
    Declared inASImageNode.h
    - - - - - - - - - -

    ASImageNodeTint

    - - -
    -

    Image tints.

    -
    - - -
    - - -

    Definition

    - typedef NS_ENUM(NSUInteger, ASImageNodeTint ) {
    - -    ASImageNodeTintNormal = 0,
    - -    ASImageNodeTintGreyscale,
    - - };
    - -
    - -
    -

    Constants

    -
    - -
    ASImageNodeTintNormal
    -
    - - -

    No tint.

    - - - - - - -

    - Declared In ASImageNode.h. -

    - -
    - -
    ASImageNodeTintGreyscale
    -
    - - -

    Display the image in greyscale.

    - - - - - - -

    - Declared In ASImageNode.h. -

    - -
    - -
    -
    - - - - - - - - -
    -

    Declared In

    - ASImageNode.h
    -
    - - - - - - -
    - - -
    -
    - - - \ No newline at end of file diff --git a/appledoc/Constants/ASMultiplexImageNodeErrorCode.html b/appledoc/Constants/ASMultiplexImageNodeErrorCode.html index 3c2c44c6..9f26ed38 100644 --- a/appledoc/Constants/ASMultiplexImageNodeErrorCode.html +++ b/appledoc/Constants/ASMultiplexImageNodeErrorCode.html @@ -1,78 +1,79 @@ - + - - - ASMultiplexImageNodeErrorCode Constants Reference - - - - - - -
    - + + + + ASMultiplexImageNodeErrorCode Constants Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASMultiplexImageNodeErrorCode Constants Reference

    - - - - -
    -
    - - - -
    - - + +
    Declared inASMultiplexImageNode.hDeclared inASMultiplexImageNode.h
    + - + - - - - +

    ASMultiplexImageNodeErrorCode

    @@ -86,11 +87,11 @@

    Definition

    - typedef NS_ENUM(NSUInteger, ASMultiplexImageNodeErrorCode ) {
    + typedef NS_ENUM(NSUInteger, ASMultiplexImageNodeErrorCode ) {
    -    ASMultiplexImageNodeErrorCodeNoSourceForImage = 0,
    +    ASMultiplexImageNodeErrorCodeNoSourceForImage = 0,
    -    ASMultiplexImageNodeErrorCodeBestImageIdentifierChanged,
    +    ASMultiplexImageNodeErrorCodeBestImageIdentifierChanged,
    };
    @@ -137,131 +138,38 @@
    - + - +

    Declared In

    - ASMultiplexImageNode.h
    -
    - +

    ASMultiplexImageNode.h

    +
    + +
    -
    - - +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASRelativeDimensionType.html b/appledoc/Constants/ASRelativeDimensionType.html new file mode 100644 index 00000000..2837c116 --- /dev/null +++ b/appledoc/Constants/ASRelativeDimensionType.html @@ -0,0 +1,175 @@ + + + + + + ASRelativeDimensionType Constants Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASRelativeDimensionType Constants Reference

    + + +
    + + + + +
    Declared inASDimension.h
    + + + + + + + +

    ASRelativeDimensionType

    + + +
    +

    A dimension relative to constraints to be provided in the future.

    +
    + + +
    + + +

    Definition

    + typedef NS_ENUM(NSInteger, ASRelativeDimensionType ) {
    + +    ASRelativeDimensionTypePoints,
    + +    ASRelativeDimensionTypePercent,
    + + };
    + +
    + +
    +

    Constants

    +
    + +
    ASRelativeDimensionTypePoints
    +
    + + +

    Just a number. It will always resolve to exactly this amount. This is the default type.

    + + + + + + +

    + Declared In ASDimension.h. +

    + +
    + +
    ASRelativeDimensionTypePercent
    +
    + + +

    Multiplied to a provided parent amount to resolve a final amount.

    + + + + + + +

    + Declared In ASDimension.h. +

    + +
    + +
    +
    + + + + + + + + +
    +

    Declared In

    +

    ASDimension.h

    +
    + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASStackLayoutAlignItems.html b/appledoc/Constants/ASStackLayoutAlignItems.html new file mode 100644 index 00000000..02d8c16d --- /dev/null +++ b/appledoc/Constants/ASStackLayoutAlignItems.html @@ -0,0 +1,213 @@ + + + + + + ASStackLayoutAlignItems Constants Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASStackLayoutAlignItems Constants Reference

    + + +
    + + + + +
    Declared inASStackLayoutSpec.h
    + + + + + + + +

    ASStackLayoutAlignItems

    + + +
    +

    Orientation of children along cross axis

    +
    + + +
    + + +

    Definition

    + typedef NS_ENUM(NSUInteger, ASStackLayoutAlignItems ) {
    + +    ASStackLayoutAlignItemsStart,
    + +    ASStackLayoutAlignItemsEnd,
    + +    ASStackLayoutAlignItemsCenter,
    + +    ASStackLayoutAlignItemsStretch,
    + + };
    + +
    + +
    +

    Constants

    +
    + +
    ASStackLayoutAlignItemsStart
    +
    + + +

    Align children to start of cross axis

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    ASStackLayoutAlignItemsEnd
    +
    + + +

    Align children with end of cross axis

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    ASStackLayoutAlignItemsCenter
    +
    + + +

    Center children on cross axis

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    ASStackLayoutAlignItemsStretch
    +
    + + +

    Expand children to fill cross axis

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    +
    + + + + + + + + +
    +

    Declared In

    +

    ASStackLayoutSpec.h

    +
    + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASStackLayoutAlignSelf.html b/appledoc/Constants/ASStackLayoutAlignSelf.html new file mode 100644 index 00000000..21636d93 --- /dev/null +++ b/appledoc/Constants/ASStackLayoutAlignSelf.html @@ -0,0 +1,244 @@ + + + + + + ASStackLayoutAlignSelf Constants Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASStackLayoutAlignSelf Constants Reference

    + + +
    + + + + + + + +
    Declared inASStackLayoutDefines.h
    ReferencesASStackLayoutAlignItems
    + + + + + + + +

    ASStackLayoutAlignSelf

    + + +
    +

    Each child may override their parent stack’s cross axis alignment.

    +
    + + +
    + + +

    Definition

    + typedef NS_ENUM(NSUInteger, ASStackLayoutAlignSelf ) {
    + +    ASStackLayoutAlignSelfAuto,
    + +    ASStackLayoutAlignSelfStart,
    + +    ASStackLayoutAlignSelfEnd,
    + +    ASStackLayoutAlignSelfCenter,
    + +    ASStackLayoutAlignSelfStretch,
    + + };
    + +
    + +
    +

    Constants

    +
    + +
    ASStackLayoutAlignSelfAuto
    +
    + + +

    Inherit alignment value from containing stack.

    + + + + + + +

    + Declared In ASStackLayoutDefines.h. +

    + +
    + +
    ASStackLayoutAlignSelfStart
    +
    + + +

    Align to start of cross axis

    + + + + + + +

    + Declared In ASStackLayoutDefines.h. +

    + +
    + +
    ASStackLayoutAlignSelfEnd
    +
    + + +

    Align with end of cross axis

    + + + + + + +

    + Declared In ASStackLayoutDefines.h. +

    + +
    + +
    ASStackLayoutAlignSelfCenter
    +
    + + +

    Center on cross axis

    + + + + + + +

    + Declared In ASStackLayoutDefines.h. +

    + +
    + +
    ASStackLayoutAlignSelfStretch
    +
    + + +

    Expand to fill cross axis

    + + + + + + +

    + Declared In ASStackLayoutDefines.h. +

    + +
    + +
    +
    + + + + + + +
    +

    See Also

    + +
    + + + +
    +

    Declared In

    +

    ASStackLayoutDefines.h

    +
    + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASStackLayoutDirection.html b/appledoc/Constants/ASStackLayoutDirection.html new file mode 100644 index 00000000..1e2128f2 --- /dev/null +++ b/appledoc/Constants/ASStackLayoutDirection.html @@ -0,0 +1,175 @@ + + + + + + ASStackLayoutDirection Constants Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASStackLayoutDirection Constants Reference

    + + +
    + + + + +
    Declared inASStackLayoutSpec.h
    + + + + + + + +

    ASStackLayoutDirection

    + + +
    +

    The direction children are stacked in

    +
    + + +
    + + +

    Definition

    + typedef NS_ENUM(NSUInteger, ASStackLayoutDirection ) {
    + +    ASStackLayoutDirectionVertical,
    + +    ASStackLayoutDirectionHorizontal,
    + + };
    + +
    + +
    +

    Constants

    +
    + +
    ASStackLayoutDirectionVertical
    +
    + + +

    Children are stacked vertically

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    ASStackLayoutDirectionHorizontal
    +
    + + +

    Children are stacked horizontally

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    +
    + + + + + + + + +
    +

    Declared In

    +

    ASStackLayoutSpec.h

    +
    + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASStackLayoutJustifyContent.html b/appledoc/Constants/ASStackLayoutJustifyContent.html new file mode 100644 index 00000000..1e03b827 --- /dev/null +++ b/appledoc/Constants/ASStackLayoutJustifyContent.html @@ -0,0 +1,197 @@ + + + + + + ASStackLayoutJustifyContent Constants Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASStackLayoutJustifyContent Constants Reference

    + + +
    + + + + +
    Declared inASStackLayoutSpec.h
    + + + + + + + +

    ASStackLayoutJustifyContent

    + + +
    +

    If no children are flexible, how should this spec justify its children in the available space?

    +
    + + +
    + + +

    Definition

    + typedef NS_ENUM(NSUInteger, ASStackLayoutJustifyContent ) {
    + +    ASStackLayoutJustifyContentStart,
    + +    ASStackLayoutJustifyContentCenter,
    + +    ASStackLayoutJustifyContentEnd,
    + + };
    + +
    + +
    +

    Constants

    +
    + +
    ASStackLayoutJustifyContentStart
    +
    + + +

    On overflow, children overflow out of this spec’s bounds on the right/bottom side. + On underflow, children are left/top-aligned within this spec’s bounds.

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    ASStackLayoutJustifyContentCenter
    +
    + + +

    On overflow, children are centered and overflow on both sides. + On underflow, children are centered within this spec’s bounds in the stacking direction.

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    ASStackLayoutJustifyContentEnd
    +
    + + +

    On overflow, children overflow out of this spec’s bounds on the left/top side. + On underflow, children are right/bottom-aligned within this spec’s bounds.

    + + + + + + +

    + Declared In ASStackLayoutSpec.h. +

    + +
    + +
    +
    + + + + + + + + +
    +

    Declared In

    +

    ASStackLayoutSpec.h

    +
    + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Constants/ASTextNodeHighlightStyle.html b/appledoc/Constants/ASTextNodeHighlightStyle.html index b4c0a67f..e966e798 100644 --- a/appledoc/Constants/ASTextNodeHighlightStyle.html +++ b/appledoc/Constants/ASTextNodeHighlightStyle.html @@ -1,78 +1,79 @@ - + - - - ASTextNodeHighlightStyle Constants Reference - - - - - - -
    - + + + + ASTextNodeHighlightStyle Constants Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASTextNodeHighlightStyle Constants Reference

    - - - - -
    -
    - - - -
    - - + +
    Declared inASTextNode.hDeclared inASTextNode.h
    + - + - - - - +

    ASTextNodeHighlightStyle

    @@ -86,11 +87,11 @@

    Definition

    - typedef NS_ENUM(NSUInteger, ASTextNodeHighlightStyle ) {
    + typedef NS_ENUM(NSUInteger, ASTextNodeHighlightStyle ) {
    -    ASTextNodeHighlightStyleLight,
    +    ASTextNodeHighlightStyleLight,
    -    ASTextNodeHighlightStyleDark,
    +    ASTextNodeHighlightStyleDark,
    };
    @@ -137,131 +138,38 @@
    - + - +

    Declared In

    - ASTextNode.h
    -
    - +

    ASTextNode.h

    +
    + +
    -
    - - +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASCollectionViewDataSource.html b/appledoc/Protocols/ASCollectionViewDataSource.html index b618ff5f..52f8b885 100644 --- a/appledoc/Protocols/ASCollectionViewDataSource.html +++ b/appledoc/Protocols/ASCollectionViewDataSource.html @@ -1,112 +1,100 @@ - + - - - ASCollectionViewDataSource Protocol Reference - - - - - - -
    - + + + + ASCollectionViewDataSource Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASCollectionViewDataSource Protocol Reference

    - - -
  • Tasks
      - -
  • - - - - - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toASCommonCollectionViewDataSource
    NSObject
    Conforms toASCommonCollectionViewDataSource
    NSObject
    Declared inASCollectionView.hDeclared inASCollectionView.h
    - +
    @@ -116,215 +104,218 @@
    - +
    -

    Tasks

    - + - - -
    - - - - - - - - - -
    - -

    Instance Methods

    - -
    +
    +
    -

    collectionView:nodeForItemAtIndexPath:

    - - - -
    -

    Similar to -collectionView:cellForItemAtIndexPath:.

    -
    - - +

    – collectionView:nodeForItemAtIndexPath: +required method

    -
    - (ASCellNode *)collectionView:(id)collectionView nodeForItemAtIndexPath:(id)indexPath
    +
    +
    - - -
    -

    Parameters

    - -
    -
    indexPath
    -

    The index path of the requested node.

    -
    - -
    -
    collection
    -

    The sender.

    -
    - -
    - - - -
    -

    Return Value

    -

    a node for display at this indexpath. Must be thread-safe (can be called on the main thread or a background +

    + + +
    +

    Similar to -collectionView:cellForItemAtIndexPath:.

    +
    + + + +
    - (ASCellNode *)collectionView:(ASCollectionView *)collectionView nodeForItemAtIndexPath:(NSIndexPath *)indexPath
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    collectionView

    The sender.

    indexPath

    The index path of the requested node.

    +
    + + + +
    +

    Return Value

    +

    a node for display at this indexpath. Must be thread-safe (can be called on the main thread or a background queue) and should not implement reuse (it will be called once per row). Unlike UICollectionView’s version, this method is not called when the row is about to display.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASCollectionView.h
    -
    - - -
    - -
    - - - - - - - -
    - -
    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASCollectionViewDelegate.html b/appledoc/Protocols/ASCollectionViewDelegate.html index d6a88bda..abec41d5 100644 --- a/appledoc/Protocols/ASCollectionViewDelegate.html +++ b/appledoc/Protocols/ASCollectionViewDelegate.html @@ -1,95 +1,98 @@ - + - - - ASCollectionViewDelegate Protocol Reference - - - - - - -
    - + + + + ASCollectionViewDelegate Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASCollectionViewDelegate Protocol Reference

    - - - - - - - - - - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toASCommonCollectionViewDelegate
    NSObject
    Conforms toASCommonCollectionViewDelegate
    NSObject
    Declared inASCollectionView.hDeclared inASCollectionView.h
    - +
    @@ -99,131 +102,173 @@
    - - - - - - - - - - - - - - - - -
    - -
    + +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASCommonCollectionViewDataSource.html b/appledoc/Protocols/ASCommonCollectionViewDataSource.html index bb3d9680..b6749a0c 100644 --- a/appledoc/Protocols/ASCommonCollectionViewDataSource.html +++ b/appledoc/Protocols/ASCommonCollectionViewDataSource.html @@ -1,95 +1,88 @@ - + - - - ASCommonCollectionViewDataSource Protocol Reference - - - - - - -
    - + + + + ASCommonCollectionViewDataSource Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASCommonCollectionViewDataSource Protocol Reference

    - - - - - - - - - - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObjectConforms toNSObject
    Declared inASCollectionViewProtocols.hDeclared inASCollectionViewProtocols.h
    - +
    @@ -99,131 +92,30 @@
    - - - - - - - - - - - - - - - - -
    - -
    + +
    +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASCommonCollectionViewDelegate.html b/appledoc/Protocols/ASCommonCollectionViewDelegate.html index 1855f020..d62875e4 100644 --- a/appledoc/Protocols/ASCommonCollectionViewDelegate.html +++ b/appledoc/Protocols/ASCommonCollectionViewDelegate.html @@ -1,95 +1,88 @@ - + - - - ASCommonCollectionViewDelegate Protocol Reference - - - - - - -
    - + + + + ASCommonCollectionViewDelegate Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASCommonCollectionViewDelegate Protocol Reference

    - - - - - - - - - - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObject
    UIScrollViewDelegate
    Conforms toNSObject
    UIScrollViewDelegate
    Declared inASCollectionViewProtocols.hDeclared inASCollectionViewProtocols.h
    - +
    @@ -99,131 +92,30 @@
    - - - - - - - - - - - - - - - - -
    - -
    + +
    +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASCommonTableViewDataSource.html b/appledoc/Protocols/ASCommonTableViewDataSource.html index 7a60a170..8a4d853c 100644 --- a/appledoc/Protocols/ASCommonTableViewDataSource.html +++ b/appledoc/Protocols/ASCommonTableViewDataSource.html @@ -1,95 +1,88 @@ - + - - - ASCommonTableViewDataSource Protocol Reference - - - - - - -
    - + + + + ASCommonTableViewDataSource Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASCommonTableViewDataSource Protocol Reference

    - - - - - - - - - - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObjectConforms toNSObject
    Declared inASTableViewProtocols.hDeclared inASTableViewProtocols.h
    - +
    @@ -99,131 +92,30 @@
    - - - - - - - - - - - - - - - - -
    - -
    + +
    +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASCommonTableViewDelegate.html b/appledoc/Protocols/ASCommonTableViewDelegate.html index 3d181cdf..74dfb692 100644 --- a/appledoc/Protocols/ASCommonTableViewDelegate.html +++ b/appledoc/Protocols/ASCommonTableViewDelegate.html @@ -1,95 +1,88 @@ - + - - - ASCommonTableViewDelegate Protocol Reference - - - - - - -
    - + + + + ASCommonTableViewDelegate Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASCommonTableViewDelegate Protocol Reference

    - - - - - - - - - - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObject
    UIScrollViewDelegate
    Conforms toNSObject
    UIScrollViewDelegate
    Declared inASTableViewProtocols.hDeclared inASTableViewProtocols.h
    - +
    @@ -99,131 +92,30 @@
    - - - - - - - - - - - - - - - - -
    - -
    + +
    +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASEditableTextNodeDelegate.html b/appledoc/Protocols/ASEditableTextNodeDelegate.html new file mode 100644 index 00000000..888be117 --- /dev/null +++ b/appledoc/Protocols/ASEditableTextNodeDelegate.html @@ -0,0 +1,472 @@ + + + + + + ASEditableTextNodeDelegate Protocol Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASEditableTextNodeDelegate Protocol Reference

    + + +
    + + + + + + + +
    Conforms toNSObject
    Declared inASEditableTextNode.h
    + + + + +
    + +

    Overview

    +

    The methods declared by the ASEditableTextNodeDelegate protocol allow the adopting delegate to +respond to notifications such as began and finished editing, selection changed and text updated; +and manage whether a specified text should be replaced.

    +
    + + + + + +
    + + + + + + +
    +
    + +

    – editableTextNodeDidBeginEditing: +

    + +
    +
    + +
    + + +
    +

    Indicates to the delegate that the text node began editing.

    +
    + + + +
    - (void)editableTextNodeDidBeginEditing:(ASEditableTextNode *)editableTextNode
    + + + +
    +

    Parameters

    + + + + + + + +
    editableTextNode

    An editable text node.

    +
    + + + + + + + +
    +

    Discussion

    +

    The invocation of this method coincides with the keyboard animating to become visible.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    + +

    – editableTextNode:shouldChangeTextInRange:replacementText: +

    + +
    +
    + +
    + + +
    +

    Asks the delegate whether the specified text should be replaced in the editable text node.

    +
    + + + +
    - (BOOL)editableTextNode:(ASEditableTextNode *)editableTextNode shouldChangeTextInRange:(NSRange)range replacementText:(NSString *)text
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    editableTextNode

    An editable text node.

    range

    The current selection range. If the length of the range is 0, range reflects the current insertion point. If the user presses the Delete key, the length of the range is 1 and an empty string object replaces that single character.

    text

    The text to insert.

    +
    + + + +
    +

    Return Value

    +

    The text node calls this method whenever the user types a new character or deletes an existing character. Implementation of this method is optional – the default implementation returns YES.

    +
    + + + + + +
    +

    Discussion

    +

    YES if the old text should be replaced by the new text; NO if the replacement operation should be aborted.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    + +

    – editableTextNodeDidChangeSelection:fromSelectedRange:toSelectedRange:dueToEditing: +

    + +
    +
    + +
    + + +
    +

    Indicates to the delegate that the text node’s selection has changed.

    +
    + + + +
    - (void)editableTextNodeDidChangeSelection:(ASEditableTextNode *)editableTextNode fromSelectedRange:(NSRange)fromSelectedRange toSelectedRange:(NSRange)toSelectedRange dueToEditing:(BOOL)dueToEditing
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + +
    editableTextNode

    An editable text node.

    fromSelectedRange

    The previously selected range.

    toSelectedRange

    The current selected range. Equvialent to the property.

    dueToEditing

    YES if the selection change was due to editing; NO otherwise.

    +
    + + + + + + + +
    +

    Discussion

    +

    You can access the selection of the receiver via .

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    + +

    – editableTextNodeDidUpdateText: +

    + +
    +
    + +
    + + +
    +

    Indicates to the delegate that the text node’s text was updated.

    +
    + + + +
    - (void)editableTextNodeDidUpdateText:(ASEditableTextNode *)editableTextNode
    + + + +
    +

    Parameters

    + + + + + + + +
    editableTextNode

    An editable text node.

    +
    + + + + + + + +
    +

    Discussion

    +

    This method is called each time the user updated the text node’s text. It is not called for programmatic changes made to the text via the property.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    + +

    – editableTextNodeDidFinishEditing: +

    + +
    +
    + +
    + + +
    +

    Indicates to the delegate that teh text node has finished editing.

    +
    + + + +
    - (void)editableTextNodeDidFinishEditing:(ASEditableTextNode *)editableTextNode
    + + + +
    +

    Parameters

    + + + + + + + +
    editableTextNode

    An editable text node.

    +
    + + + + + + + +
    +

    Discussion

    +

    The invocation of this method coincides with the keyboard animating to become hidden.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASEditableTextNode.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASLayoutable.html b/appledoc/Protocols/ASLayoutable.html new file mode 100644 index 00000000..a0475072 --- /dev/null +++ b/appledoc/Protocols/ASLayoutable.html @@ -0,0 +1,471 @@ + + + + + + ASLayoutable Protocol Reference + + + + + + +
    +
    + +

    + AsyncDisplayKit +

    + +

    + Facebook +

    + +
    +
    + + + +
    +
    +
    +
    +

    ASLayoutable Protocol Reference

    + + +
    + + + + + + + +
    Conforms toNSObject
    Declared inASLayoutable.h
    + + + + +
    + +

    Overview

    +

    The ASLayoutable protocol declares a method for measuring the layout of an object. A class must implement the method +so that instances of that class can be used to build layout trees. The protocol also provides information +about how an object should be laid out within an ASStackLayoutSpec.

    +
    + + + + + +
    + + + + + + +
    +
    + +

      spacingBefore +required method

    + +
    +
    + +
    + + +
    +

    Additional space to place before this object in the stacking direction. +Used when attached to a stack layout.

    +
    + + + +
    @property (nonatomic, readwrite) CGFloat spacingBefore
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayoutable.h

    +
    + + +
    +
    +
    + +

      spacingAfter +required method

    + +
    +
    + +
    + + +
    +

    Additional space to place after this object in the stacking direction. +Used when attached to a stack layout.

    +
    + + + +
    @property (nonatomic, readwrite) CGFloat spacingAfter
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayoutable.h

    +
    + + +
    +
    +
    + +

      flexGrow +required method

    + +
    +
    + +
    + + +
    +

    If the sum of childrens' stack dimensions is less than the minimum size, should this object grow? +Used when attached to a stack layout.

    +
    + + + +
    @property (nonatomic, readwrite) BOOL flexGrow
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayoutable.h

    +
    + + +
    +
    +
    + +

      flexShrink +required method

    + +
    +
    + +
    + + +
    +

    If the sum of childrens' stack dimensions is greater than the maximum size, should this object shrink? +Used when attached to a stack layout.

    +
    + + + +
    @property (nonatomic, readwrite) BOOL flexShrink
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayoutable.h

    +
    + + +
    +
    +
    + +

      flexBasis +required method

    + +
    +
    + +
    + + +
    +

    Specifies the initial size in the stack dimension for this object. +Default to ASRelativeDimensionUnconstrained. +Used when attached to a stack layout.

    +
    + + + +
    @property (nonatomic, readwrite) ASRelativeDimension flexBasis
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayoutable.h

    +
    + + +
    +
    +
    + +

      alignSelf +required method

    + +
    +
    + +
    + + +
    +

    Orientation of the object along cross axis, overriding alignItems +Used when attached to a stack layout.

    +
    + + + +
    @property (nonatomic, readwrite) ASStackLayoutAlignSelf alignSelf
    + + + + + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayoutable.h

    +
    + + +
    +
    +
    + +

    – measureWithSizeRange: +required method

    + +
    +
    + +
    + + +
    +

    Calculate a layout based on given size range.

    +
    + + + +
    - (ASLayout *)measureWithSizeRange:(ASSizeRange)constrainedSize
    + + + +
    +

    Parameters

    + + + + + + + +
    constrainedSize

    The minimum and maximum sizes the receiver should fit in.

    +
    + + + +
    +

    Return Value

    +

    An ASLayout instance defining the layout of the receiver and its children.

    +
    + + + + + + + + + + + +
    +

    Declared In

    +

    ASLayoutable.h

    +
    + + +
    +
    +
    +
    + +
    + + + + + + +
    + + +
    +
    +
    + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASMultiplexImageNodeDataSource.html b/appledoc/Protocols/ASMultiplexImageNodeDataSource.html index 4da5be65..962c0f0b 100644 --- a/appledoc/Protocols/ASMultiplexImageNodeDataSource.html +++ b/appledoc/Protocols/ASMultiplexImageNodeDataSource.html @@ -1,394 +1,283 @@ - + - - - ASMultiplexImageNodeDataSource Protocol Reference - - - - - - -
    - + + + + ASMultiplexImageNodeDataSource Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASMultiplexImageNodeDataSource Protocol Reference

    - -
  • Tasks
      - -
  • - - - - - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObjectConforms toNSObject
    Declared inASMultiplexImageNode.hDeclared inASMultiplexImageNode.h
    - + +
    + +

    Overview

    +

    The ASMultiplexImageNodeDataSource protocol is adopted by an object that provides the multiplex image node, +for each image identifier, an image or a URL the image node should load.

    +
    + + + - - - - - - - - - -
    - -

    Instance Methods

    - -
    - -

    multiplexImageNode:URLForImageIdentifier:

    - - - -
    -

    An image URL for the specified identifier.

    -
    - - - -
    - (NSURL *)multiplexImageNode:(id)imageNode URLForImageIdentifier:(id)imageIdentifier
    - - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    -
    imageIdentifier
    -

    The identifier for the image that will be downloaded.

    -
    - -
    - - - -
    -

    Return Value

    -

    An NSURL for the image identified by imageIdentifier, or nil if none is available.

    -
    - - - - - -
    -

    Discussion

    -

    Supported URLs include assets-library, Photo framework URLs (ph://), HTTP, HTTPS, and FTP URLs. If the -image is already available to the data source, it should be provided via [ASMultiplexImageNodeDataSource multiplexImageNode:imageForImageIdentifier:] instead.

    -
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    +
    +
    -

    multiplexImageNode:imageForImageIdentifier:

    - - - -
    -

    An image for the specified identifier.

    -
    - - +

    – multiplexImageNode:imageForImageIdentifier: +

    -
    - (UIImage *)multiplexImageNode:(id)imageNode imageForImageIdentifier:(id)imageIdentifier
    +
    +
    - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    -
    imageIdentifier
    -

    The identifier for the image that should be returned.

    -
    - -
    - - - -
    -

    Return Value

    -

    A UIImage corresponding to imageIdentifier, or nil if none is available.

    -
    - - - - - -
    -

    Discussion

    -

    If the image is already available to the data source, this method should be used in lieu of providing the -URL to the image via -multiplexImageNode:URLForImageIdentifier:.

    -
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    An image for the specified identifier.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASMultiplexImageNodeDelegate.html b/appledoc/Protocols/ASMultiplexImageNodeDelegate.html index 15707d29..87129886 100644 --- a/appledoc/Protocols/ASMultiplexImageNodeDelegate.html +++ b/appledoc/Protocols/ASMultiplexImageNodeDelegate.html @@ -1,665 +1,550 @@ - + - - - ASMultiplexImageNodeDelegate Protocol Reference - - - - - - -
    - + + + + ASMultiplexImageNodeDelegate Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASMultiplexImageNodeDelegate Protocol Reference

    - -
  • Tasks
      - -
  • - - - - - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObjectConforms toNSObject
    Declared inASMultiplexImageNode.hDeclared inASMultiplexImageNode.h
    - + +
    + +

    Overview

    +

    The methods declared by the ASMultiplexImageNodeDelegate protocol allow the adopting delegate to respond to +notifications such as began, progressed and finished downloading, updated and displayed an image.

    +
    + + + - - - - - - - - - -
    - -

    Instance Methods

    - -
    - -

    multiplexImageNode:didDisplayUpdatedImage:withIdentifier:

    - - - -
    -

    Notification that the image node displayed a new image.

    -
    - - - -
    - (void)multiplexImageNode:(id)imageNode didDisplayUpdatedImage:(id)image withIdentifier:(id)imageIdentifier
    - - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    -
    image
    -

    The new image, now being displayed.

    -
    - -
    -
    imageIdentifier
    -

    The identifier for image.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    This method is only called when image changes, and not on subsequent redisplays of the same image.

    -
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - -

    multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:

    - - - -
    -

    Notification that the image node’s download has finished.

    -
    - - - -
    - (void)multiplexImageNode:(id)imageNode didFinishDownloadingImageWithIdentifier:(id)imageIdentifier error:(id)error
    - - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    -
    imageIdentifier
    -

    The identifier for the image that finished downloading.

    -
    - -
    -
    error
    -

    The error that occurred while downloading, if one occurred; nil otherwise.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    +
    +
    -

    multiplexImageNode:didStartDownloadOfImageWithIdentifier:

    - - - -
    -

    Notification that the image node began downloading an image.

    -
    - - +

    – multiplexImageNode:didStartDownloadOfImageWithIdentifier: +

    -
    - (void)multiplexImageNode:(id)imageNode didStartDownloadOfImageWithIdentifier:(id)imageIdentifier
    +
    +
    - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    -
    imageIdentifier
    -

    The identifier for the image that is downloading.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - -

    multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:

    - - - -
    -

    Notification that the image node’s download progressed.

    -
    - - - -
    - (void)multiplexImageNode:(id)imageNode didUpdateDownloadProgress:(id)downloadProgress forImageWithIdentifier:(id)imageIdentifier
    - - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    -
    downloadProgress
    -

    The progress of the download. Value is between 0.0 and 1.0.

    -
    - -
    -
    imageIdentifier
    -

    The identifier for the image that is downloading.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - -

    multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:

    - - - -
    -

    Notification that the image node’s image was updated.

    -
    - - - -
    - (void)multiplexImageNode:(id)imageNode didUpdateImage:(id)image withIdentifier:(id)imageIdentifier fromImage:(id)previousImage withIdentifier:(id)previousImageIdentifier
    - - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    -
    image
    -

    The new image, ready for display.

    -
    - -
    -
    imageIdentifier
    -

    The identifier for image.

    -
    - -
    -
    previousImage
    -

    The old, previously-loaded image.

    -
    - -
    -
    previousImageIdentifier
    -

    The identifier for previousImage.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Note: This method does not indicate that image has been displayed.

    -
    - - - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - -

    multiplexImageNodeDidFinishDisplay:

    - - - -
    -

    Notification that the image node finished displaying an image.

    -
    - - - -
    - (void)multiplexImageNodeDidFinishDisplay:(id)imageNode
    - - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    This method is called every time an image is displayed, whether or not it has changed.

    -
    - - - - - - - -
    -

    Declared In

    - ASMultiplexImageNode.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    +

    Notification that the image node began downloading an image.

    -
    - - +
    +

    Notification that the image node displayed a new image.

    +
    + + + +
    - (void)multiplexImageNode:(ASMultiplexImageNode *)imageNode didDisplayUpdatedImage:(UIImage *)image withIdentifier:(id)imageIdentifier
    + + + +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    imageNode

    The sender.

    image

    The new image, now being displayed.

    imageIdentifier

    The identifier for image.

    +
    + + + + + + + +
    +

    Discussion

    +

    This method is only called when image changes, and not on subsequent redisplays of the same image.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASMultiplexImageNode.h

    +
    + + +
    +
    +
    + +

    – multiplexImageNodeDidFinishDisplay: +

    + +
    +
    + +
    + + +
    +

    Notification that the image node finished displaying an image.

    +
    + + + +
    - (void)multiplexImageNodeDidFinishDisplay:(ASMultiplexImageNode *)imageNode
    + + + +
    +

    Parameters

    + + + + + + + +
    imageNode

    The sender.

    +
    + + + + + + + +
    +

    Discussion

    +

    This method is called every time an image is displayed, whether or not it has changed.

    +
    + + + + + + + +
    +

    Declared In

    +

    ASMultiplexImageNode.h

    +
    + + +
    +
    +
    + + + + + + + + + + + + + + +
    + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASNetworkImageNodeDelegate.html b/appledoc/Protocols/ASNetworkImageNodeDelegate.html index 47ec3259..7edaaae0 100644 --- a/appledoc/Protocols/ASNetworkImageNodeDelegate.html +++ b/appledoc/Protocols/ASNetworkImageNodeDelegate.html @@ -1,372 +1,261 @@ - + - - - ASNetworkImageNodeDelegate Protocol Reference - - - - - - -
    - + + + + ASNetworkImageNodeDelegate Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASNetworkImageNodeDelegate Protocol Reference

    - -
  • Tasks
      - -
  • - - - - - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObjectConforms toNSObject
    Declared inASNetworkImageNode.hDeclared inASNetworkImageNode.h
    - + +
    + +

    Overview

    +

    The methods declared by the ASNetworkImageNodeDelegate protocol allow the adopting delegate to respond to +notifications such as fininished decoding and downloading an image.

    +
    + + +
    -

    Tasks

    - + - - -
    - - - - - - - - - -
    - -

    Instance Methods

    - -
    +
    +
    -

    imageNode:didLoadImage:

    - - - -
    -

    Notification that the image node finished downloading an image.

    -
    - - +

    – imageNode:didLoadImage: +required method

    -
    - (void)imageNode:(id)imageNode didLoadImage:(id)image
    +
    +
    - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    -
    image
    -

    The newly-loaded image.

    -
    - -
    - - - - - - - -
    -

    Discussion

    -

    Called on a background queue.

    -
    - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    - -

    imageNodeDidFinishDecoding:

    - - - -
    -

    Notification that the image node finished decoding an image.

    -
    - - - -
    - (void)imageNodeDidFinishDecoding:(id)imageNode
    - - - -
    -

    Parameters

    - -
    -
    imageNode
    -

    The sender.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASNetworkImageNode.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    Notification that the image node finished downloading an image.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASRangeControllerDelegate.html b/appledoc/Protocols/ASRangeControllerDelegate.html index 2050d0f4..074228c9 100644 --- a/appledoc/Protocols/ASRangeControllerDelegate.html +++ b/appledoc/Protocols/ASRangeControllerDelegate.html @@ -1,160 +1,112 @@ - + - - - ASRangeControllerDelegate Protocol Reference - - - - - - -
    - + + + + ASRangeControllerDelegate Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASRangeControllerDelegate Protocol Reference

    - - -
  • Tasks
      - -
  • - - - - - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObjectConforms toNSObject
    Declared inASRangeController.hDeclared inASRangeController.h
    - +
    @@ -164,727 +116,580 @@
    - + - - - - - - - - - -
    - -

    Instance Methods

    - -
    - -

    rangeController:didDeleteNodesAtIndexPaths:withAnimationOption:

    - - - -
    -

    Called for nodes deletion.

    -
    - - - -
    - (void)rangeController:(id)rangeController didDeleteNodesAtIndexPaths:(id)indexPaths withAnimationOption:(id)animationOption
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeController:didDeleteSectionsAtIndexSet:withAnimationOption:

    - - - -
    -

    Called for section deletion.

    -
    - - - -
    - (void)rangeController:(id)rangeController didDeleteSectionsAtIndexSet:(id)indexSet withAnimationOption:(id)animationOption
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeController:didInsertNodesAtIndexPaths:withAnimationOption:

    - - - -
    -

    Called for nodes insertion.

    -
    - - - -
    - (void)rangeController:(id)rangeController didInsertNodesAtIndexPaths:(id)indexPaths withAnimationOption:(id)animationOption
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeController:didInsertSectionsAtIndexSet:withAnimationOption:

    - - - -
    -

    Called for section insertion.

    -
    - - - -
    - (void)rangeController:(id)rangeController didInsertSectionsAtIndexSet:(id)indexSet withAnimationOption:(id)animationOption
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeController:nodesAtIndexPaths:

    - - - -
    -

    Fetch nodes at specific index paths.

    -
    - - - -
    - (NSArray *)rangeController:(id)rangeController nodesAtIndexPaths:(id)indexPaths
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeController:willDeleteNodesAtIndexPaths:withAnimationOption:

    - - - -
    -

    Called before nodes deletion.

    -
    - - - -
    - (void)rangeController:(id)rangeController willDeleteNodesAtIndexPaths:(id)indexPaths withAnimationOption:(id)animationOption
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeController:willDeleteSectionsAtIndexSet:withAnimationOption:

    - - - -
    -

    Called before section deletion.

    -
    - - - -
    - (void)rangeController:(id)rangeController willDeleteSectionsAtIndexSet:(id)indexSet withAnimationOption:(id)animationOption
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeController:willInsertNodesAtIndexPaths:withAnimationOption:

    - - - -
    -

    Called before nodes insertion.

    -
    - - - -
    - (void)rangeController:(id)rangeController willInsertNodesAtIndexPaths:(id)indexPaths withAnimationOption:(id)animationOption
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeController:willInsertSectionsAtIndexSet:withAnimationOption:

    - - - -
    -

    Called before section insertion.

    -
    - - - -
    - (void)rangeController:(id)rangeController willInsertSectionsAtIndexSet:(id)indexSet withAnimationOption:(id)animationOption
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeControllerBeginUpdates:

    - - - -
    -

    Begin updates.

    -
    - - - -
    - (void)rangeControllerBeginUpdates:(id)rangeController
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeControllerEndUpdates:

    - - - -
    -

    End updates.

    -
    - - - -
    - (void)rangeControllerEndUpdates:(id)rangeController
    - - - - - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - -

    rangeControllerViewportSize:

    - - - -
    -

    Sender.

    -
    - - - -
    - (CGSize)rangeControllerViewportSize:(id)rangeController
    - - - -
    -

    Parameters

    - -
    -
    rangeController
    -

    Sender.

    -
    - -
    - - - -
    -

    Return Value

    -

    the receiver’s viewport size (i.e., the screen space occupied by the visible range).

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    +
    +
    -

    rangeControllerVisibleNodeIndexPaths:

    - - - -
    -

    Sender.

    -
    - - +

    – rangeControllerVisibleNodeIndexPaths: +required method

    -
    - (NSArray *)rangeControllerVisibleNodeIndexPaths:(id)rangeController
    +
    +
    - - -
    -

    Parameters

    - -
    -
    rangeController
    -

    Sender.

    -
    - -
    - - - -
    -

    Return Value

    -

    an array of index paths corresponding to the nodes currently visible onscreen (i.e., the visible range).

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASRangeController.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    Sender.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASTableViewDataSource.html b/appledoc/Protocols/ASTableViewDataSource.html index da5915dc..5b8971b0 100644 --- a/appledoc/Protocols/ASTableViewDataSource.html +++ b/appledoc/Protocols/ASTableViewDataSource.html @@ -1,112 +1,100 @@ - + - - - ASTableViewDataSource Protocol Reference - - - - - - -
    - + + + + ASTableViewDataSource Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASTableViewDataSource Protocol Reference

    - - -
  • Tasks
      - -
  • - - - - - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toASCommonTableViewDataSource
    NSObject
    Conforms toASCommonTableViewDataSource
    NSObject
    Declared inASTableView.hDeclared inASTableView.h
    - +
    @@ -116,215 +104,218 @@
    - +
    -

    Tasks

    - + - - -
    - - - - - - - - - -
    - -

    Instance Methods

    - -
    +
    +
    -

    tableView:nodeForRowAtIndexPath:

    - - - -
    -

    Similar to -tableView:cellForRowAtIndexPath:.

    -
    - - +

    – tableView:nodeForRowAtIndexPath: +required method

    -
    - (ASCellNode *)tableView:(id)tableView nodeForRowAtIndexPath:(id)indexPath
    +
    +
    - - -
    -

    Parameters

    - -
    -
    tableView
    -

    The sender.

    -
    - -
    -
    indexPath
    -

    The index path of the requested node.

    -
    - -
    - - - -
    -

    Return Value

    -

    a node for display at this indexpath. Must be thread-safe (can be called on the main thread or a background +

    + + +
    +

    Similar to -tableView:cellForRowAtIndexPath:.

    +
    + + + +
    - (ASCellNode *)tableView:(ASTableView *)tableView nodeForRowAtIndexPath:(NSIndexPath *)indexPath
    + + + +
    +

    Parameters

    + + + + + + + + + + + + +
    tableView

    The sender.

    indexPath

    The index path of the requested node.

    +
    + + + +
    +

    Return Value

    +

    a node for display at this indexpath. Must be thread-safe (can be called on the main thread or a background queue) and should not implement reuse (it will be called once per row). Unlike UITableView’s version, this method is not called when the row is about to display.

    -
    - - - - - - - - - - - -
    -

    Declared In

    - ASTableView.h
    -
    - - -
    - -
    - - - - - - - -
    - -
    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASTableViewDelegate.html b/appledoc/Protocols/ASTableViewDelegate.html index 23eae5f6..9d1a9e1b 100644 --- a/appledoc/Protocols/ASTableViewDelegate.html +++ b/appledoc/Protocols/ASTableViewDelegate.html @@ -1,95 +1,98 @@ - + - - - ASTableViewDelegate Protocol Reference - - - - - - -
    - + + + + ASTableViewDelegate Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASTableViewDelegate Protocol Reference

    - - - - - - - - - - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toASCommonTableViewDelegate
    NSObject
    Conforms toASCommonTableViewDelegate
    NSObject
    Declared inASTableView.hDeclared inASTableView.h
    - +
    @@ -102,131 +105,172 @@ responsible for deciding their preferred onscreen height in -calculateSizeThatFi
    - - - - - - - - - - - - - - - - -
    - -
    + +
    -
    - - + + + + + \ No newline at end of file diff --git a/appledoc/Protocols/ASTextNodeDelegate.html b/appledoc/Protocols/ASTextNodeDelegate.html index 8ec5f160..102be45b 100644 --- a/appledoc/Protocols/ASTextNodeDelegate.html +++ b/appledoc/Protocols/ASTextNodeDelegate.html @@ -1,570 +1,444 @@ - + - - - ASTextNodeDelegate Protocol Reference - - - - - - -
    - + + + + ASTextNodeDelegate Protocol Reference + + + + + + +
    +
    - - -
    - + + +
    +
    +
    +
    +

    ASTextNodeDelegate Protocol Reference

    - - -
  • Tasks
      - -
  • - - - - - - - - - -
  • Instance Methods
  • - - - - -
    -
    - - - -
    - - + + - - + +
    Conforms toNSObjectConforms toNSObject
    Declared inASTextNode.hDeclared inASTextNode.h
    - + - + - - - - - - - - - -
    - -

    Instance Methods

    - -
    - -

    textNode:longPressedLinkAttribute:value:atPoint:textRange:

    - - - -
    -

    Indicates to the delegate that a link was tapped within a text node.

    -
    - - - -
    - (void)textNode:(id)textNode longPressedLinkAttribute:(id)attribute value:(id)value atPoint:(id)point textRange:(id)textRange
    - - - -
    -

    Parameters

    - -
    -
    textNode
    -

    The ASTextNode containing the link that was tapped.

    -
    - -
    -
    attribute
    -

    The attribute that was tapped. Will not be nil.

    -
    - -
    -
    value
    -

    The value of the tapped attribute.

    -
    - -
    -
    point
    -

    The point within textNode, in textNode’s coordinate system, that was tapped.

    -
    - -
    -
    textRange
    -

    The range of highlighted text.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    textNode:shouldHighlightLinkAttribute:value:atPoint:

    - - - -
    -

    Indicates to the text node if an attribute should be considered a link.

    -
    - - - -
    - (BOOL)textNode:(id)textNode shouldHighlightLinkAttribute:(id)attribute value:(id)value atPoint:(id)point
    - - - -
    -

    Parameters

    - -
    -
    textNode
    -

    The text node containing the entity attribute.

    -
    - -
    -
    attribute
    -

    The attribute that was tapped. Will not be nil.

    -
    - -
    -
    value
    -

    The value of the tapped attribute.

    -
    - -
    -
    point
    -

    The point within textNode, in textNode’s coordinate system, that was touched to trigger a highlight.

    -
    - -
    - - - -
    -

    Return Value

    -

    YES if the entity attribute should be a link, NO otherwise.

    -
    - - - - - -
    -

    Discussion

    -

    If not implemented, the default value is NO.

    -
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - -

    textNode:shouldLongPressLinkAttribute:value:atPoint:

    - - - -
    -

    Indicates to the text node if an attribute is a valid long-press target

    -
    - - - -
    - (BOOL)textNode:(id)textNode shouldLongPressLinkAttribute:(id)attribute value:(id)value atPoint:(id)point
    - - - -
    -

    Parameters

    - -
    -
    textNode
    -

    The text node containing the entity attribute.

    -
    - -
    -
    attribute
    -

    The attribute that was tapped. Will not be nil.

    -
    - -
    -
    value
    -

    The value of the tapped attribute.

    -
    - -
    -
    point
    -

    The point within textNode, in textNode’s coordinate system, that was long-pressed.

    -
    - -
    - - - -
    -

    Return Value

    -

    YES if the entity attribute should be treated as a long-press target, NO otherwise.

    -
    - - - - - -
    -

    Discussion

    -

    If not implemented, the default value is NO.

    -
    - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    +
    +
    -

    textNode:tappedLinkAttribute:value:atPoint:textRange:

    - - - -
    -

    Indicates to the delegate that a link was tapped within a text node.

    -
    - - +

    – textNode:tappedLinkAttribute:value:atPoint:textRange: +

    -
    - (void)textNode:(id)textNode tappedLinkAttribute:(id)attribute value:(id)value atPoint:(id)point textRange:(id)textRange
    +
    +
    - - -
    -

    Parameters

    - -
    -
    textNode
    -

    The ASTextNode containing the link that was tapped.

    -
    - -
    -
    attribute
    -

    The attribute that was tapped. Will not be nil.

    -
    - -
    -
    value
    -

    The value of the tapped attribute.

    -
    - -
    -
    point
    -

    The point within textNode, in textNode’s coordinate system, that was tapped.

    -
    - -
    -
    textRange
    -

    The range of highlighted text.

    -
    - -
    - - - - - - - - - - - - - -
    -

    Declared In

    - ASTextNode.h
    -
    - - -
    - -
    - - - - - - - -
    - - +
    + + +
    +

    Indicates to the delegate that a link was tapped within a text node.

    -
    - - + + + + +
    + + +
    +
    +
    + + + \ No newline at end of file diff --git a/appledoc/css/scss/_index.scss b/appledoc/css/scss/_index.scss new file mode 100644 index 00000000..7e98029d --- /dev/null +++ b/appledoc/css/scss/_index.scss @@ -0,0 +1,13 @@ +.index-container { + display: flex; + flex-direction: row; + flex-wrap: wrap; + + @media (max-width: $mobile-max-width) { + flex-direction: column; + } + + .index-column { + flex: 1 1 33%; + } +} diff --git a/appledoc/css/scss/_layout.scss b/appledoc/css/scss/_layout.scss new file mode 100644 index 00000000..40bd6d4a --- /dev/null +++ b/appledoc/css/scss/_layout.scss @@ -0,0 +1,303 @@ +* { + box-sizing: border-box; +} + +.clear { + clear: both; +} + +.clearfix { + &:before, &:after { + clear: both; + display: table; + content: ""; + } +} + +.xcode .hide-in-xcode { + display: none; +} + +body { + font: 62.5% $body-font; + background: $body-background; +} + +h1, h2, h3 { + font-weight: 300; + color: #808080; +} + +h1 { + font-size: 2em; + color: #000; +} + +h4 { + font-size: 13px; + line-height: 1.5; + margin: 21px 0 0 0; +} + +a { + color: $tint-color; + text-decoration: none; +} + +pre, code { + font-family: $code-font; + word-wrap: break-word; +} + +pre > code, .method-declaration code { + display: inline-block; + font-size: .85em; + padding: 4px 0 4px 10px; + border-left: 5px solid rgba(0, 155, 51, .2); + + &:before { + content: "Objective-C"; + display: block; + + font: 9px/1 $body-font; + color: #009b33; + text-transform: uppercase; + letter-spacing: 2px; + padding-bottom: 6px; + } +} + +pre > code { + font-size: inherit; +} + +table, th, td { + border: 1px solid #e9e9e9; +} + +table { + width: 100%; +} + +th, td { + padding: 7px; + + > :first-child { + margin-top: 0; + } + + > :last-child { + margin-bottom: 0; + } +} + +.container { + @extend .clearfix; + + max-width: 980px; + padding: 0 10px; + margin: 0 auto; + + @media (max-width: $mobile-max-width) { + padding: 0; + } +} + +header { + position: fixed; + top: 0; + left: 0; + width: 100%; + z-index: 2; + + background: #414141; + color: #fff; + font-size: 1.1em; + line-height: 25px; + letter-spacing: .05em; + + #library-title { + float: left; + } + + #developer-home { + float: right; + } + + h1 { + font-size: inherit; + font-weight: inherit; + margin: 0; + } + + p { + margin: 0; + } + + h1, a { + color: inherit; + } + + @media (max-width: $mobile-max-width) { + position: absolute; + + .container { + padding: 0 10px; + } + } +} + +aside { + position: fixed; + top: 25px; + left: 0; + width: 100%; + height: 25px; + z-index: 2; + + font-size: 1.1em; + + @media (max-width: $mobile-max-width) { + position: absolute; + } + + #header-buttons { + background: rgba(255, 255, 255, .8); + margin: 0 1px; + padding: 0; + list-style: none; + text-align: right; + line-height: 32px; + + li { + display: inline-block; + cursor: pointer; + padding: 0 10px; + } + + label, select { + cursor: inherit; + } + + #on-this-page { + position: relative; + + .chevron { + display: inline-block; + width: 14px; + height: 4px; + position: relative; + + .chevy { + background: #878787; + height: 2px; + position: absolute; + width: 10px; + + &.chevron-left { + left: 0; + transform: rotateZ(45deg) scale(0.6); + } + + &.chevron-right { + right: 0; + transform: rotateZ(-45deg) scale(0.6); + } + } + } + + #jump-to { + opacity: 0; + font-size: 16px; + + position: absolute; + top: 5px; + left: 0; + width: 100%; + height: 100%; + } + } + } +} + +article { + margin-top: 25px; + + #content { + @extend .clearfix; + + background: $content-background; + border: 1px solid $content-border; + padding: 15px 25px 30px 25px; + + font-size: 1.4em; + line-height: 1.45; + + position: relative; + + @media (max-width: $mobile-max-width) { + padding: 15px 10px 20px 10px; + } + + .navigation-top { + position: absolute; + top: 15px; + right: 25px; + } + + .title { + margin: 21px 0 0 0; + padding: 15px 0; + } + + p { + color: #414141; + margin: 0 0 15px 0; + } + + th, td { + p:last-child { + margin-bottom: 0; + } + } + + main { + ul { + list-style: none; + margin-left: 24px; + margin-bottom: 12px; + padding: 0; + + li { + position: relative; + padding-left: 1.3em; + + &:before { + content: "\02022"; + + color: #414141; + font-size: 1.08em; + line-height: 1; + + position: absolute; + left: 0; + padding-top: 2px; + } + } + } + } + + footer { + @extend .clearfix; + + .footer-copyright { + margin: 70px 25px 10px 0; + } + + p { + font-size: .71em; + color: #a0a0a0; + } + } + } +} diff --git a/appledoc/css/scss/_normalize.scss b/appledoc/css/scss/_normalize.scss new file mode 100644 index 00000000..9b8848a5 --- /dev/null +++ b/appledoc/css/scss/_normalize.scss @@ -0,0 +1,581 @@ +/* ========================================================================== + Normalize.scss settings + ========================================================================== */ +/** + * Includes legacy browser support IE6/7 + * + * Set to false if you want to drop support for IE6 and IE7 + */ + +$legacy_browser_support: false !default; + +/* Base + ========================================================================== */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + * 3. Corrects text resizing oddly in IE 6/7 when body `font-size` is set using + * `em` units. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ + @if $legacy_browser_support { + *font-size: 100%; /* 3 */ + } +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ + @if $legacy_browser_support { + *display: inline; + *zoom: 1; + } +} + +/** + * Prevents modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a { + &:active, &:hover { + outline: 0; + }; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +@if $legacy_browser_support { + blockquote { + margin: 1em 40px; + } +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +@if $legacy_browser_support { + h2 { + font-size: 1.5em; + margin: 0.83em 0; + } + + h3 { + font-size: 1.17em; + margin: 1em 0; + } + + h4 { + font-size: 1em; + margin: 1.33em 0; + } + + h5 { + font-size: 0.83em; + margin: 1.67em 0; + } + + h6 { + font-size: 0.67em; + margin: 2.33em 0; + } +} + +/** + * Addresses styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +@if $legacy_browser_support { + + /** + * Addresses margins set differently in IE 6/7. + */ + + p, + pre { + *margin: 1em 0; + } + + /* + * Addresses CSS quotes not supported in IE 6/7. + */ + + q { + *quotes: none; + } + + /* + * Addresses `quotes` property not supported in Safari 4. + */ + + q:before, + q:after { + content: ''; + content: none; + } +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +@if $legacy_browser_support { + + /* ========================================================================== + Lists + ========================================================================== */ + + /* + * Addresses margins set differently in IE 6/7. + */ + + dl, + menu, + ol, + ul { + *margin: 1em 0; + } + + dd { + *margin: 0 0 0 40px; + } + + /* + * Addresses paddings set differently in IE 6/7. + */ + + menu, + ol, + ul { + *padding: 0 0 0 40px; + } + + /* + * Corrects list images handled incorrectly in IE 7. + */ + + nav ul, + nav ol { + *list-style: none; + *list-style-image: none; + } + +} + +/* Embedded content + ========================================================================== */ + +/** + * 1. Remove border when inside `a` element in IE 8/9/10. + * 2. Improves image quality when scaled in IE 7. + */ + +img { + border: 0; + @if $legacy_browser_support { + *-ms-interpolation-mode: bicubic; /* 2 */ + } +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + @if $legacy_browser_support { + _font-family: 'courier new', monospace; + } + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + * 4. Improves appearance and consistency in all browsers. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ + @if $legacy_browser_support { + vertical-align: baseline; /* 3 */ + *vertical-align: middle; /* 3 */ + } +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + * 4. Removes inner spacing in IE 7 without affecting normal text inputs. + * Known issue: inner spacing remains in IE 6. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ + @if $legacy_browser_support { + *overflow: visible; /* 4 */ + } +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + * Known issue: excess padding remains in IE 6. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ + @if $legacy_browser_support { + *height: 13px; /* 3 */ + *width: 13px; /* 3 */ + } +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + * 3. Corrects text not wrapping in Firefox 3. + * 4. Corrects alignment displayed oddly in IE 6/7. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ + @if $legacy_browser_support { + white-space: normal; /* 3 */ + *margin-left: -7px; /* 4 */ + } +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/appledoc/css/scss/_object.scss b/appledoc/css/scss/_object.scss new file mode 100644 index 00000000..22eebd87 --- /dev/null +++ b/appledoc/css/scss/_object.scss @@ -0,0 +1,89 @@ +.section-specification { + table { + width: auto; + + th { + text-align: left; + } + } +} + +.method-title { + margin-left: -15px; + margin-bottom: 8px; + transition: margin-left .3s ease-out; + + .section-method.hide & { + margin-left: 0; + } + + code { + font-weight: 400; + font-size: .85em; + } +} + +.method-info { + background: $object-background; + border-bottom: 1px solid $object-border; + margin: 0 -25px; + padding: 20px 25px 0 25px; + transition: height .3s ease-out; + + position: relative; + + .pointy-thing { + background: $content-background; + height: 10px; + border-bottom: 1px solid $object-border; + margin: -20px -25px 16px -25px; + + &:before { + display: inline-block; + content: ""; + + background: $object-background; + border: 1px solid $object-border; + border-bottom: 0; + border-right: 0; + + position: absolute; + left: 21px; + top: 3px; + width: 12px; + height: 12px; + transform: rotate(45deg); + } + } + + .method-subsection { + margin-bottom: 15px; + + .argument-name { + width: 1px; + text-align: right; + + code { + color: #808080; + font-style: italic; + font-weight: 400; + } + } + } +} + +.section-method { + &.hide .method-info { + height: 0 !important; + overflow: hidden; + display: none; + } + + &.hide.animating .method-info { + display: block; + } + + &.animating .method-info { + overflow: hidden; + } +} diff --git a/appledoc/css/scss/_print.scss b/appledoc/css/scss/_print.scss new file mode 100644 index 00000000..61bdf99f --- /dev/null +++ b/appledoc/css/scss/_print.scss @@ -0,0 +1,42 @@ +@media print { + body { + background: #fff; + padding: 8px; + } + + header { + position: static; + background: #fff; + color: #000; + } + + aside { + display: none; + } + + .container { + max-width: none; + padding: 0; + } + + article { + margin-top: 0; + + #content { + border: 0; + background: #fff; + padding: 15px 0 0 0; + + .title { + margin-top: 0; + padding-top: 0; + } + } + } + + .method-info { + &, & .pointy-thing { + background: #fff; + } + } +} diff --git a/appledoc/css/scss/_variables.scss b/appledoc/css/scss/_variables.scss new file mode 100644 index 00000000..cbaff3cf --- /dev/null +++ b/appledoc/css/scss/_variables.scss @@ -0,0 +1,11 @@ +$body-font: -apple-system-font, "Helvetica Neue", Helvetica, sans-serif; +$code-font: "Source Code Pro", Monaco, Menlo, Consolas, monospace; + +$body-background: #f2f2f2; +$content-background: #fff; +$content-border: #e9e9e9; +$tint-color: #08c; +$object-background: #f9f9f9; +$object-border: #e9e9e9; + +$mobile-max-width: 650px; diff --git a/appledoc/css/scss/_xcode.scss b/appledoc/css/scss/_xcode.scss new file mode 100644 index 00000000..340b1f6b --- /dev/null +++ b/appledoc/css/scss/_xcode.scss @@ -0,0 +1,29 @@ +.xcode { + header, aside { + display: none; + } + + .container { + padding: 0; + } + + article { + margin-top: 0; + + #content { + border: 0; + margin: 0; + } + } + + .method-info { + &, .section-method.hide & { + max-height: auto; + overflow: visible; + + &.hiding { + display: block; + } + } + } +} diff --git a/appledoc/css/scss/style.scss b/appledoc/css/scss/style.scss new file mode 100644 index 00000000..648a6086 --- /dev/null +++ b/appledoc/css/scss/style.scss @@ -0,0 +1 @@ +@import "variables", "normalize", "layout", "index", "object", "print", "xcode"; diff --git a/appledoc/css/style.css b/appledoc/css/style.css new file mode 100644 index 00000000..2e0648e3 --- /dev/null +++ b/appledoc/css/style.css @@ -0,0 +1,2 @@ +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type=checkbox],input[type=radio]{box-sizing:border-box;padding:0}input[type=number]::-webkit-inner-spin-button,input[type=number]::-webkit-outer-spin-button{height:auto}input[type=search]{-webkit-appearance:textfield;box-sizing:content-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}*{box-sizing:border-box}.clear{clear:both}.clearfix:before,.container:before,article #content:before,article #content footer:before,.clearfix:after,.container:after,article #content:after,article #content footer:after{clear:both;display:table;content:""}.xcode .hide-in-xcode{display:none}body{font:62.5% -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;background:#f2f2f2}h1,h2,h3{font-weight:300;color:gray}h1{font-size:2em;color:#000}h4{font-size:13px;line-height:1.5;margin:21px 0 0}a{color:#08c;text-decoration:none}pre,code{font-family:Source Code Pro,Monaco,Menlo,Consolas,monospace;word-wrap:break-word}pre>code,.method-declaration code{display:inline-block;font-size:.85em;padding:4px 0 4px 10px;border-left:5px solid rgba(0,155,51,.2)}pre>code:before,.method-declaration code:before{content:"Objective-C";display:block;font:9px/1 -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;color:#009b33;text-transform:uppercase;letter-spacing:2px;padding-bottom:6px}pre>code{font-size:inherit}table,th,td{border:1px solid #e9e9e9}table{width:100%}th,td{padding:7px}th>:first-child,td>:first-child{margin-top:0}th>:last-child,td>:last-child{margin-bottom:0}.container{max-width:980px;padding:0 10px;margin:0 auto}@media(max-width:650px){.container{padding:0}}header{position:fixed;top:0;left:0;width:100%;z-index:2;background:#414141;color:#fff;font-size:1.1em;line-height:25px;letter-spacing:.05em}header #library-title{float:left}header #developer-home{float:right}header h1{font-size:inherit;font-weight:inherit;margin:0}header p{margin:0}header h1,header a{color:inherit}@media(max-width:650px){header{position:absolute}header .container{padding:0 10px}}aside{position:fixed;top:25px;left:0;width:100%;height:25px;z-index:2;font-size:1.1em}aside #header-buttons{background:rgba(255,255,255,.8);margin:0 1px;padding:0;list-style:none;text-align:right;line-height:32px}aside #header-buttons li{display:inline-block;cursor:pointer;padding:0 10px}aside #header-buttons label,aside #header-buttons select{cursor:inherit}aside #header-buttons #on-this-page{position:relative}aside #header-buttons #on-this-page .chevron{display:inline-block;width:14px;height:4px;position:relative}aside #header-buttons #on-this-page .chevron .chevy{background:#878787;height:2px;position:absolute;width:10px}aside #header-buttons #on-this-page .chevron .chevy.chevron-left{left:0;-webkit-transform:rotateZ(45deg) scale(.6);transform:rotateZ(45deg) scale(.6)}aside #header-buttons #on-this-page .chevron .chevy.chevron-right{right:0;-webkit-transform:rotateZ(-45deg) scale(.6);transform:rotateZ(-45deg) scale(.6)}aside #header-buttons #on-this-page #jump-to{opacity:0;filter:alpha(opacity=0);font-size:16px;position:absolute;top:5px;left:0;width:100%;height:100%}article{margin-top:25px}article #content{background:#fff;border:1px solid #e9e9e9;padding:15px 25px 30px;font-size:1.4em;line-height:1.45;position:relative}@media(max-width:650px){article #content{padding:15px 10px 20px}}article #content .navigation-top{position:absolute;top:15px;right:25px}article #content .title{margin:21px 0 0;padding:15px 0}article #content p{color:#414141;margin:0 0 15px}article #content th p:last-child,article #content td p:last-child{margin-bottom:0}article #content main ul{list-style:none;margin-left:24px;margin-bottom:12px;padding:0}article #content main ul li{position:relative;padding-left:1.3em}article #content main ul li:before{content:"\02022";color:#414141;font-size:1.08em;line-height:1;position:absolute;left:0;padding-top:2px}article #content footer .footer-copyright{margin:70px 25px 10px 0}article #content footer p{font-size:.71em;color:#a0a0a0}.index-container{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap}@media(max-width:650px){.index-container{-webkit-box-orient:vertical;-webkit-box-direction:normal;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column}}.index-container .index-column{-webkit-box-flex:1;-webkit-flex:1 1 33%;-ms-flex:1 1 33%;flex:1 1 33%}.section-specification table{width:auto}.section-specification table th{text-align:left}.method-title{margin-left:-15px;margin-bottom:8px;-webkit-transition:margin-left .3s ease-out;transition:margin-left .3s ease-out}.section-method.hide .method-title{margin-left:0}.method-title code{font-weight:400;font-size:.85em}.method-info{background:#f9f9f9;border-bottom:1px solid #e9e9e9;margin:0 -25px;padding:20px 25px 0;-webkit-transition:height .3s ease-out;transition:height .3s ease-out;position:relative}.method-info .pointy-thing{background:#fff;height:10px;border-bottom:1px solid #e9e9e9;margin:-20px -25px 16px}.method-info .pointy-thing:before{display:inline-block;content:"";background:#f9f9f9;border:1px solid #e9e9e9;border-bottom:0;border-right:0;position:absolute;left:21px;top:3px;width:12px;height:12px;-webkit-transform:rotate(45deg);-ms-transform:rotate(45deg);transform:rotate(45deg)}.method-info .method-subsection{margin-bottom:15px}.method-info .method-subsection .argument-name{width:1px;text-align:right}.method-info .method-subsection .argument-name code{color:gray;font-style:italic;font-weight:400}.section-method.hide .method-info{height:0!important;overflow:hidden;display:none}.section-method.hide.animating .method-info{display:block}.section-method.animating .method-info{overflow:hidden}@media print{body{background:#fff;padding:8px}header{position:static;background:#fff;color:#000}aside{display:none}.container{max-width:none;padding:0}article{margin-top:0}article #content{border:0;background:#fff;padding:15px 0 0}article #content .title{margin-top:0;padding-top:0}.method-info,.method-info .pointy-thing{background:#fff}}.xcode header,.xcode aside{display:none}.xcode .container{padding:0}.xcode article{margin-top:0}.xcode article #content{border:0;margin:0}.xcode .section-method.hide .method-info,.xcode .section-method.hide.animating .method-info,.xcode .section-method.animating .method-info{height:auto!important;overflow:visible;display:block}.xcode .section-method.hide .method-title{margin-left:-15px} +/*# sourceMappingURL=to.css.map */ \ No newline at end of file diff --git a/appledoc/css/styles.css b/appledoc/css/styles.css deleted file mode 100644 index 33081897..00000000 --- a/appledoc/css/styles.css +++ /dev/null @@ -1,615 +0,0 @@ -body { - font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; - font-size: 13px; -} - -code { - font-family: Courier, Consolas, monospace; - font-size: 13px; - color: #666; -} - -pre { - font-family: Courier, Consolas, monospace; - font-size: 13px; - line-height: 18px; - tab-interval: 0.5em; - border: 1px solid #C7CFD5; - background-color: #F1F5F9; - color: #666; - padding: 0.3em 1em; -} - -ul { - list-style-type: square; -} - -li { - margin-bottom: 10px; -} - -a, a code { - text-decoration: none; - color: #36C; -} - -a:hover, a:hover code { - text-decoration: underline; - color: #36C; -} - -h2 { - border-bottom: 1px solid #8391A8; - color: #3C4C6C; - font-size: 187%; - font-weight: normal; - margin-top: 1.75em; - padding-bottom: 2px; -} - -table { - margin-bottom: 4em; - border-collapse:collapse; - vertical-align: middle; -} - -td { - border: 1px solid #9BB3CD; - padding: .667em; - font-size: 100%; -} - -th { - border: 1px solid #9BB3CD; - padding: .3em .667em .3em .667em; - background: #93A5BB; - font-size: 103%; - font-weight: bold; - color: white; - text-align: left; -} - -/* @group Common page elements */ - -#top_header { - height: 91px; - left: 0; - min-width: 598px; - position: absolute; - right: 0; - top: 0; - z-index: 900; -} - -#footer { - clear: both; - padding-top: 20px; - text-align: center; -} - -#contents, #overview_contents { - -webkit-overflow-scrolling: touch; - border-top: 1px solid #A9A9A9; - position: absolute; - top: 90px; - left: 0; - right: 0; - bottom: 0; - overflow-x: hidden; - overflow-y: auto; - padding-left: 2em; - padding-right: 2em; - padding-top: 1em; - min-width: 550px; -} - -#contents.isShowingTOC { - left: 230px; - min-width: 320px; -} - -.copyright { - font-size: 12px; -} - -.generator { - font-size: 11px; -} - -.main-navigation ul li { - display: inline; - margin-left: 15px; - list-style: none; -} - -.navigation-top { - clear: both; - float: right; -} - -.navigation-bottom { - clear: both; - float: right; - margin-top: 20px; - margin-bottom: -10px; -} - -.open > .disclosure { - background-image: url("../img/disclosure_open.png"); -} - -.disclosure { - background: url("../img/disclosure.png") no-repeat scroll 0 0; -} - -.disclosure, .nodisclosure { - display: inline-block; - height: 8px; - margin-right: 5px; - position: relative; - width: 9px; -} - -/* @end */ - -/* @group Header */ - -#top_header #library { - background: url("../img/library_background.png") repeat-x 0 0 #485E78; - background-color: #ccc; - height: 35px; - font-size: 115%; -} - -#top_header #library #libraryTitle { - color: #FFFFFF; - margin-left: 15px; - text-shadow: 0 -1px 0 #485E78; - top: 8px; - position: absolute; -} - -#libraryTitle { - left: 0; -} - -#top_header #library #developerHome { - color: #92979E; - right: 15px; - top: 8px; - position: absolute; -} - -#top_header #library a:hover { - text-decoration: none; -} - -#top_header #title { - background: url("../img/title_background.png") repeat-x 0 0 #8A98A9; - border-bottom: 1px solid #757575; - height: 25px; - overflow: hidden; -} - -#top_header h1 { - font-size: 105%; - font-weight: normal; - margin: 0; - padding: 3px 0 2px; - text-align: center; - /*text-shadow: 0 1px 0 #D5D5D5;*/ - white-space: nowrap; -} - -#headerButtons { - background-color: #D8D8D8; - background-image: url("../img/button_bar_background.png"); - border-bottom: 0px solid #EDEDED; - border-top: 0px solid #a8a8a8; - font-size: 8pt; - height: 28px; - left: 0; - list-style: none outside none; - margin: 0; - overflow: hidden; - padding: 0; - position: absolute; - right: 0; - top: 61px; -} - -#headerButtons li { - background-repeat: no-repeat; - display: inline; - margin-top: 0; - margin-bottom: 0; - padding: 0; -} - -#toc_button button { - background-color: #EBEEF1; - border-color: #ACACAC; - border-style: none solid none none; - border-width: 0 1px 0 0; - height: 28px; - margin: 0; - padding-left: 30px; - text-align: left; - width: 230px; -} - -li#jumpto_button { - left: 230px; - margin-left: 0; - position: absolute; -} - -li#jumpto_button select { - height: 22px; - margin: 5px 2px 0 10px; - max-width: 300px; -} - -/* @end */ - -/* @group Table of contents */ - -#tocContainer.isShowingTOC { - border-right: 1px solid #ACACAC; - display: block; - overflow-x: hidden; - overflow-y: auto; - padding: 0; -} - -#tocContainer { - background-color: #EBEEF1; - border-top: 1px solid #ACACAC; - bottom: 0; - display: none; - left: 0; - overflow: hidden; - position: absolute; - top: 90px; - width: 229px; -} - -#tocContainer > ul#toc { - font-size: 11px; - margin: 0; - padding: 12px 0 18px; - width: 209px; - -moz-user-select: none; - -webkit-user-select: none; - user-select: none; -} - -#tocContainer > ul#toc > li { - margin: 0; - padding: 0 0 7px 30px; - text-indent: -15px; -} - -#tocContainer > ul#toc > li > .sectionName a { - color: #000000; - font-weight: bold; -} - -#tocContainer > ul#toc > li > .sectionName a:hover { - text-decoration: none; -} - -#tocContainer > ul#toc li.children > ul { - display: none; - height: 0; -} - -#tocContainer > ul#toc > li > ul { - margin: 0; - padding: 0; -} - -#tocContainer > ul#toc > li > ul, ul#toc > li > ul > li { - margin-left: 0; - margin-bottom: 0; - padding-left: 15px; -} - -#tocContainer > ul#toc > li ul { - list-style: none; - margin-right: 0; - padding-right: 0; -} - -#tocContainer > ul#toc li.children.open > ul { - display: block; - height: auto; - margin-left: -15px; - padding-left: 0; -} - -#tocContainer > ul#toc > li > ul, ul#toc > li > ul > li { - margin-left: 0; - padding-left: 15px; -} - -#tocContainer li ul li { - margin-top: 0.583em; - overflow: hidden; - text-overflow: ellipsis; - white-space: nowrap; -} - -#tocContainer li ul li span.sectionName { - white-space: normal; -} - -#tocContainer > ul#toc > li > ul > li > .sectionName a { - font-weight: bold; -} - -#tocContainer > ul#toc > li > ul a { - color: #4F4F4F; -} - -/* @end */ - -/* @group Index formatting */ - -.index-title { - font-size: 13px; - font-weight: normal; -} - -.index-column { - float: left; - width: 30%; - min-width: 200px; - font-size: 11px; -} - -.index-column ul { - margin: 8px 0 0 0; - padding: 0; - list-style: none; -} - -.index-column ul li { - margin: 0 0 3px 0; - padding: 0; -} - -.hierarchy-column { - min-width: 400px; -} - -.hierarchy-column ul { - margin: 3px 0 0 15px; -} - -.hierarchy-column ul li { - list-style-type: square; -} - -/* @end */ - -/* @group Common formatting elements */ - -.title { - font-weight: normal; - font-size: 215%; - margin-top:0; -} - -.subtitle { - font-weight: normal; - font-size: 180%; - color: #3C4C6C; - border-bottom: 1px solid #5088C5; -} - -.subsubtitle { - font-weight: normal; - font-size: 145%; - height: 0.7em; -} - -.note { - border: 1px solid #5088C5; - background-color: white; - margin: 1.667em 0 1.75em 0; - padding: 0 .667em .083em .750em; -} - -.warning { - border: 1px solid #5088C5; - background-color: #F0F3F7; - margin-bottom: 0.5em; - padding: 0.3em 0.8em; -} - -.bug { - border: 1px solid #000; - background-color: #ffffcc; - margin-bottom: 0.5em; - padding: 0.3em 0.8em; -} - -.deprecated { - color: #F60425; -} - -/* @end */ - -/* @group Common layout */ - -.section { - margin-top: 3em; -} - -/* @end */ - -/* @group Object specification section */ - -.section-specification { - margin-left: 2.5em; - margin-right: 2.5em; - font-size: 12px; -} - -.section-specification table { - margin-bottom: 0em; - border-top: 1px solid #d6e0e5; -} - -.section-specification td { - vertical-align: top; - border-bottom: 1px solid #d6e0e5; - border-left-width: 0px; - border-right-width: 0px; - border-top-width: 0px; - padding: .6em; -} - -.section-specification .specification-title { - font-weight: bold; -} - -/* @end */ - -/* @group Tasks section */ - -.task-list { - list-style-type: none; - padding-left: 0px; -} - -.task-list li { - margin-bottom: 3px; -} - -.task-item-suffix { - color: #996; - font-size: 12px; - font-style: italic; - margin-left: 0.5em; -} - -span.tooltip span.tooltip { - font-size: 1.0em; - display: none; - padding: 0.3em; - border: 1px solid #aaa; - background-color: #fdfec8; - color: #000; - text-align: left; -} - -span.tooltip:hover span.tooltip { - display: block; - position: absolute; - margin-left: 2em; -} - -/* @end */ - -/* @group Method section */ - -.section-method { - margin-top: 2.3em; -} - -.method-title { - margin-bottom: 1.5em; -} - -.method-subtitle { - margin-top: 0.7em; - margin-bottom: 0.2em; -} - -.method-subsection p { - margin-top: 0.4em; - margin-bottom: 0.8em; -} - -.method-declaration { - margin-top:1.182em; - margin-bottom:.909em; -} - -.method-declaration code { - font:14px Courier, Consolas, monospace; - color:#000; -} - -.declaration { - color: #000; -} - -.termdef { - margin-bottom: 10px; - margin-left: 0px; - margin-right: 0px; - margin-top: 0px; -} - -.termdef dt { - margin: 0; - padding: 0; -} - -.termdef dd { - margin-bottom: 6px; - margin-left: 16px; - margin-right: 0px; - margin-top: 1px; -} - -.termdef dd p { - margin-bottom: 6px; - margin-left: 0px; - margin-right: 0px; - margin-top: -1px; -} - -.argument-def { - margin-top: 0.3em; - margin-bottom: 0.3em; -} - -.argument-def dd { - margin-left: 1.25em; -} - -.see-also-section ul { - list-style-type: none; - padding-left: 0px; - margin-top: 0; -} - -.see-also-section li { - margin-bottom: 3px; -} - -.declared-in-ref { - color: #666; -} - -#tocContainer.hideInXcode { - display: none; - border: 0px solid black; -} - -#top_header.hideInXcode { - display: none; -} - -#contents.hideInXcode { - border: 0px solid black; - top: 0px; - left: 0px; -} - -/* @end */ - diff --git a/appledoc/css/stylesPrint.css b/appledoc/css/stylesPrint.css deleted file mode 100644 index dc54cd2f..00000000 --- a/appledoc/css/stylesPrint.css +++ /dev/null @@ -1,22 +0,0 @@ - -header { - display: none; -} - -div.main-navigation, div.navigation-top { - display: none; -} - -div#overview_contents, div#contents.isShowingTOC, div#contents { - overflow: visible; - position: relative; - top: 0px; - border: none; - left: 0; -} -#tocContainer.isShowingTOC { - display: none; -} -nav { - display: none; -} \ No newline at end of file diff --git a/appledoc/hierarchy.html b/appledoc/hierarchy.html index d634998d..a66d0b46 100644 --- a/appledoc/hierarchy.html +++ b/appledoc/hierarchy.html @@ -1,103 +1,147 @@ - + - - - AsyncDisplayKit Hierarchy - - - - - -
    - + + + + AsyncDisplayKit Hierarchy + + + + + + +
    +
    - - -
    -
    + + + +
    +
    +
    +
    +

    AsyncDisplayKit Hierarchy

    +

    Class Hierarchy

    -
    + - -
    - - + + +
    -
    - + + + + + \ No newline at end of file diff --git a/appledoc/index.html b/appledoc/index.html index 394d876e..6133940f 100644 --- a/appledoc/index.html +++ b/appledoc/index.html @@ -1,157 +1,208 @@ - + - - - AsyncDisplayKit Reference - - - - - -
    - + + + + AsyncDisplayKit Reference + + + + + + +
    +
    - +
    + + + +
    +
    +
    +
    +

    AsyncDisplayKit Reference

    + + + +
    + + + + + + + + + +
    + + +
    - -
    -
    -
    - - - - - -
    -
    - + + + + + \ No newline at end of file diff --git a/appledoc/js/script.js b/appledoc/js/script.js new file mode 100644 index 00000000..4074361c --- /dev/null +++ b/appledoc/js/script.js @@ -0,0 +1,59 @@ +function $() { + return document.querySelector.apply(document, arguments); +} + +if (navigator.userAgent.indexOf("Xcode") != -1) { + document.documentElement.classList.add("xcode"); +} + +var jumpTo = $("#jump-to"); + +if (jumpTo) { + jumpTo.addEventListener("change", function(e) { + location.hash = this.options[this.selectedIndex].value; + }); +} + +function hashChanged() { + if (/^#\/\/api\//.test(location.hash)) { + var element = document.querySelector("a[name='" + location.hash.substring(1) + "']"); + + if (!element) { + return; + } + + element = element.parentNode; + + element.classList.remove("hide"); + fixScrollPosition(element); + } +} + +function fixScrollPosition(element) { + var scrollTop = element.offsetTop - 150; + document.documentElement.scrollTop = scrollTop; + document.body.scrollTop = scrollTop; +} + +[].forEach.call(document.querySelectorAll(".section-method"), function(element) { + element.classList.add("hide"); + + element.querySelector(".method-title a").addEventListener("click", function(e) { + var info = element.querySelector(".method-info"), + infoContainer = element.querySelector(".method-info-container"); + + element.classList.add("animating"); + info.style.height = (infoContainer.clientHeight + 40) + "px"; + fixScrollPosition(element); + element.classList.toggle("hide"); + if (element.classList.contains("hide")) { + e.preventDefault(); + } + setTimeout(function() { + element.classList.remove("animating"); + }, 300); + }); +}); + +window.addEventListener("hashchange", hashChanged); +hashChanged(); diff --git a/css/main.css b/css/main.css index 559ed6e2..1c0291e3 100644 --- a/css/main.css +++ b/css/main.css @@ -15,7 +15,7 @@ body { font-size: 16px; line-height: 1.5; font-weight: 300; - color: #111111; + color: #111; background-color: #f8f8f8; -webkit-text-size-adjust: 100%; } @@ -67,9 +67,9 @@ a { color: #21b6ff; text-decoration: none; } a:visited { - color: #008ed3; } + color: #008ed4; } a:hover { - color: #111111; + color: #111; text-decoration: underline; } /** @@ -175,9 +175,9 @@ pre { .site-nav .page-link:not(:first-child) { margin-left: 20px; } .site-nav .page-link:hover { - color: #111111; } + color: #111; } .site-nav .page-link-active { - color: #111111; } + color: #111; } @media screen and (max-width: 600px) { .site-nav { position: absolute; @@ -353,32 +353,32 @@ pre { font-style: italic; } .highlight .gd { color: #000; - background-color: #ffdddd; } + background-color: #fdd; } .highlight .gd .x { color: #000; - background-color: #ffaaaa; } + background-color: #faa; } .highlight .ge { font-style: italic; } .highlight .gr { - color: #aa0000; } + color: #a00; } .highlight .gh { - color: #999999; } + color: #999; } .highlight .gi { color: #000; - background-color: #ddffdd; } + background-color: #dfd; } .highlight .gi .x { color: #000; - background-color: #aaffaa; } + background-color: #afa; } .highlight .go { - color: #888888; } + color: #888; } .highlight .gp { - color: #555555; } + color: #555; } .highlight .gs { font-weight: bold; } .highlight .gu { - color: #aaaaaa; } + color: #aaa; } .highlight .gt { - color: #aa0000; } + color: #a00; } .highlight .kc { color: orange; } .highlight .kd { @@ -410,7 +410,7 @@ pre { .highlight .nt { color: orange; } .highlight .w { - color: #bbbbbb; } + color: #bbb; } .highlight .mh { color: black; } .highlight .mi { @@ -420,21 +420,21 @@ pre { .highlight .il { color: black; } .highlight .sb { - color: #dd1144; } + color: #d14; } .highlight .sc { - color: #dd1144; } + color: #d14; } .highlight .sd { - color: #dd1144; } + color: #d14; } .highlight .s2 { - color: #dd1144; } + color: #d14; } .highlight .se { - color: #dd1144; } + color: #d14; } .highlight .sh { - color: #dd1144; } + color: #d14; } .highlight .si { - color: #dd1144; } + color: #d14; } .highlight .sx { - color: #dd1144; } + color: #d14; } .highlight .sr { color: orange; } .highlight .s1 { diff --git a/guide/5/index.html b/guide/5/index.html index 2ce5f915..bc364467 100644 --- a/guide/5/index.html +++ b/guide/5/index.html @@ -138,6 +138,7 @@ layer-backed:

    if (!self.layerBacked) { _gestureRecogniser = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(_tap:)]; + [self.view addGestureRecognizer:_gestureRecogniser]; } }