Module omix.api

Package omix.plugin.type

Interface TypeGraphicsHandlerInterface

All Known Subinterfaces:

TypeGraphicsHandlerV2Interface

public interface TypeGraphicsHandlerInterface

This interface allows to implement painting of specific object types in accessory ObjectField and in Visualization on Demand (VoD).

Since:

1.3.11

Author:

Dr. Peter Droste, Omix Visualization

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TypeGraphicsHandlerInterface.ResizableValuePainterInterface	This interface represents paint content that can be resized in a ObjectField<>.
static interface	TypeGraphicsHandlerInterface.ValuePainterInterface	This interface must be derived in order to realize painting of custom object types.

Method Summary

Modifier and Type	Method	Description
TypeGraphicsHandlerInterface.ValuePainterInterface	getValuePainter(FieldInfo fieldInfo, GetValuePainterUtilities utilities)	Creates a value painter object used to paint an object of specific type on an ObjectField or during Visualization on Demand.

Method Details

getValuePainter

TypeGraphicsHandlerInterface.ValuePainterInterface getValuePainter(FieldInfo fieldInfo, GetValuePainterUtilities utilities)

Creates a value painter object used to paint an object of specific type on an ObjectField or during Visualization on Demand.

Parameters:

fieldInfo - containing the object to be drawn and further information about the source and properties of the value.

utilities - allowing access to several features of the Omix plugin interface.

Returns:

an instance of TypeGraphicsHandlerInterface.ValuePainterInterface if object type is supported, null otherwise.