C# Class FlatRedBall.Gui.ListBoxBase

Inheritance: NS004.c000068, i000071
显示文件 Open project: vchelaru/FlatRedBall Class Usage Examples

Public Properties

Property Type Description
CtrlClickOn bool
Lined bool
ShiftClickOn bool

Protected Properties

Property Type Description
mFirstItemDistanceFromTop float
mHighlight Sprite
mHighlightBar FlatRedBall.ManagedSpriteGroups.SpriteFrame
mLeftBorder float
mScrollBar ScrollBar
mTakingInput bool
mTexts PositionedObjectList

Public Methods

Method Description
Activity ( Camera camera ) : void
AddItem ( string stringToAdd ) : CollapseItem
AddItem ( string stringToAdd, object referenceObject ) : CollapseItem
AddToLayer ( Layer layerToAddTo ) : void
AdjustScrollSize ( ) : void
ClearEvents ( ) : void
Contains ( CollapseItem itemToSearchFor ) : bool
FillWithAllReferencedItems ( IList listToFill ) : void
GetFirstHighlightedItem ( ) : CollapseItem
GetFirstHighlightedObject ( ) : object
GetHighlightedObject ( ) : List
GetItem ( int itemNumber ) : CollapseItem

Returns the CollapseItem at index itemNumber traversing from the top of the list down.

This method will skip over items that are children of collapsed items. The list is traversed down ignoring hierarchy, but only counting "visible" items.

GetItem ( object itemToGet ) : CollapseItem
GetItemAtCursor ( ) : CollapseItem
GetItemByName ( string itemToGet ) : CollapseItem
GetNumCollapsed ( ) : int
HighlightItem ( CollapseItem itemToHighlight ) : void
HighlightItem ( CollapseItem itemToHighlight, bool addToHighlighted ) : void
HighlightItem ( string itemToHighlight ) : void
HighlightItemAtCursor ( Window callingWindow ) : void
HighlightItemNoCall ( CollapseItem itemToHighlight, bool addToHighlighted ) : void
HighlightObject ( object objectToHighlight ) : void
HighlightObject ( object objectToHighlight, bool addToHighlighted ) : void
HighlightObjectNoCall ( object objectToHighlight, bool addToHighlighted ) : void
InsertItem ( int index, CollapseItem itemToInsert ) : CollapseItem
InsertItem ( int index, string stringToAdd ) : CollapseItem
InsertItem ( int index, string stringToAdd, object referenceObject ) : CollapseItem
IsVisibleInBox ( CollapseItem ci ) : bool
ListBoxBase ( Cursor cursor ) : System
ListBoxBase ( GuiSkin guiSkin, Cursor cursor ) : System
LoseFocus ( ) : void
OnFocusUpdate ( ) : void
OnGainFocus ( ) : void
OnPrimaryClick ( Window callingWindow ) : void
OnPrimaryPush ( Window callingWindow ) : void
ReceiveInput ( ) : void
RemoveCollapseItem ( CollapseItem item ) : void
RemoveItemAt ( int index ) : CollapseItem
RemoveItemByName ( string itemToRemove ) : CollapseItem

Removes the item from the CollapseListBox.

This method removes the item from the CollapseListBox and detaches the item's children and reattaches them to the box. The assumption here is that the item will not be reattached.

RemoveItemByObject ( object objectToRemove ) : CollapseItem
SetSkin ( GuiSkin guiSkin ) : void
Sort ( ) : void
StrongSelectAtCursor ( Window callingWindow ) : void
TestCollision ( Cursor cursor ) : void
this ( int i ) : CollapseItem

Protected Methods

Method Description
Destroy ( bool keepEvents ) : void
GetAbsoluteScreenY ( CollapseItem collapseItem ) : float
GetNthVisibleItem ( int number ) : CollapseItem
GetVisibleIndex ( CollapseItem collapseItem ) : int
KeepHighlightInView ( CollapseItem itemToHighlight ) : void
OnHighlight ( ) : void
UpdateHighlightSpriteFrame ( ) : void
UpdateSeparators ( ) : void
UpdateTextPositions ( ) : void
UpdateTextStrings ( ) : void

Private Methods

Method Description
ClickOutliningButton ( CollapseItem collapseItem, ListBoxBase collapseListBox, ListBoxIcon listBoxIcon ) : void
Destroy ( ) : void
DrawSelfAndChildren ( Camera camera ) : void
GetCIAt ( float yPos ) : CollapseItem
GetItemNumber ( CollapseItem item ) : int
GetNumberOfVerticesToDraw ( ) : int
Initialize ( ) : void
SetInsertLocationIndex ( ) : void
UpdateSeparatorProperties ( ) : void
UpdateStartAtToScrollBar ( Window callingWindow ) : void

Method Details

Activity() public method

public Activity ( Camera camera ) : void
camera Camera
return void

AddItem() public method

public AddItem ( string stringToAdd ) : CollapseItem
stringToAdd string
return CollapseItem

AddItem() public method

public AddItem ( string stringToAdd, object referenceObject ) : CollapseItem
stringToAdd string
referenceObject object
return CollapseItem

AddToLayer() public method

public AddToLayer ( Layer layerToAddTo ) : void
layerToAddTo Layer
return void

AdjustScrollSize() public method

public AdjustScrollSize ( ) : void
return void

ClearEvents() public method

public ClearEvents ( ) : void
return void

Contains() public method

public Contains ( CollapseItem itemToSearchFor ) : bool
itemToSearchFor CollapseItem
return bool

Destroy() protected method

protected Destroy ( bool keepEvents ) : void
keepEvents bool
return void

FillWithAllReferencedItems() public method

public FillWithAllReferencedItems ( IList listToFill ) : void
listToFill IList
return void

GetAbsoluteScreenY() protected method

protected GetAbsoluteScreenY ( CollapseItem collapseItem ) : float
collapseItem CollapseItem
return float

GetFirstHighlightedItem() public method

public GetFirstHighlightedItem ( ) : CollapseItem
return CollapseItem

GetFirstHighlightedObject() public method

public GetFirstHighlightedObject ( ) : object
return object

GetHighlightedObject() public method

public GetHighlightedObject ( ) : List
return List

GetItem() public method

Returns the CollapseItem at index itemNumber traversing from the top of the list down.
This method will skip over items that are children of collapsed items. The list is traversed down ignoring hierarchy, but only counting "visible" items.
public GetItem ( int itemNumber ) : CollapseItem
itemNumber int The index to return
return CollapseItem

GetItem() public method

public GetItem ( object itemToGet ) : CollapseItem
itemToGet object
return CollapseItem

GetItemAtCursor() public method

public GetItemAtCursor ( ) : CollapseItem
return CollapseItem

GetItemByName() public method

public GetItemByName ( string itemToGet ) : CollapseItem
itemToGet string
return CollapseItem

GetNthVisibleItem() protected method

protected GetNthVisibleItem ( int number ) : CollapseItem
number int
return CollapseItem

GetNumCollapsed() public method

public GetNumCollapsed ( ) : int
return int

GetVisibleIndex() protected method

protected GetVisibleIndex ( CollapseItem collapseItem ) : int
collapseItem CollapseItem
return int

HighlightItem() public method

public HighlightItem ( CollapseItem itemToHighlight ) : void
itemToHighlight CollapseItem
return void

HighlightItem() public method

public HighlightItem ( CollapseItem itemToHighlight, bool addToHighlighted ) : void
itemToHighlight CollapseItem
addToHighlighted bool
return void

HighlightItem() public method

public HighlightItem ( string itemToHighlight ) : void
itemToHighlight string
return void

HighlightItemAtCursor() public method

public HighlightItemAtCursor ( Window callingWindow ) : void
callingWindow Window
return void

HighlightItemNoCall() public method

public HighlightItemNoCall ( CollapseItem itemToHighlight, bool addToHighlighted ) : void
itemToHighlight CollapseItem
addToHighlighted bool
return void

HighlightObject() public method

public HighlightObject ( object objectToHighlight ) : void
objectToHighlight object
return void

HighlightObject() public method

public HighlightObject ( object objectToHighlight, bool addToHighlighted ) : void
objectToHighlight object
addToHighlighted bool
return void

HighlightObjectNoCall() public method

public HighlightObjectNoCall ( object objectToHighlight, bool addToHighlighted ) : void
objectToHighlight object
addToHighlighted bool
return void

InsertItem() public method

public InsertItem ( int index, CollapseItem itemToInsert ) : CollapseItem
index int
itemToInsert CollapseItem
return CollapseItem

InsertItem() public method

public InsertItem ( int index, string stringToAdd ) : CollapseItem
index int
stringToAdd string
return CollapseItem

InsertItem() public method

public InsertItem ( int index, string stringToAdd, object referenceObject ) : CollapseItem
index int
stringToAdd string
referenceObject object
return CollapseItem

IsVisibleInBox() public method

public IsVisibleInBox ( CollapseItem ci ) : bool
ci CollapseItem
return bool

KeepHighlightInView() protected method

protected KeepHighlightInView ( CollapseItem itemToHighlight ) : void
itemToHighlight CollapseItem
return void

ListBoxBase() public method

public ListBoxBase ( Cursor cursor ) : System
cursor Cursor
return System

ListBoxBase() public method

public ListBoxBase ( GuiSkin guiSkin, Cursor cursor ) : System
guiSkin GuiSkin
cursor Cursor
return System

LoseFocus() public method

public LoseFocus ( ) : void
return void

OnFocusUpdate() public method

public OnFocusUpdate ( ) : void
return void

OnGainFocus() public method

public OnGainFocus ( ) : void
return void

OnHighlight() protected method

protected OnHighlight ( ) : void
return void

OnPrimaryClick() public method

public OnPrimaryClick ( Window callingWindow ) : void
callingWindow Window
return void

OnPrimaryPush() public method

public OnPrimaryPush ( Window callingWindow ) : void
callingWindow Window
return void

ReceiveInput() public method

public ReceiveInput ( ) : void
return void

RemoveCollapseItem() public method

public RemoveCollapseItem ( CollapseItem item ) : void
item CollapseItem
return void

RemoveItemAt() public method

public RemoveItemAt ( int index ) : CollapseItem
index int
return CollapseItem

RemoveItemByName() public method

Removes the item from the CollapseListBox.
This method removes the item from the CollapseListBox and detaches the item's children and reattaches them to the box. The assumption here is that the item will not be reattached.
public RemoveItemByName ( string itemToRemove ) : CollapseItem
itemToRemove string
return CollapseItem

RemoveItemByObject() public method

public RemoveItemByObject ( object objectToRemove ) : CollapseItem
objectToRemove object
return CollapseItem

SetSkin() public method

public SetSkin ( GuiSkin guiSkin ) : void
guiSkin GuiSkin
return void

Sort() public method

public Sort ( ) : void
return void

StrongSelectAtCursor() public method

public StrongSelectAtCursor ( Window callingWindow ) : void
callingWindow Window
return void

TestCollision() public method

public TestCollision ( Cursor cursor ) : void
cursor Cursor
return void

UpdateHighlightSpriteFrame() protected method

protected UpdateHighlightSpriteFrame ( ) : void
return void

UpdateSeparators() protected method

protected UpdateSeparators ( ) : void
return void

UpdateTextPositions() protected method

protected UpdateTextPositions ( ) : void
return void

UpdateTextStrings() protected method

protected UpdateTextStrings ( ) : void
return void

this() public method

public this ( int i ) : CollapseItem
i int
return CollapseItem

Property Details

CtrlClickOn public_oe property

public bool CtrlClickOn
return bool

Lined public_oe property

public bool Lined
return bool

ShiftClickOn public_oe property

public bool ShiftClickOn
return bool

mFirstItemDistanceFromTop protected_oe property

protected float mFirstItemDistanceFromTop
return float

mHighlight protected_oe property

protected Sprite mHighlight
return Sprite

mHighlightBar protected_oe property

protected SpriteFrame,FlatRedBall.ManagedSpriteGroups mHighlightBar
return FlatRedBall.ManagedSpriteGroups.SpriteFrame

mLeftBorder protected_oe property

protected float mLeftBorder
return float

mScrollBar protected_oe property

protected ScrollBar,FlatRedBall.Gui mScrollBar
return ScrollBar

mTakingInput protected_oe property

protected bool mTakingInput
return bool

mTexts protected_oe property

protected PositionedObjectList mTexts
return PositionedObjectList