MaxCustomControls::ExplorerTreeList Class Reference

---

Detailed Description

<exclude>

Specializes MaxTreeList for use with Explorers. Implements the Explorer interface and knows about ExplorerFramework constructs such as DataFacade, and TraversalNode.

Inheritance diagram for MaxCustomControls::ExplorerTreeList:

List of all members.

Classes
class	ApplyDefaultExpandStateTreeListOperation
class	ExpandState
class	ExpandStateCollection
class	GetNodeExpandStateTreeListOperation
class	NodeMapBuilder
class	SelectionState
Public Member Functions
	ExplorerTreeList ()
void	ClearNodeSelection ()
void	DeselectNode (TraversalNode node)
void	DeselectNodes (IEnumerable< TraversalNode > nodeList)
int	GetSelectedNodeCount ()
TraversalNode[]	GetSelectedNodes ()
bool	IsNodeSelected (TraversalNode node)
void	SelectNode (TraversalNode node)
void	SelectNodes (IEnumerable< TraversalNode > nodeList)
void	SetSelectedNodes (IEnumerable< TraversalNode > nodeList)
TreeListNode	FindTreeListNode (TraversalNode dataNode)
TraversalNode	FindTraversalNode (TreeListNode treeNode)
List< TreeListNode >	TranslateNodeList (IEnumerable< TraversalNode > nodeList)
List< TraversalNode >	TranslateTreeNodeList (IEnumerable treeNodeList)
void	InvalidateTraversal ()
Static Public Attributes
static readonly String	ExplorerNamePropertyName = "ExplorerName"
static readonly String	ShowHierarchyPropertyName = "ShowHierarchy"
Protected Member Functions
void	OnShowHierarchyChanged (ValueChangedEventArgs< bool > e)
override void	SelectChildrenOnSelection (object sender, EventArgs e)
	<exclude>
override void	UpdateDataSource (bool updateContent)
	<exclude>
override void	OnPaint (PaintEventArgs e)
	<exclude>
virtual void	OnListResetting ()
virtual void	OnListReset ()
virtual void	OnDropOnNode (TraversalNodeEventArgs e)
virtual void	OnDragOverNode (TraversalNodeActionQueryEventArgs e)
	<exclude>
override Hashtable	SaveNodesData ()
override void	RestoreNodesData (Hashtable nodesData)
override TreeListData	CreateData ()
Properties
BackgroundCommandRunner	BackgroundCommandRunner [get]
string	ExplorerName [get, set]
bool	ShowHierarchy [get, set]
IconPropertyReader	RowIconProperty [get, set]
DataFacade	DataFacade [get, set]
Events
EventHandler < ValueChangedEventArgs< bool > >	ShowHierarchyChanged
EventHandler	ListResetting
	<exclude>
EventHandler	ListReset
	<exclude>
EventHandler < TraversalNodeEventArgs >	DropOnNode
EventHandler < TraversalNodeActionQueryEventArgs >	DragOverNode
	<exclude>

---

Constructor & Destructor Documentation

MaxCustomControls::ExplorerTreeList::ExplorerTreeList

(

)

[inline]

---

Member Function Documentation

void MaxCustomControls::ExplorerTreeList::ClearNodeSelection

(

)

[inline]

void MaxCustomControls::ExplorerTreeList::DeselectNode

(

TraversalNode

node

)

[inline]

void MaxCustomControls::ExplorerTreeList::DeselectNodes

(

IEnumerable< TraversalNode >

nodeList

)

[inline]

int MaxCustomControls::ExplorerTreeList::GetSelectedNodeCount

(

)

[inline]

TraversalNode [] MaxCustomControls::ExplorerTreeList::GetSelectedNodes

(

)

[inline]

bool MaxCustomControls::ExplorerTreeList::IsNodeSelected

(

TraversalNode

node

)

[inline]

void MaxCustomControls::ExplorerTreeList::SelectNode

(

TraversalNode

node

)

[inline]

void MaxCustomControls::ExplorerTreeList::SelectNodes

(

IEnumerable< TraversalNode >

nodeList

)

[inline]

void MaxCustomControls::ExplorerTreeList::SetSelectedNodes

(

IEnumerable< TraversalNode >

nodeList

)

[inline]

TreeListNode MaxCustomControls::ExplorerTreeList::FindTreeListNode

(

TraversalNode

dataNode

)

[inline]

TraversalNode MaxCustomControls::ExplorerTreeList::FindTraversalNode

(

TreeListNode

treeNode

)

[inline]

List<TreeListNode> MaxCustomControls::ExplorerTreeList::TranslateNodeList

(

IEnumerable< TraversalNode >

nodeList

)

[inline]

List<TraversalNode> MaxCustomControls::ExplorerTreeList::TranslateTreeNodeList

(

IEnumerable

treeNodeList

)

[inline]

void MaxCustomControls::ExplorerTreeList::OnShowHierarchyChanged

(

ValueChangedEventArgs< bool >

e

)

[inline, protected]

override void MaxCustomControls::ExplorerTreeList::SelectChildrenOnSelection	(	object	sender,
		EventArgs	e
	)		[inline, protected, virtual]

<exclude>

The handler which listens to selection changes and extends the selection to all child nodes of that selection.

Parameters:

sender	sender of the event
e	not used

Reimplemented from MaxCustomControls::MaxTreeList.

void MaxCustomControls::ExplorerTreeList::InvalidateTraversal

(

)

[inline]

override void MaxCustomControls::ExplorerTreeList::UpdateDataSource

(

bool

updateContent

)

[inline, protected]

<exclude>

Overridden from TreeList to fire DataSourceChanged.

The base TreeList does not expose a DataSource changed event and the DataSource property itself is not virtual. This method is our first opportunity to hook into the DataSource changing pipeline to add the event.

Parameters:

updateContent

See TreeList.UpdateDataSource(bool) The parameter is passed to this base method.

Reimplemented from MaxCustomControls::MaxTreeList.

override void MaxCustomControls::ExplorerTreeList::OnPaint

(

PaintEventArgs

e

)

[inline, protected]

<exclude>

OnPaint is overridden to handle any updating deferred earlier.

When a subject signals that it is dirty, the MaxTreeList just makes a note of it, schedules a repaint, and defers updating until Max is no longer busy and control returns to the main event loop.

Parameters:

e	the event args for this paint event

Reimplemented from MaxCustomControls::MaxTreeList.

virtual void MaxCustomControls::ExplorerTreeList::OnListResetting

(

)

[inline, protected, virtual]

virtual void MaxCustomControls::ExplorerTreeList::OnListReset

(

)

[inline, protected, virtual]

virtual void MaxCustomControls::ExplorerTreeList::OnDropOnNode

(

TraversalNodeEventArgs

e

)

[inline, protected, virtual]

virtual void MaxCustomControls::ExplorerTreeList::OnDragOverNode

(

TraversalNodeActionQueryEventArgs

e

)

[inline, protected, virtual]

<exclude>

Raises the DragOverNode event.

Parameters:

e	The arguments to be passed to this event.

override Hashtable MaxCustomControls::ExplorerTreeList::SaveNodesData

(

)

[inline, protected]

override void MaxCustomControls::ExplorerTreeList::RestoreNodesData

(

Hashtable

nodesData

)

[inline, protected]

override TreeListData MaxCustomControls::ExplorerTreeList::CreateData

(

)

[inline, protected]

---

Member Data Documentation

readonly String MaxCustomControls::ExplorerTreeList::ExplorerNamePropertyName = "ExplorerName" [static]

readonly String MaxCustomControls::ExplorerTreeList::ShowHierarchyPropertyName = "ShowHierarchy" [static]

---

Property Documentation

BackgroundCommandRunner MaxCustomControls::ExplorerTreeList::BackgroundCommandRunner [get]

string MaxCustomControls::ExplorerTreeList::ExplorerName [get, set]

bool MaxCustomControls::ExplorerTreeList::ShowHierarchy [get, set]

IconPropertyReader MaxCustomControls::ExplorerTreeList::RowIconProperty [get, set]

DataFacade MaxCustomControls::ExplorerTreeList::DataFacade [get, set]

---

Event Documentation

EventHandler<ValueChangedEventArgs<bool> > MaxCustomControls::ExplorerTreeList::ShowHierarchyChanged

EventHandler MaxCustomControls::ExplorerTreeList::ListResetting

<exclude>

Fires before the node list resets itself.

EventHandler MaxCustomControls::ExplorerTreeList::ListReset

<exclude>

When all nodes of the tree list were reset, this event handler will be called.

EventHandler<TraversalNodeEventArgs> MaxCustomControls::ExplorerTreeList::DropOnNode

EventHandler<TraversalNodeActionQueryEventArgs> MaxCustomControls::ExplorerTreeList::DragOverNode

<exclude>

Called when a DragOver happens on a TreeList node.