GBParagraphDecoratorItem Class Reference
| Inherits from | GBParagraphItem : NSObject |
| Declared in | GBParagraphDecoratorItem.h GBParagraphDecoratorItem.m |
Overview
Specifies a decorator paragraph item.
Decorator items wrap an array of GBParagraphItem and speficies a decoration to be applied over them. Use decorationType to determine the type of decoration and decoratedItems to get the array of item to be decorated.
Tasks
Item handling
-
– registerItem:Registers the given item to the end ofdecoratedItemsarray. -
– replaceItemsByRegisteringItemsFromArray:Replaces thedecoratedItemsarray with the objects from the given array.
Values
-
decorationTypeThe type of decoration to apply over assigneddecoratedItems. property -
decoratedItemsTheGBParagraphIteminstances we're decorating. property
Other Methods
-
– descriptionStringValueString value as used in debug description. -
– isBoldDecoratorItemReturnsYESif this is bold decorator item. This is only used to simplify output generation! -
– isItalicsDecoratorItemReturnsYESif this is italics decorator item. This is only used to simplify output generation! -
– isCodeDecoratorItemReturnsYESif this is code decorator item. This is only used to simplify output generation!
Properties
Instance Methods
descriptionStringValue
String value as used in debug description.
- (NSString *)descriptionStringValueDiscussion
By default this returns string value trimmed to a predefined maximum length, but subclasses can override to provide their specific implementation. This is only used for debugging purposes and should not be used for any output generation! See description method implementation for details.
Sending this message is equivalent to sending descriptionForStringValue: to receiver and passing it stringValue as the parameter.
Declared In
GBParagraphItem.h@48 -> GBParagraphDecoratorItem.misBoldDecoratorItem
Returns YES if this is bold decorator item. This is only used to simplify output generation!
- (BOOL)isBoldDecoratorItemDeclared In
GBParagraphItem.h@78 -> GBParagraphDecoratorItem.misCodeDecoratorItem
Returns YES if this is code decorator item. This is only used to simplify output generation!
- (BOOL)isCodeDecoratorItemDeclared In
GBParagraphItem.h@84 -> GBParagraphDecoratorItem.misItalicsDecoratorItem
Returns YES if this is italics decorator item. This is only used to simplify output generation!
- (BOOL)isItalicsDecoratorItemDeclared In
GBParagraphItem.h@81 -> GBParagraphDecoratorItem.mregisterItem:
Registers the given item to the end of decoratedItems array.
- (void)registerItem:(GBParagraphItem *)itemParameters
- item
- The item to register.
Exceptions
- NSException
- Thrown if the given item is
nil.
Declared In
GBParagraphDecoratorItem.h