Inherits AZ::DocumentPropertyEditor::MetaAdapter.

Inherited by AZ::DocumentPropertyEditor::ValueStringSort.

Classes
struct	SortInfoBase

struct	SortInfoNode

Public Member Functions
void	SetSortActive (bool active)

void	InvalidateSort ()

Dom::Path	MapFromSourcePath (const Dom::Path &sourcePath) const override

Dom::Path	MapToSourcePath (const Dom::Path &filterPath) const override

Dom::Path	MapPath (const Dom::Path &sourcePath, bool mapFromSource) const

Public Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
void	SetSourceAdapter (DocumentAdapterPtr sourceAdapter)

virtual Dom::Path	MapFromSourcePath (const Dom::Path &sourcePath) const =0

virtual Dom::Path	MapToSourcePath (const Dom::Path &filterPath) const =0

ExpanderSettings *	CreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string()) override

Public Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
	AZ_RTTI (DocumentAdapter, "{8CEFE485-45C2-4ECC-B9D1-BBE75C7B02AB}")

Dom::Value	GetContents () const

void	ConnectResetHandler (ResetEvent::Handler &handler)

void	ConnectChangedHandler (ChangedEvent::Handler &handler)

void	ConnectMessageHandler (MessageEvent::Handler &handler)

virtual void	SetRouter (RoutingAdapter *router, const Dom::Path &route)

Dom::Value	SendAdapterMessage (const AdapterMessage &message)

bool	IsEmpty ()

virtual ExpanderSettings *	CreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string())

Protected Member Functions
Dom::Value	GenerateContents () override

virtual SortInfoNode *	NewSortInfoNode () const =0

virtual void	CacheDomInfoForNode (const Dom::Value &domValue, SortInfoNode *sortNode) const =0

virtual bool	LessThan (SortInfoNode lhs, SortInfoNode rhs) const

void	HandleReset () override

void	HandleDomChange (const Dom::Patch &patch) override

SortInfoNode *	GetNodeAtSourcePath (Dom::Path sourcePath)

void	GenerateFullTree ()

void	PopulateChildren (const Dom::Value &value, SortInfoNode *sortInfo)

Dom::Value	GetSortedValue (const Dom::Value &sourceValue, SortInfoNode *sortInfo)

void	ResortRow (Dom::Path sourcePath, Dom::Patch &outgoingPatch)
	re-sorts the row at the given path relative to its siblings and adds a patch operation if its place changed

void	GenerateMovePatches (const SortInfoNode *sortNode, Dom::Path parentPath, bool mapToSource, Dom::Patch &outgoingPatch)

Protected Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
void	HandleDomMessage (const AZ::DocumentPropertyEditor::AdapterMessage &message, Dom::Value &value)

virtual void	HandleReset ()=0

virtual void	HandleDomChange (const Dom::Patch &patch)=0

bool	IsRow (const Dom::Path &sourcePath) const

Dom::Path	GetRowPath (const Dom::Path &sourcePath) const
	returns the first path in the ancestry of sourcePath that is of type Row, including self

Protected Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
virtual Dom::Value	GenerateContents ()=0

virtual Dom::Value	HandleMessage (const AdapterMessage &message)

void	NotifyResetDocument (DocumentResetType resetType=DocumentResetType::SoftReset)

void	NotifyContentsChanged (const Dom::Patch &patch)

Protected Attributes
AZStd::unique_ptr< SortInfoNode >	m_rootNode

bool	m_sortActive = true

Protected Attributes inherited from AZ::DocumentPropertyEditor::MetaAdapter
DocumentAdapter::ResetEvent::Handler	m_resetHandler

ChangedEvent::Handler	m_changedHandler

MessageEvent::Handler	m_domMessageHandler

DocumentAdapterPtr	m_sourceAdapter

Additional Inherited Members
Public Types inherited from AZ::DocumentPropertyEditor::DocumentAdapter
using	ResetEvent = Event<>

using	ChangedEvent = Event< const Dom::Patch & >

using	MessageEvent = Event< const AdapterMessage &, Dom::Value & >

Static Public Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
static bool	IsDebugModeEnabled ()

static void	SetDebugModeEnabled (bool enableDebugMode)

static bool	IsRow (const Dom::Value &domValue)
	convenience method to determine whether a particular Dom Value is a row

Protected Types inherited from AZ::DocumentPropertyEditor::DocumentAdapter
enum class	DocumentResetType { SoftReset , HardReset }
	Specifies the type of reset operation triggered in NotifyResetDocument. More...

Static Protected Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
static bool	IsRow (const Dom::Value &domValue)
	convenience method to determine whether a particular Dom Value is a row

Member Function Documentation

◆ GenerateContents()

Dom::Value AZ::DocumentPropertyEditor::RowSortAdapter::GenerateContents ( )

overrideprotectedvirtual

Generates the contents of this adapter. This must be an Adapter DOM node. These contents will be cached - to notify clients of changes to the structure, NotifyResetDocument or NotifyContentsChanged must be used.

See also: AdapterBuilder for building out this DOM structure.

Implements AZ::DocumentPropertyEditor::DocumentAdapter.

◆ HandleDomChange()

void AZ::DocumentPropertyEditor::RowSortAdapter::HandleDomChange ( const Dom::Patch & patch )

overrideprotectedvirtual

Implements AZ::DocumentPropertyEditor::MetaAdapter.

◆ HandleReset()

void AZ::DocumentPropertyEditor::RowSortAdapter::HandleReset ( )

overrideprotectedvirtual

Implements AZ::DocumentPropertyEditor::MetaAdapter.

◆ LessThan()

virtual bool AZ::DocumentPropertyEditor::RowSortAdapter::LessThan	(	SortInfoNode *	lhs,
		SortInfoNode *	rhs
	)		const

protectedvirtual

virtual method that determines the ordering of the nodes within the adapter NB! The implementation relies on there never being a tie, i.e. don't allow this: !(a < b) && !(b < a) The best way to avoid this is to call this base implementation (which maintains the original sorting of the source adapter) for otherwise equal values

Reimplemented in AZ::DocumentPropertyEditor::ValueStringSort.

◆ MapFromSourcePath()

Dom::Path AZ::DocumentPropertyEditor::RowSortAdapter::MapFromSourcePath ( const Dom::Path & sourcePath ) const

overridevirtual

Implements AZ::DocumentPropertyEditor::MetaAdapter.

◆ MapToSourcePath()

Dom::Path AZ::DocumentPropertyEditor::RowSortAdapter::MapToSourcePath ( const Dom::Path & filterPath ) const

overridevirtual

Implements AZ::DocumentPropertyEditor::MetaAdapter.

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

Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/SortAdapter.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GenerateContents()

◆ HandleDomChange()

◆ HandleReset()

◆ LessThan()

◆ MapFromSourcePath()

◆ MapToSourcePath()