Overview | Package | Class | Use | Tree | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## Package com.togethersoft.openapi.ide.inspector

This package contains several interfaces and classes that comprise an inspector.

See
Description

Class Diagram Summary
inspector |

Interface Summary
Condition | Represents calculatable condition of visibility.
IdeInspectorBuilder | Factory class used to create `IdeInspector`.
IdeInspectorManager | This manager is used to control the process of inspector creation.

Class Summary
IdeInspector | Represents abstract inspector which is used to control properties of ide components.
IdeInspectorComponent | Class `IdeInspectorComponent` represents abstract component of inspector.
IdeInspectorCompoundComponent | Class `IdeInspectorCompoundComponents` represents an inspector component that contains the other inspector components.
IdeInspectorManagerAccess | This class is intended to access the current inspector manager.
IdeInspectorProperty | Class `IdeInspectorProperty` represents a property inside an inspector component.
IdeInspectorPropertySetComponent | Represents inspector component that keeps a list of properties.
IdeInspectorSinglePropertyComponent | Represents InspectorComponent that stores a single property.
IdeMultipleInspectorProperty | Represents InspectorProperty that stores an enumeration of properties.

## Package com.togethersoft.openapi.ide.inspector Description

This package contains several interfaces and classes that comprise an inspector.

## Overview.

### Inspector model.

Inspector is an abstract model that represents properties of a certain object in a structured form. Inspector varies its contents depending on the IDE context, which contains information about a selected element in the Together's UI. Inspector consists of a number of components. Each component represents a group of properties (their names and values). Optionally each component can represent an internal inspector, which, in turn, can contain it's own components.
Classes and interfaces correspond to inspector model:

Model entity | Class/interface name
--- | ---
inspector | inspector.IdeInspector
component | inspector.IdeInspectorComponent
property | inspector.IdeInspectorProperty

### Inspector UI representation.

Model and UI presentation of the Inspector are independent. There are a number of predefined classes responsible for visualization of an inspector, it's components and properties. Classes for the inspector and it's components are called "services". Inspector and components can have any number of services. There are "setService" and "getService" methods in the inspector and componets, intended to specify and obtain services. In the current implementation, the inspector is placed in a dialog box. Inspector properties' classes are called "editors". Methods "getEditor" and "setEditor" are intended to specify or obtain editors for the inspector's properties.
Existing services:

Model entity | Class name | Description
--- | --- | ---
inspector | inspector.util.TabbedPaneInspectorUI | Represents inspector as a tabbed pane where each tab suited for certain component
component | inspector.util.table.PropertyTableComponentUI | Represents component as a table of properties

## Creating custom inspector.

A custom inspector should be implemented as a module. Read more about modules. Please note that in Together 4.0 inspector is moved from the config to the OpenAPI. See how to move inspector from the old config to the OpenAPI.

Overview | Package | Class | Use | Tree | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES