webCOMAND Content Types

Overview

The following prerequisite content types are found in every webCOMAND repository.

The webCOMAND content types should not be changed under normal circumstances because they form the foundation of the webCOMAND Framework.

Component

A component represents a webCOMAND App and its parts. Apps and their parts are exposed to the framework with objects in the repository.

Implements

Nothing

Extends

Content

Fields

Title (Identifier)	Type	Properties	Description
Title	(Data Type) Text Line		ID unique for a record of a specific content type.
Summary	(Data Type) Text Line		Object ID unique for to a record across all content types.
Icon	(Data Type) Image		Universally Unique ID, which is unique for to a record across all content types and servers.
Package	(Content Type) Package	Ref	The package that contains the component software.
Class Name (ClassName)	(Data Type) Text Line		Name of the class that contains the component's launch() method, which may include a namespace / folder path to locate the class within the package.

Methods

None

App

An app represents a webCOMAND software application. More specifically, a package that contains the application and information about it.

The class referenced by the App's Package and ClassName must implement the launchable interface, or the Framework will not call the launch() method.

Implements

Nothing

Extends

Component

Fields

Title (Identifier)	Type	Properties	Description
Settings	(Content Type) Object	List	Embedded list of configuration options for the application.

Methods

None

Panel

Unlike other components, panels are not typically defined in the repository because they are a structure that only exists within the App. At least at this point, they are not modular and Apps do not look for other types of panels. In other words, panels are "hard coded" into Apps.

Implements

Nothing

Extends

Component

Fields

None

Methods

None

Content Action

Reference a content type method to expose the method in user interfaces. For example, as a button or form that can be clicked to trigger the method.

A Content Action object is a Method attribute.

Implements

Nothing

Extends

Component

Fields

Title (Identifier)	Type	Properties	Description
Method	(Content Type) Method	Ref	Reference to a method, which is embedded in a content type.

Methods

None

Content View

A user interface to view or edit a single object or collection within a Content View. The Content View defines the title bar and other components shared by most Content Views, including features to automatically and manually select an appropriate Content View for an object or collection.

This content type maps to the content_view content type class that implements the content_view_interface interface, which requires is_supported( $cpath ) and launch() methods.

Implements

Nothing

Extends

Component

Fields

None

Methods

None

Field Editor

A user interface to view or edit a single object field.

This content type maps to the field_editor content type class that implements the field_ui_interface interface, which requires is_supported( $type ) and launch() methods.

Implements

Nothing

Extends

Component

Fields

None

Methods

None

Widget

A general purpose user interface element used to register and implement webCOMAND UI components.

This content type maps to the widget content type class that implements the field_ui_interface interface, which requires the launch() method.

Implements

Nothing

Extends

Component

Fields

Title (Identifier)	Type	Properties	Description
Feature	(Content Type) UI Feature	Ref	Reference to a user interface feature that this element implements, such as "Button" or "Map". The feature determines the methods that components use to interface with the element. A Theme can be used to determine which elements to use for a given feature.

Methods

None