PLJukeboxView Class Reference

List of all members.

Public Member Functions

(id) - initWithFrame:initialCover:numberOfCovers:coverDataSource:delegate:
(id) - initWithFrame:initialCover:numberOfCovers:coverSize:coverCenterOffset:coverScale:coverDataSource:delegate:
(id) - initWithFrame:initialCover:numberOfCovers:viewConstants:coverDataSource:delegate:
(NSInteger) - indexOfSelectedCover
(void) - setIndexOfSelectedCover:
(void) - setIndexOfSelectedCover:animated:
(CGRect) - boundsOfSelectedCover
(void) - showInfoOfSelectedCover
(void) - hideInfoOfSelectedCover
(void) - toggleInfoOfSelectedCover
(BOOL) - isFlatModeEnabled
(void) - setFlatModeEnabled:
(void) - setFlatModeEnabled:withDuration:
(void) - toggleFlatModeWithDuration:
(void) - setImage:atIndex:
(void) - setInfoLayer:
(CALayer *) - infoLayer
(void) - setDataSource:
(void) - setDelegate:

Static Public Member Functions

(PLJukeboxViewConstants+ defaultConstants


Detailed Description

Jukebox Cover view.

Member Function Documentation

+ (PLJukeboxViewConstants) defaultConstants  

Returns a PLJukeboxViewConstants structure that is initialized to default values.

- (id) initWithFrame: (CGRect)  frame
initialCover: (NSInteger)  initialCover
numberOfCovers: (NSInteger)  coverCount
coverDataSource: (id<PLJukeboxDataSource>)  dataSource
delegate: (id<PLJukeboxDelegate>)  delegate 

Initialize a the view with the provided frame and data source. The cover size will default to 200x200.

Parameters:
frame The frame to use for the Jukebox view.
initialCover The initially centered cover index.
coverCount The number of covers to be displayed.
dataSource Cover image data source.
delegate Cover Flow view delegate. May be nil.

- (id) initWithFrame: (CGRect)  frame
initialCover: (NSInteger)  initialCover
numberOfCovers: (NSInteger)  coverCount
coverSize: (CGSize)  coverSize
coverCenterOffset: (CGFloat)  coverCenterOffset
coverScale: (BOOL)  coverScale
coverDataSource: (id<PLJukeboxDataSource>)  dataSource
delegate: (id<PLJukeboxDelegate>)  delegate 

Initialize a the view with the provided frame and data source.

Parameters:
frame The frame to use for the Jukebox view.
initialCover The initially centered cover index.
coverCount The number of covers to be displayed.
coverSize The expected cover size
coverCenterOffset Offset to be applied to cover's vertical centering. By default, covers are placed in the absolute center of the y axis.
coverScale If YES, covers will be scaled up (aspect preserving) to fit the specified cover size.
dataSource Cover image data source.
delegate Cover Flow view delegate. May be nil.

- (id) initWithFrame: (CGRect)  frame
initialCover: (NSInteger)  initialCover
numberOfCovers: (NSInteger)  coverCount
viewConstants: (PLJukeboxViewConstants viewConstants
coverDataSource: (id<PLJukeboxDataSource>)  dataSource
delegate: (id<PLJukeboxDelegate>)  delegate 

Initialize a the view with the provided frame, data source, and view constants.

Parameters:
frame The frame to use for the Jukebox view.
initialCover The initially centered cover index.
coverCount The number of covers to be displayed.
viewConstants The set of values that controls the appearance of the covers.
dataSource Cover image data source.
delegate Cover Flow view delegate. May be nil.

- (NSInteger) indexOfSelectedCover  

Return the current selection index

- (void) setIndexOfSelectedCover: (NSInteger)  index  

Set the current selection index, animating the transition.

Parameters:
index Index of the selected cover.

- (void) setIndexOfSelectedCover: (NSInteger)  index
animated: (BOOL)  animated 

Set the current selection index.

Parameters:
index Index of the selected cover.
animated If YES, the transition will be animated.

- (CGRect) boundsOfSelectedCover  

Return the bounds of the selected cover, relative to the upper-left corner of the cover flow view.

- (void) showInfoOfSelectedCover  

Display the backing info layer for the currently selected cover.

If the info layer is already visible, it will remain so. If any animations are pending, they will be completed prior to displaying the info layer.

- (void) hideInfoOfSelectedCover  

Hide the backing info layer for the currently selected cover.

If the info layer is not currently visible, no changes will be performed. If any animations are pending, they will be completed prior to hiding the info layer.

- (void) toggleInfoOfSelectedCover  

Hide or show the backing info layer for the currently selected cover.

- (BOOL) isFlatModeEnabled  

Returns YES if flat mode is enabled; NO otherwise.

- (void) setFlatModeEnabled: (BOOL)  enabled  

Enable or disable flat mode immediately (no animated transition).

Parameters:
enabled If YES, flat mode will be enabled, otherwise normal (perspective) mode will be enabled

- (void) setFlatModeEnabled: (BOOL)  enabled
withDuration: (NSTimeInterval)  duration 

Enable or disable flat mode, with a smooth transition between modes.

Parameters:
enabled If YES, flat mode will be enabled, otherwise normal (perspective) mode will be enabled
duration The duration of the transition animation

- (void) toggleFlatModeWithDuration: (NSTimeInterval)  duration  

Enable or disable flat mode, switching to the opposite of the current mode.

Parameters:
duration The duration of the transition animation

- (void) setImage: (UIImage *)  image
atIndex: (NSInteger)  index 

Set the image for a given index. This method is thread-safe, and may be called from any worker thread.

Parameters:
image Image to set. May be nil, in which case the default image will be used.
index Index of cover to update.

- (void) setInfoLayer: (CALayer *)  layer  

Set the backing information layer, used when covers are flipped.

- (CALayer *) infoLayer  

Return the backing information layer. May return nil if none has been set.

- (void) setDataSource: (id<PLJukeboxDataSource>)  dataSource  

Set the jukebox data source.

- (void) setDelegate: (id<PLJukeboxDelegate>)  delegate  

Set the jukebox delegate.


The documentation for this class was generated from the following files:

Generated on Wed Aug 18 09:29:23 2010 for PlausibleJukeboxView by  doxygen 1.5.5