Class InspectorField<T, V>`Abstract` `Public Self`

The InspectorField class implements a simplified InspectorFieldBase that provides convenient APIs to quickly create a new field inspector based on an underlying UIElementBase control instance.

Type Parameters

T extends UIElementBase
The inspector control type (UIElement that will control the property)
V
The inspector field value type

Hierarchy (View Summary)

InspectorFieldBase
- InspectorField

Index

Constructors

constructor

Accessors

container decoration depth formLayoutSection isActive isDisabled isFocused isReadOnly name path property undoRedo

Constructors

constructor

new InspectorField<T extends UIElementBase, V>(
    type: Type,
    control: T,
    labeled: boolean,
    context: InspectorContext,
    title: string,
    path: string,
    propertyType: EnumValue<InspectablePropertyType>,
    depth: number,
    layout: InspectorFormLayoutSection,
    property: InspectableProperty,
): InspectorField<T, V>
Creates a new inspectable field.
Type Parameters
- T extends UIElementBase
  The inspector control type (UIElement that will control the property)
- V
  The inspector field value type
Parameters
- type: Type
  The field type
- control: T
  The control to be rendered in the field
- labeled: boolean
  If true, will display a label with the field
- context: InspectorContext
  Context shared by all inspectable fields created by the same parent.
- title: string
  Name of the property, or some other value to set as the title.
- path: string
  Full path to this property (includes name of this property and all parent properties).
- propertyType: EnumValue<InspectablePropertyType>
- depth: number
  Determines how deep within the inspector nesting hierarchy is this field. Some fields may contain other fields, in which case you should increase this value by one.
- layout: InspectorFormLayoutSection
  Parent layout that all the field elements will be added to.
- property: InspectableProperty
  Serializable property referencing the field whose contents to display.
Returns InspectorField<T, V>

Overrides InspectorFieldBase.constructor

Properties

`Protected`_active

_active: boolean

`Protected` `Readonly`_context

_context: InspectorContext

`Protected` `Readonly`_depth

_depth: number

`Protected`_disabled

_disabled: boolean

`Protected` `Readonly`_formLayoutSection

_formLayoutSection: InspectorFormLayoutSection

`Protected` `Readonly`_inspector

_inspector: InspectorFieldContainer

`Protected`_isFocused

_isFocused: boolean

`Protected`_isReadOnly

_isReadOnly: boolean

`Protected` `Readonly`_name

_name: string

`Protected` `Readonly`_path

_path: string

`Protected`_property

_property: InspectableProperty

`Protected` `Readonly`_propertyType

_propertyType: EnumValue<InspectablePropertyType>

`Protected` `Readonly`_title

_title: string

`Protected` `Readonly`_type

_type: ClassOf<V>

`Readonly`control

control: T

The control to be displayed for the field. Can be any UIElement, but a UIControl is preferred.

`Readonly`customElements

customElements: {
attribute: CustomInspectorElementAttribute;
element: UIElementBase;
}[]

All custom elements added through CustomInspectorElementAttribute on the field.

endUndo

endUndo: () => void

Finishes recording an undo command started via startUndoForPath. If any changes are detected on the field an undo command is recorded onto the undo-redo stack, otherwise nothing is done.

`Protected`onFieldChanged

onFieldChanged: (newValue: ValueTypeOf<V>) => void

Triggered when the user inputs a new value.

Type Declaration

- (newValue: ValueTypeOf<V>): void
- Parameters
  - newValue: ValueTypeOf<V>
    New value of the float field.
  Returns void

`Protected`onFieldChangedImmediate

onFieldChangedImmediate: (newValue: ValueTypeOf<V>) => void

Triggered when the user inputs a new value. Sets the property as immediately changed.

Type Declaration

- (newValue: ValueTypeOf<V>): void
- Parameters
  - newValue: ValueTypeOf<V>
    New value of the float field.
  Returns void

`Protected`onFieldEditBegan

onFieldEditBegan: () => void

Triggered when the user confirms input in the field.

`Protected`onFieldEditEnded

onFieldEditEnded: () => void

Triggered when the user confirms input in the field.

`Protected`onFieldInteractionEnded

onFieldInteractionEnded: () => void

Triggered when the user has finished interacting with the field but has not confirmed the change yet.

`Protected`onResetValue

onResetValue: () => void

Resets the field to it's default value.

startUndo

startUndo: () => void

Zero parameter wrapper for startUndoForPath

startUndoForPath

startUndoForPath: (subPath?: string) => void

Notifies the system to start recording a new undo command. Any changes to the field after this is called will be recorded in the command. User must call endUndo after field is done being changed.

Type Declaration

- (subPath?: string): void
- Parameters
  - OptionalsubPath: string
    Optional path to append to the end of the current field path.
  Returns void

state

state: EnumValue<InspectableState>

The inspectable field modification state.

Accessors

container

get container(): InspectorFieldContainer

Gets the InspectorFieldContainer that owns this field.

Returns InspectorFieldContainer

Inherited from InspectorFieldBase.container

decoration

get decoration(): InspectablePropertyDecoration

Information that can be used for customizing field rendering and behaviour.

Returns InspectablePropertyDecoration

Inherited from InspectorFieldBase.decoration

depth

get depth(): number

Gets the depth of the field.

Returns number

Inherited from InspectorFieldBase.depth

formLayoutSection

get formLayoutSection(): InspectorFormLayoutSection

Gets the layout of the field.

Returns InspectorFormLayoutSection

Inherited from InspectorFieldBase.formLayoutSection

isActive

get isActive(): boolean

Activates or deactivates the underlying UI elements.

Returns boolean

Inherited from InspectorFieldBase.isActive
set isActive(value: boolean): void
Parameters
- value: boolean
Returns void

Inherited from InspectorFieldBase.isActive

isDisabled

get isDisabled(): boolean

Disables or enables the underlying UI elements. Disabled elements cannot be interacted with and have a faded out appearance.

Returns boolean

Inherited from InspectorFieldBase.isDisabled
set isDisabled(value: boolean): void
Parameters
- value: boolean
Returns void

Inherited from InspectorFieldBase.isDisabled

isFocused

get isFocused(): boolean

Determines if the field is currently focused.

Returns boolean

Overrides InspectorFieldBase.isFocused

isReadOnly

get isReadOnly(): boolean

Disables or enables the underlying UI elements. Disabled elements cannot be interacted with and have a faded out appearance.

Returns boolean

Inherited from InspectorFieldBase.isReadOnly
set isReadOnly(value: boolean): void
Parameters
- value: boolean
Returns void

Inherited from InspectorFieldBase.isReadOnly

name

get name(): string

Name portion of the field path.

Returns string

Inherited from InspectorFieldBase.name

path

get path(): string

Returns the path to the field.

Returns string

Inherited from InspectorFieldBase.path

property

get property(): InspectableProperty

Property this field is displaying contents of.

Returns InspectableProperty

Inherited from InspectorFieldBase.property
set property(value: InspectableProperty): void
Parameters
- value: InspectableProperty
Returns void

Inherited from InspectorFieldBase.property

undoRedo

get undoRedo(): UndoRedo

Gets the UndoRedo for the field.

Returns UndoRedo

Inherited from InspectorFieldBase.undoRedo

Methods

`Protected`commitFieldValue

commitFieldValue(newValue: ValueTypeOf<V>): void
Commits the newValue to the inspectable property.
Parameters
- newValue: ValueTypeOf<V>
Returns void

destroy

destroy(): void

Virtual
Destroys all UI elements in the inspectable field.

Returns void

Overrides InspectorFieldBase.destroy

findPath

findPath(path: string): InspectorFieldBase
Searches for a child field with the specified path. The path must start with the field that this method is invoked on.
Parameters
- path: string
  Path relative to the current field. Path entries are field names separated with /. Fields within categories are placed within a special category group, surrounded by []. Examples: - myField - myObject/myField - myObject/[myCategory]/myField
Returns InspectorFieldBase
Matching field if one is found, null otherwise.

Inherited from InspectorFieldBase.findPath

findPathInternal

findPathInternal(
path: string[],
children?: InspectorFieldBase[],
): InspectorFieldBase
Virtual
Searches for a child field with the specified path. The path must start with the field that this method is invoked on.
Parameters
- path: string[]
  Path relative to the current field. This should be an array of path elements. Fields within categories are placed within a special category group, surrounded by []. Examples: - ["myField"] - ["myObject", "myField"] - ["myObject", "[myCategory]", "myField"]
- Optionalchildren: InspectorFieldBase[]
  The children of this field.
Returns InspectorFieldBase
Matching field if one is found, null otherwise.

Inherited from InspectorFieldBase.findPathInternal

focusPath

focusPath(path: string[]): boolean
Virtual
Searches and focuses a child field with the specified path. The path must start with the field that this method is invoked on.
Parameters
- path: string[]
  Path relative to the current field. This should be an array of path elements. Fields within categories are placed within a special category group, surrounded by []. Examples: - ["myField"] - ["myObject", "myField"] - ["myObject", "[myCategory]", "myField"]
Returns boolean
True if a field was focused, false otherwise.

Inherited from InspectorFieldBase.focusPath

initialize

initialize(): void

Virtual
Initializes the UI elements for the field.

Returns void

Overrides InspectorFieldBase.initialize

isEqual

isEqual(lhs: ValueTypeOf<V>, rhs: ValueTypeOf<V>): boolean
Virtual
Checks if two values of the inspected field are equal. By default, this method uses isEqual to check for equality - if implemented. Complex fields can override this method and offer an alternative comparison method.
Parameters
- lhs: ValueTypeOf<V>
  The left hand-side operand.
- rhs: ValueTypeOf<V>
  The right hand-side operand.
Returns boolean
True if the two values are equivalent.

isEqualToDefaultValue

isEqualToDefaultValue(value: ValueTypeOf<V>): boolean
Checks if the field is set to the default value.
Parameters
- value: ValueTypeOf<V>
Returns boolean
True if the field is set to the default value.

isFocusable

isFocusable(subFieldName: string): boolean
Virtual
Checks whether the field can focus the given sub field.
Parameters
- subFieldName: string
  The name of the sub field to focus. This is a path containing the field name and sub field name.
Returns boolean
True, if focusing is possible.

Inherited from InspectorFieldBase.isFocusable

notifyNeedsRefresh

notifyNeedsRefresh(): void

Virtual
Notifies the owning inspector that it needs to be refreshed on the next update loop.

Returns void

Inherited from InspectorFieldBase.notifyNeedsRefresh

`Protected`onChildFieldFocused

onChildFieldFocused(): void

Called when this field or a child of this field is focused. Use this to e.g. expand a field foldout to make the child visible.

Returns void

Inherited from InspectorFieldBase.onChildFieldFocused

refresh

refresh(flags?: EnumValue<InspectableRefreshFlag>): EnumValue<InspectableState>
Virtual
Checks if contents of the field have been modified, and updates them if needed.
Parameters
- Optionalflags: EnumValue<InspectableRefreshFlag>
  Flags that determine the refresh behavior that the field should have.
Returns EnumValue<InspectableState>
State representing was anything modified between two last calls to refresh.

Overrides InspectorFieldBase.refresh

`Abstract`refreshValue

refreshValue(
value: ValueTypeOf<V>,
flags: EnumValue<InspectableRefreshFlag>,
): any
Notifies the inspector field that it's contents have been modified.
Parameters
- value: ValueTypeOf<V>
  The updated value, to update UI controls
- flags: EnumValue<InspectableRefreshFlag>
  A set of flags that determine the field refreshing behavior.
Returns any

resetToDefaultValue

resetToDefaultValue(): void

Resets the field to it's default value.

Returns void

Note
This method is called when the user clicks the reset button.

searchFieldMatchingType

searchFieldMatchingType(
typeOrTypes: Type | Type[],
isRecursive?: boolean,
): InspectorFieldBase[]
Searches the inspector field hierarchy for fields that are an instance of at least one of the provided types.
Parameters
- typeOrTypes: Type | Type[]
  The types to search for.
- OptionalisRecursive: boolean
  Whether to recusrively search the child fields as well.
Returns InspectorFieldBase[]
A list of all fields that match one of the types.

Note
Fields that are not instantiated yet will not be found. (e.g. Children of an ObjectInspectorField where the foldout hasn't been unfolded yet)

Inherited from InspectorFieldBase.searchFieldMatchingType

setActive

setActive(active: boolean): void
Virtual
Activates or deactivates the underlying UI elements.
Parameters
- active: boolean
Returns void

Overrides InspectorFieldBase.setActive

setDisabled

setDisabled(disabled: boolean): void
Virtual
Disables or enables the underlying UI elements. Disabled elements cannot be interacted with and have a faded out appearance.
Parameters
- disabled: boolean
Returns void

Inherited from InspectorFieldBase.setDisabled

setHasFocus

setHasFocus(subFieldName?: string): void
Virtual
Moves keyboard focus to this field.
Parameters
- OptionalsubFieldName: string
  Name of the sub-field to focus on. Only relevant if the inspectable field represents multiple UI input elements.
Returns void

Overrides InspectorFieldBase.setHasFocus

setReadOnly

setReadOnly(readOnly: boolean): void
Virtual
Set the element read only.
Parameters
- readOnly: boolean
  The new read only value
Returns void

Overrides InspectorFieldBase.setReadOnly

setValueImmediate

setValueImmediate<T>(value: ValueTypeOf<T>): void
Assigns the field value to the underlying property and creates an undo operation.
Type Parameters
- T
Parameters
- value: ValueTypeOf<T>
Returns void

Inherited from InspectorFieldBase.setValueImmediate

`Protected`updateAccessoryElements

updateAccessoryElements(): void

Updates all accessory elements of this field.

Returns void

`Protected`updateAccessoryElementsForValue

updateAccessoryElementsForValue(currentValue: ValueTypeOf<V>): void
Updates all accessory elements of this field for the currentValue.
Parameters
- currentValue: ValueTypeOf<V>
Returns void

`Static`createField

createField(
    context: InspectorContext,
    title: string,
    path: string,
    layoutIndex: number,
    depth: number,
    layout: InspectorFormLayoutSection,
    property: InspectableProperty,
    parent?: InspectorFieldContainer,
    fnGetParentFieldConditionals?: () => InspectorFieldConditionalInfo[],
): InspectorFieldBase
Creates a new inspectable field, automatically detecting the most appropriate implementation for the type contained in the provided serializable property. This may be one of the built-in inspectable field implemetations (like ones for primitives like int or bool), or a user defined implementation defined with a CustomInspectorAttribute attribute.
Parameters
- context: InspectorContext
  Context shared by all inspectable fields created by the same parent.
- title: string
  Name of the property, or some other value to set as the title.
- path: string
  Full path to this property (includes name of this property and all parent properties).
- layoutIndex: number
  Index into the parent layout at which to insert the UI elements for the field .
- depth: number
  Determines how deep within the inspector nesting hierarchy is this field. Some fields may contain other fields, in which case you should increase this value by one.
- layout: InspectorFormLayoutSection
  Parent layout that all the field elements will be added to.
- property: InspectableProperty
  Serializable property referencing the array whose contents to display.
- Optionalparent: InspectorFieldContainer
- OptionalfnGetParentFieldConditionals: () => InspectorFieldConditionalInfo[]
Returns InspectorFieldBase
Inspectable field that can be used for displaying the UI for an InspectableProperty of the provided type.

Inherited from InspectorFieldBase.createField

`Static`getSubPath

getSubPath(path: string, count: number): string
Returns the top-most part of the provided field path. See findPath2 for more information about paths.
Parameters
- path: string
  Path to return the sub-path of.
- count: number
  Number of path elements to retrieve.
Returns string
First count elements of the path.

Inherited from InspectorFieldBase.getSubPath

`Static`updateState

updateState(
    state: EnumValue<InspectableState>,
): {
    newState: EnumValue<InspectableState>;
    oldState: EnumValue<InspectableState>;
}
A helper function that takes a state by reference. If the state has InspectableState.Modified set, the state is set to InspectableState.NotModified. Returns an object of the oldState (before modifying it) and the newState that should be set on the field.

This method should usually be used as such:
Parameters
- state: EnumValue<InspectableState>
  The current state of the field.
Returns { newState: EnumValue<InspectableState>; oldState: EnumValue<InspectableState> }
An object of the old state of the field and the new state that it should be set to.
Example
```
const [oldState, newState] = InspectorField.updateState(this._state);
	this._state = newState;
	return oldState;
```
Inherited from InspectorFieldBase.updateState

Class InspectorField<T, V>Abstract Public Self

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns InspectorField<T, V>

Properties

Protected_active

Protected Readonly_context

Protected Readonly_depth

Protected_disabled

Protected Readonly_formLayoutSection

Protected Readonly_inspector

Protected_isFocused

Protected_isReadOnly

Protected Readonly_name

Protected Readonly_path

Protected_property

Protected Readonly_propertyType

Protected Readonly_title

Protected Readonly_type

Readonlycontrol

ReadonlycustomElements

endUndo

ProtectedonFieldChanged

Type Declaration

Parameters

Returns void

ProtectedonFieldChangedImmediate

Type Declaration

Parameters

Returns void

ProtectedonFieldEditBegan

ProtectedonFieldEditEnded

ProtectedonFieldInteractionEnded

ProtectedonResetValue

startUndo

startUndoForPath

Type Declaration

Parameters

Returns void

state

Accessors

container

Returns InspectorFieldContainer

decoration

Returns InspectablePropertyDecoration

depth

Returns number

formLayoutSection

Returns InspectorFormLayoutSection

isActive

Returns boolean

Parameters

Returns void

isDisabled

Returns boolean

Parameters

Returns void

isFocused

Returns boolean

isReadOnly

Returns boolean

Parameters

Returns void

name

Returns string

path

Returns string

property

Returns InspectableProperty

Parameters

Returns void

Class InspectorField<T, V>`Abstract` `Public Self`

`Protected`_active

`Protected` `Readonly`_context

`Protected` `Readonly`_depth

`Protected`_disabled

`Protected` `Readonly`_formLayoutSection

`Protected` `Readonly`_inspector

`Protected`_isFocused

`Protected`_isReadOnly

`Protected` `Readonly`_name

`Protected` `Readonly`_path

`Protected`_property

`Protected` `Readonly`_propertyType

`Protected` `Readonly`_title

`Protected` `Readonly`_type

`Readonly`control

`Readonly`customElements

`Protected`onFieldChanged

`Protected`onFieldChangedImmediate

`Protected`onFieldEditBegan

`Protected`onFieldEditEnded

`Protected`onFieldInteractionEnded

`Protected`onResetValue

`Protected`commitFieldValue

`Protected`onChildFieldFocused

`Abstract`refreshValue

`Protected`updateAccessoryElements

`Protected`updateAccessoryElementsForValue

`Static`createField

`Static`getSubPath