C

StripeDecorator<TStripe>

Show Usages
Helps in decorating the lookup method of IStripe instances by providing access to decorators for the most common types.
Inheritance Hierarchy

Remarks

Predefined LookupDecorator<TDecoratedType, TInterface> are made available through properties like e.g. positionHandler. Note that the list of possible decorations that are available using this class is not exhaustive in any way. This is merely a way to provide access to those interfaces that are more commonly being decorated by the developer.

Typically, a configured instance of this class is available through columns and rows on the TableDecorator which is returned by decorator on an ITable.

This decorator can be used to conveniently decorate the lookup of IStripes in an ITable. It serves as a factory for predefined LookupDecorator<TDecoratedType, TInterface> instances that are specifically useful for the IStripe type.

Type Parameters

TStripe

See Also

API

TableDecorator, LookupDecorator

Members

Show:

Constructors

StripeDecorator

(interfaceType: Constructor<TStripe>, decorator: ILookupDecorator)
Initializes a new instance of the StripeDecorator<T> class.

Parameters

interfaceType: Constructor<TStripe>
decorator: ILookupDecorator
The decorator to use.

Properties

editLabelHelper

: LookupDecorator<TStripe, IEditLabelHelper>
readonly
Gets a LookupDecorator<TDecoratedType, TInterface> that decorates the IEditLabelHelper type for the TStripes this instance has been created for.
Custom IEditLabelHelper implementations can be used to change or customize interactive label editing and label creation. This interface is mainly used by the TableEditorInputMode which uses the callbacks from the implementation to determine the label to add or edit, as well as to customize the TextEditorInputMode appearance for the upcoming edit. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the ITable's lookup.
readonlyfinal

Property Value

A decorator that can be used to modify the queries for IEditLabelHelper instances on ITables.

inputRenderer

: LookupDecorator<TStripe, IStripeInputRenderer>
readonly
Gets a LookupDecorator<TDecoratedType, TInterface> that decorates the IStripeInputRenderer type for the type of items this instance has been created for.

Custom IStripeInputRenderer implementations can be used to change the way the look of an item is represented during the default interactions in a CanvasComponent. This interface is mainly used by the TableEditorInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the ITable's lookup.

Implementations of IStripeInputRenderer will be passed a StripeInputRenderTag as render tag.

readonlyfinal

Property Value

A decorator that can be used to modify the queries for IStripeInputRenderer instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

positionHandler

: LookupDecorator<TStripe, IPositionHandler>
readonly
Gets a LookupDecorator<TDecoratedType, TInterface> that decorates the IPositionHandler type for the type of items this instance has been created for.
Custom IPositionHandler implementations can be used to restrict or enhance the way the user moves elements interactively in the editor. This interface is mainly used by the ReparentStripeInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the ITable's lookup.
readonlyfinal

Property Value

A decorator that can be used to modify the queries for IPositionHandler instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

Methods

Note that the various decorators for stripes provide a more convenient way to add chain links to the lookup.
final

Parameters

link: IContextLookupChainLink
The lookup chain link to add.

getDecoratorFor

<TInterface> (interfaceType: Constructor<TInterface>): LookupDecorator<TStripe, TInterface>
Creates a LookupDecorator<TDecoratedType, TInterface> for TStripes that can be used to decorate TInterface types of the labels.
final

Parameters

interfaceType: Constructor<TInterface>
The type of the interface that should be decorated of the instances' lookup.

Return Value

LookupDecorator<TStripe, TInterface>
A new LookupDecorator<TDecoratedType, TInterface> for the specified interface.

remove

(link: IContextLookupChainLink)
Removes an IContextLookupChainLink that has been added by one of the various decorators for stripes.
final

Parameters

link: IContextLookupChainLink
The lookup chain link to remove.