ConfigValueBrowser

Description

abstract class Tinman.Engine.Application.ConfigValueBrowser

Abstract base for classes that can browse a ConfigValue by creating an interactive IApplication for it.

Public / Methods

Browse


[OwnerReturn]
public abstract method Browse → (3)

config in : ConfigValue

[not-null]
The config value.

factory in : IGraphicsContextFactory

[not-null]
The graphics context factory that will be used to create the IGraphicsContext object that the browser application shall use. Implementing methods may modify factory settings.

validator opt : Validator = null

Optional validator object to use for validating the configured native object, before wrapping it in an application.

returns → IApplication

The browser application or null.

Creates a new instance of IApplication that browses the given config value.

ConfigException

If config in specifies malformed configuration data.

IOException

If a temporary I/O error has occurred; the same call might succeed later.

ValidatingException

If the given config value is invalid (see IValidatable.Validate).

BrowseWidget


[OwnerReturn]
public static method BrowseWidget → (2)

value in : IWidget

The value to browse.

operation opt : IOperation = null

Operation to run along with application (see IApplication.RunOperation).

returns → IApplication

The browser application or null.

Browses the given value.

CanBrowse


public abstract method CanBrowse → (2)

config in : ConfigValue

[not-null]
The config value.

factory in : IGraphicsContextFactory

[not-null]
The graphics context factory that will be used to create the IGraphicsContext object that the browser application shall use. Implementing methods must not modify factory settings.

returns → bool

true if Browse can possibly create a browser application,
false if not (i.e. Browse will always return null).

Can this ConfigValueBrowser object create a browser application for the given config value?

CanInspect


public abstract method CanInspect → (1)

config in : ConfigValue

[not-null]
The config value.

returns → bool

true if Inspect can possibly inspect the value,
false if not (i.e. Inspect will always return null).

Can this ConfigValueBrowser object inspect the given config value?

Inspect


[OwnerReturn]
public abstract method Inspect → (1)

config in : ConfigValue

[not-null]
The config value.

returns → object

The object that represents the inspection result, or null.
Depending on the type of the returned object, the following behaviour applies:

Returns an inspection object for the given config value.

ConfigException

If config in specifies malformed configuration data.

IOException

If a temporary I/O error has occurred; the same call might succeed later.

ValidatingException

If the given config value is invalid (see IValidatable.Validate).

Public / Attributes

All


public static attribute All → (get)

value : ConfigValueBrowser [ ]

[not-null]
The list of registered browser objects.

Returns all ConfigValueBrowser objects, in the order in which they have been registered.

Name


public abstract attribute Name → (get)

value : string

[not-empty]
The human-readable name.

Human-readable name of this ConfigValueBrowser instance.

Protected / Methods

Register


protected method Register → ()

Registers this ConfigValueBrowser so that it appears in All.