Mobile API Reference  MicroStrategy 2019
MSILayoutInfo Class Reference

#import <MSILayoutInfo.h>

Inheritance diagram for MSILayoutInfo:

Instance Methods

(id) - initWithData:
 
(NSArray *) - layoutsForOrientation:
 
(Layout *) - layoutForID:
 
(Layout *) - givenOrNextLayoutForID:orientation:
 
(NSInteger) - countForOrientation:
 
(NSInteger) - count
 
(NSInteger) - exclusiveCountForOrientation:
 
(Layout *) - nextLayout:orientation:
 
(Layout *) - prevLayout:orientation:
 
(NSInteger) - indexOfLayout:orientation:
 
(void) - addToOrientationMap:
 
(void) - addToHiddenLayouts:
 
(void) - addDummyLayoutForNoLayout
 
(void) - setPreferredLayouts
 
(Layout *) - targetLayoutForKey:
 
(NSInteger) - visibleLayoutCount
 

Protected Attributes

NSMutableDictionary * orientationMap
 
NSInteger idCounter
 
NSMutableDictionary * hiddenLayouts
 used for map widget target layout which should be hidden. More...
 

Properties

id< LayoutInfoDelegatedelegate
 sets the argument as currentLayout if it's not already the currentLayout More...
 
Layout * currentLayout
 stores the current layout More...
 
NSInteger layoutBarStyle
 
NSInteger layoutBarPosition
 
NSMutableArray * layouts
 
BOOL fresh
 indicates whether or not the layoutInfo must be refreshed More...
 

Method Documentation

◆ addDummyLayoutForNoLayout()

- (void) addDummyLayoutForNoLayout

◆ addToHiddenLayouts:()

- (void) addToHiddenLayouts: (Layout *)  layout

◆ addToOrientationMap:()

- (void) addToOrientationMap: (Layout *)  layout

◆ count()

- (NSInteger) count

◆ countForOrientation:()

- (NSInteger) countForOrientation: (NSInteger)  orientation

◆ exclusiveCountForOrientation:()

- (NSInteger) exclusiveCountForOrientation: (NSInteger)  orientation

◆ givenOrNextLayoutForID:orientation:()

- (Layout*) givenOrNextLayoutForID: (NSInteger)  layoutID
orientation: (NSInteger)  orientation 

◆ indexOfLayout:orientation:()

- (NSInteger) indexOfLayout: (Layout *)  layout
orientation: (NSInteger)  orientation 

◆ initWithData:()

- (id) initWithData: (NSData *)  data

◆ layoutForID:()

- (Layout*) layoutForID: (NSInteger)  layoutID

◆ layoutsForOrientation:()

- (NSArray*) layoutsForOrientation: (NSInteger)  orientation

◆ nextLayout:orientation:()

- (Layout*) nextLayout: (Layout *)  layout
orientation: (NSInteger)  orientation 

◆ prevLayout:orientation:()

- (Layout*) prevLayout: (Layout *)  layout
orientation: (NSInteger)  orientation 

◆ setPreferredLayouts()

- (void) setPreferredLayouts

◆ targetLayoutForKey:()

- (Layout*) targetLayoutForKey: (NSString *)  layoutKey

◆ visibleLayoutCount()

- (NSInteger) visibleLayoutCount

Member Data Documentation

◆ hiddenLayouts

- (NSMutableDictionary*) hiddenLayouts
protected

used for map widget target layout which should be hidden.

◆ idCounter

- (NSInteger) idCounter
protected

◆ orientationMap

- (NSMutableDictionary*) orientationMap
protected

Property Documentation

◆ currentLayout

- (Layout *) currentLayout
readwritenonatomicstrong

stores the current layout

◆ delegate

- (id<LayoutInfoDelegate>) delegate
readwritenonatomicweak

sets the argument as currentLayout if it's not already the currentLayout

Future plans are to make this call the delegate with a notification that the currentLayout has been setupdates currentLayout to the lastAccessedPortraitLayout or lastAccessedLandscapeLayout dependent on the current orientation

◆ fresh

- (BOOL) fresh
readwritenonatomicassign

indicates whether or not the layoutInfo must be refreshed

TODO: rename this to currentTargetLayout

◆ layoutBarPosition

- (NSInteger) layoutBarPosition
readwriteatomic

◆ layoutBarStyle

- (NSInteger) layoutBarStyle
readwriteatomic

◆ layouts

- (NSMutableArray *) layouts
readatomicstrong