GBParagraphListItem Class Reference

Inherits from	GBParagraphItem : NSObject
Declared in	GBParagraphListItem.h<br />GBParagraphListItem.m

Overview

Handles ordered and unordered lists for a GBCommentParagraph .

Lists are containers for list items which are instances of GBCommentParagraph . This allows us to form a tree structure with nested lists and other paragraph items. Lists can be ordered or unordered, the type can be determined by testing the value of isOrdered property.

Tasks

Initialization & disposal

+ orderedParagraphListItem Returns new autoreleased list item with ordered set to YES .
+ unorderedParagraphListItem Returns new autoreleased list item with ordered set to NO .

Values

- registerItem: Registers the given item by adding it to the end of items array.
isOrdered Specifies whether the list is ordered ( YES ) or unordered ( NO ).
listItems Array of all list items as instances of GBCommentParagraph in the same order as in comment text.

Other Methods

+ newParagraphListItemWithOrderedValue:
- init
- isOrderedListItem
- isUnorderedListItem
- stringValue
- descriptionStringValue
- description

Class Methods

newParagraphListItemWithOrderedValue:

orderedParagraphListItem

Returns new autoreleased list item with ordered set to YES .

+ (id)orderedParagraphListItem

Discussion

Returns new autoreleased list item with ordered set to YES .

This is equivalent to initializing with designated initialized ( init ) and setting ordered property value of initializaed object to YES .

Declared In

GBParagraphListItem.h
GBParagraphListItem.m

unorderedParagraphListItem

Returns new autoreleased list item with ordered set to NO .

+ (id)unorderedParagraphListItem

Discussion

Returns new autoreleased list item with ordered set to NO .

This is equivalent to initializing with designated initialized ( init ) and setting ordered property value of initializaed object to NO .

Declared In

GBParagraphListItem.h
GBParagraphListItem.m

Instance Methods

description

descriptionStringValue

init

isOrderedListItem

isUnorderedListItem

registerItem:

Registers the given item by adding it to the end of items array.

- (void)registerItem:(GBCommentParagraph *)item

Parameters

item: GBCommentParagraph to register.

Discussion

Registers the given item by adding it to the end of items array.

Exceptions

NSException: Thrown if the given item is nil .

Declared In

GBParagraphListItem.h
GBParagraphListItem.m

stringValue

Properties

isOrdered

Specifies whether the list is ordered ( YES ) or unordered ( NO ).

@property (assign) BOOL isOrdered

Discussion

Specifies whether the list is ordered ( YES ) or unordered ( NO ).

Declared In

GBParagraphListItem.h

listItems

Array of all list items as instances of GBCommentParagraph in the same order as in comment text.

@property (readonly) NSArray *listItems

Discussion

Array of all list items as instances of GBCommentParagraph in the same order as in comment text.

Declared In

GBParagraphListItem.h