MSISelector Class Reference

#import <MSISelector.h>

Inheritance diagram for MSISelector:

Instance Methods
(void)	- updateSubViewsTo:
(void)	- setSelection:
(void)	- updateSelectionDisplay:
(void)	- layoutElements
(void)	- changeAppearanceForTable
(id)	- initWithStyle:AndIsMultiSelect:
(void)	- addChildren:
(void)	- loadProperties:
(void)	- calcAndSetSelectedElements:selected:
(void)	- setSelected:isSelected:
(float)	- calcHeightIfFitSize
(CGSize)	- calcPreferViewSize:fontName:includeTitle:
(UIView *)	- getRootViewerContainer:
(CGFloat)	- getMinHeightLimit
(void)	- setUserInteractionEnabled:
(void)	- cleanUpTemporaryUIElements
(NSArray *)	- getSelectedIndexes
(NSInteger)	- getSelectorItemCount
(id< MSISelectorItemProtocol >)	- getSelectorItemAtIndex:
(NSInteger)	- getPanelCount
(NSInteger)	- getSelectedPanelIndex

Class Methods
(UIColor *)	+ textTintColor
(MSISelector *)	+ createSelectorWithStyle:AndIsMultiSelect:AndOrientation:AndFrame:AndParent:
(MSISelector *)	+ createSelectorWithStyle:AndIsMultiSelect:AndOrientation:AndParent:
(BOOL)	+ isMetricSupportedMax:andMin:andCount:withStyle:

Protected Attributes
BOOL	mUseSelectorDataProxy
SelectorDataProxy *__weak	mSelectorDataProxy
id< MSISelectorDelegate, MSISelectorDelegateInternal > __weak	mSelectorDelegate
UIView *	mParentView
Commander *__weak	mpCommander
NSString *__weak	attributeId
MSIProjectInfo *__weak	project
NSString *__weak	cubeId
NSString *__weak	cubeInstanceId
NSString *__weak	formId
NSString *__weak	controlKey
NSArray *__weak	selectedElements
NSArray *__weak	selectorElements
NSString *__weak	attributeName

Properties
BOOL	mIsActionLink
int	mBgIntColor
BOOL	mIsUnset
BOOL	mIsCGorCons
BOOL	mShowAll
CGRect	frame
EnumSelectorStyle	mSelectorStyle
EnumSelectorOrientation	mSelectorOrientation
BOOL	mIsMultiSelect
int	mItemWidthMode
float	mItemSpacing
std::vector< std::string >	mSelectorData
std::vector< int >	mSelectedItems
id< MSISelectorDelegate, MSISelectorDelegateInternal >	mSelectorDelegate
BOOL	mHasAllElement
std::string	mReplaceTextForEmptySelectionOnDropDownUC
UIFont *	mItemFont
UIFont *	mItemBoldFont
UIColor *	mFontColor
UIColor *	mBgColor
int	mBgStyle
UIColor *	mGradientColor
UIColor *	mSelectionColor
UIColor *	mSelectionGradientColor
UIColor *	mSelectionFontColor
SelectorDataProxy *	selectorDataProxy
BOOL	useSelectorDataProxy
std::string	mTitle
BOOL	mIsTitleNeedShowInDropDown
NSTextAlignment	mTextAlignment
BOOL	mSelectorModeInclude
Commander *	mpCommander
NSString *	mDisplayText
MSIProjectInfo *	project
NSString *	attributeId
NSString *	cubeId
NSString *	cubeInstanceId
NSString *	formId
NSString *	controlKey
BOOL	searchOnServer
BOOL	ucOnDataset
NSArray *	selectedElements
NSArray *	selectorElements
NSString *	attributeName
NSArray *	baseFormTypes
DSSRWControlIterator *	mpRWControlIterator
EnumSelectorSectionType	mSectionType
CGFloat	scaleRatio
CGFloat	scaleRatioVertical
BOOL	enabled

Method Documentation

addChildren:()

- (void) addChildren:

(UIView *)

iParentView

calcAndSetSelectedElements:selected:()

- (void) calcAndSetSelectedElements:		(int)	iIndex
selected:		(std::set< int > &)	ioSelected

calcHeightIfFitSize()

- (float) calcHeightIfFitSize

calcPreferViewSize:fontName:includeTitle:()

- (CGSize) calcPreferViewSize:		(CGFloat)	iFontSize
fontName:		(const char *)	iFontName
includeTitle:		(BOOL)	iIncludeTitle

changeAppearanceForTable()

- (void) changeAppearanceForTable

Add this API for table control

cleanUpTemporaryUIElements()

- (void) cleanUpTemporaryUIElements

createSelectorWithStyle:AndIsMultiSelect:AndOrientation:AndFrame:AndParent:()

+ (MSISelector*) createSelectorWithStyle:		(EnumSelectorStyle)	iSelectorStyle
AndIsMultiSelect:		(BOOL)	iIsMultiSelect
AndOrientation:		(EnumSelectorOrientation)	iSelectorOrientation
AndFrame:		(CGRect)	iRect
AndParent:		(UIView *)	iParentView

createSelectorWithStyle:AndIsMultiSelect:AndOrientation:AndParent:()

+ (MSISelector*) createSelectorWithStyle:		(EnumSelectorStyle)	iSelectorStyle
AndIsMultiSelect:		(BOOL)	iIsMultiSelect
AndOrientation:		(EnumSelectorOrientation)	iSelectorOrientation
AndParent:		(UIView *)	iParentView

getMinHeightLimit()

- (CGFloat) getMinHeightLimit

getPanelCount()

- (NSInteger) getPanelCount

This API is used to get total count of panels in its list. If the selector is attribute/metric, it will return -1.

getRootViewerContainer:()

- (UIView*) getRootViewerContainer:

(UIView *)

iView

getSelectedIndexes()

- (NSArray*) getSelectedIndexes

This API is used to get the selected indexes of selector items, the return object is an array of NSNumber, like [0, 1, 2 ...]. If the selector is Metric/Panel selector, it will return nil. If the selector is search selector, it will return an empty array.

getSelectedPanelIndex()

- (NSInteger) getSelectedPanelIndex

This API is used to get the index of selected panel. If there is no selected panel, it will return 0. If the selector is attribute/metric, it will return -1.

getSelectorItemAtIndex:()

- (id<MSISelectorItemProtocol>) getSelectorItemAtIndex:

(NSInteger)

iIndex

This API is used to get the item at special index. If the selector is Metric/Panel selector, it will return nil. If the selector is attribute search selector, it will return nil.

Parameters

iIndex

the index of item

getSelectorItemCount()

- (NSInteger) getSelectorItemCount

This API is used to get the total count of items in side selector. If there is item "(All)" inside selector, it will be also include in this count. If the selector is Metirc/Panel selector, it will return -1.

initWithStyle:AndIsMultiSelect:()

- (id) initWithStyle:		(EnumSelectorStyle)	iSelectorStyle
AndIsMultiSelect:		(BOOL)	iIsMultiSelect

isMetricSupportedMax:andMin:andCount:withStyle:()

+ (BOOL) isMetricSupportedMax:		(const CComVariant *)	_max
andMin:		(const CComVariant *)	min
andCount:		(const CComVariant *)	count
withStyle:		(EnumSelectorStyle)	style

layoutElements()

- (void) layoutElements

The method is called when rotation happens. It is to adjust all its subviews when ratation happens.

loadProperties:()

- (void) loadProperties:

(DSSFormat *)

ipFormat

setSelected:isSelected:()

- (void) setSelected:		(int)	iIndex
isSelected:		(BOOL)	iIsSelected

setSelection:()

- (void) setSelection:

(int)

iSelectedIndex

The method is to switch the selection. It will highlight the newly selected element, dehighlight the old one, etc.

Parameters

iSelectedIndex

Specifies the index of the element to be selected.

setUserInteractionEnabled:()

- (void) setUserInteractionEnabled:

(BOOL)

userInteractionEnabled

textTintColor()

+ (UIColor*) textTintColor

Get the text tint color for iOS 7 through DocumentThemeHelper.

updateSelectionDisplay:()

- (void) updateSelectionDisplay:

(const std::set< int > &)

iSelectedItems

The method is to update the selector viewer display accrording to the input. The common scenario is when multiple selectors are have the same targets, if one of them switches, the others need to get updated.

Parameters

iSelectedItems

Specifies the selected items.

updateSubViewsTo:()

- (void) updateSubViewsTo:

(UIView *)

iParentView

The method first clears all the sub views in iParentView, then generate the selector viewer's content, maybe several sub UIViews, and add them to iParentView as its subviews.

Parameters

iParentView

Specifies the parent view of all the views generated in the method.

Member Data Documentation

attributeId

- (NSString* __weak) attributeId

protected

attributeName

- (NSString* __weak) attributeName

protected

controlKey

- (NSString* __weak) controlKey

protected

cubeId

- (NSString* __weak) cubeId

protected

cubeInstanceId

- (NSString* __weak) cubeInstanceId

protected

formId

- (NSString* __weak) formId

protected

mParentView

- (UIView*) mParentView

protected

mpCommander

- (Commander* __weak) mpCommander

protected

mSelectorDataProxy

- (SelectorDataProxy* __weak) mSelectorDataProxy

protected

mSelectorDelegate

- (id<MSISelectorDelegate, MSISelectorDelegateInternal> __weak) mSelectorDelegate

protected

mUseSelectorDataProxy

- (BOOL) mUseSelectorDataProxy

protected

project

- (MSIProjectInfo* __weak) project

protected

selectedElements

- (NSArray* __weak) selectedElements

protected

selectorElements

- (NSArray* __weak) selectorElements

protected

Property Documentation

attributeId

- (NSString*) attributeId

readwritenonatomicweak

attributeName

- (NSString*) attributeName

readwritenonatomicweak

baseFormTypes

- (NSArray *) baseFormTypes

readwritenonatomicstrong

controlKey

- (NSString*) controlKey

readwritenonatomicweak

cubeId

- (NSString*) cubeId

readwritenonatomicweak

cubeInstanceId

- (NSString*) cubeInstanceId

readwritenonatomicweak

enabled

- (BOOL) enabled

readwritenonatomicassign

formId

- (NSString*) formId

readwritenonatomicweak

frame

- (CGRect) frame

readwritenonatomicassign

mBgColor

- (UIColor *) mBgColor

readwritenonatomicstrong

mBgIntColor

- (int) mBgIntColor

readwritenonatomicassign

mBgStyle

- (int) mBgStyle

readwritenonatomicassign

mDisplayText

- (NSString *) mDisplayText

readwritenonatomicstrong

mFontColor

- (UIColor *) mFontColor

readwritenonatomicstrong

mGradientColor

- (UIColor *) mGradientColor

readwritenonatomicstrong

mHasAllElement

- (BOOL) mHasAllElement

readwritenonatomicassign

mIsActionLink

- (BOOL) mIsActionLink

readwritenonatomicassign

mIsCGorCons

- (BOOL) mIsCGorCons

readwritenonatomicassign

mIsMultiSelect

- (BOOL) mIsMultiSelect

readwritenonatomicassign

mIsTitleNeedShowInDropDown

- (BOOL) mIsTitleNeedShowInDropDown

readwritenonatomicassign

mIsUnset

- (BOOL) mIsUnset

readwritenonatomicassign

mItemBoldFont

- (UIFont *) mItemBoldFont

readwritenonatomicstrong

mItemFont

- (UIFont *) mItemFont

readwritenonatomicstrong

mItemSpacing

- (float) mItemSpacing

readwritenonatomicassign

mItemWidthMode

- (int) mItemWidthMode

readwritenonatomicassign

mpCommander

- (Commander*) mpCommander

readwritenonatomicweak

mpRWControlIterator

- (DSSRWControlIterator *) mpRWControlIterator

readwritenonatomicassign

mReplaceTextForEmptySelectionOnDropDownUC

- (string) MSISelector:

readwritenonatomicassign

mSectionType

- (EnumSelectorSectionType) mSectionType

readwritenonatomicassign

mSelectedItems

- (vector< int >) MSISelector:

readwritenonatomicassign

mSelectionColor

- (UIColor *) mSelectionColor

readwritenonatomicstrong

mSelectionFontColor

- (UIColor *) mSelectionFontColor

readwritenonatomicstrong

mSelectionGradientColor

- (UIColor *) mSelectionGradientColor

readwritenonatomicstrong

mSelectorData

- (vector<) std:

readwritenonatomicassign

mSelectorDelegate

- (id<MSISelectorDelegate, MSISelectorDelegateInternal>) mSelectorDelegate

readwritenonatomicweak

mSelectorModeInclude

- (BOOL) mSelectorModeInclude

readwritenonatomicassign

mSelectorOrientation

- (EnumSelectorOrientation) mSelectorOrientation

readwritenonatomicassign

mSelectorStyle

- (EnumSelectorStyle) mSelectorStyle

readwritenonatomicassign

mShowAll

- (BOOL) mShowAll

readwritenonatomicassign

mTextAlignment

- (NSTextAlignment) mTextAlignment

readwritenonatomicassign

mTitle

- (string) MSISelector:

readwritenonatomicassign

project

- (MSIProjectInfo*) project

readwritenonatomicweak

scaleRatio

- (CGFloat) scaleRatio

readwritenonatomicassign

scaleRatioVertical

- (CGFloat) scaleRatioVertical

readwritenonatomicassign

searchOnServer

- (BOOL) searchOnServer

readwritenonatomicassign

selectedElements

- (NSArray*) selectedElements

readwritenonatomicweak

selectorDataProxy

- (SelectorDataProxy*) selectorDataProxy

readwritenonatomicweak

selectorElements

- (NSArray*) selectorElements

readwritenonatomicweak

ucOnDataset

- (BOOL) ucOnDataset

readwritenonatomicassign

useSelectorDataProxy

- (BOOL) useSelectorDataProxy

readwritenonatomicassign