#include <RoutingAdapter.h>

Inherits AZ::DocumentPropertyEditor::DocumentAdapter.

Inherited by AZ::DocumentPropertyEditor::ReflectionAdapter.

Protected Member Functions
void	ClearRoutes ()

void	AddRoute (const Dom::Path &route, DocumentAdapterPtr adapter)

void	RemoveRoute (const Dom::Path &route)
	Removes a route at a given path, and all of its subpaths.

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

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)

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 & >

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())

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...

Detailed Description

RoutingAdapter manages chaining DocumentAdapters together so that their contents hierarchically merge, and their corresponding patches get applied cleanly.

Member Function Documentation

◆ AddRoute()

void AZ::DocumentPropertyEditor::RoutingAdapter::AddRoute	(	const Dom::Path &	route,
		DocumentAdapterPtr	adapter
	)

protected

Adds a route at the given path to the specified adapter. Reset and Changed signals will be bubbled up from this child adapter to this router. This implies that this adapter's contents at route match the child contents of adapter.

◆ ClearRoutes()

void AZ::DocumentPropertyEditor::RoutingAdapter::ClearRoutes ( )

protected

Clears all routes. Typically, this should be called at the start of GetContents, so that child routes can be reinitalized.

◆ SetRouter()

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

overrideprotectedvirtual

If set, forwards all routing requests from this router to another router. This allows a single, parent RoutingAdapter to handle all requests.

Reimplemented from AZ::DocumentPropertyEditor::DocumentAdapter.

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

Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/RoutingAdapter.h

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddRoute()

◆ ClearRoutes()

◆ SetRouter()