Package com.im.ijc.core.api.renderers

Class RenderersRegistry

java.lang.Object

com.im.ijc.core.api.renderers.RenderersRegistry

public final class RenderersRegistry
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
static void	bindRenderer(java.lang.Object renderer, com.im.df.api.ddl.DFField field)
static void	bindRenderer(java.lang.Object renderer, com.im.df.api.ddl.DFField field, com.im.df.api.ddl.DFEntity entity, com.im.df.api.dml.DFResultSet resultSet)
static void	bindRenderer(java.lang.Object renderer, com.im.df.api.ddl.DFField field, com.im.df.api.ddl.DFEntity entity, com.im.df.api.dml.DFResultSet resultSet, com.im.ijc.cf.api.CFClassifier classifier, int rowCount)	Utility method which binds, or associates, given object, which is supposed to be an IJC renderer, with some of the given parameters.
java.lang.Iterable<IJCWidgetTableCellRenderer>	findMolMatrixExtraCellRenderers(com.im.df.api.ddl.DFField field)	Returns a list of IJCWidgetTableCellRenderer instances suitable for the given field which are able to participate in rendering of cells in Molecule Matrix widget.
java.lang.Iterable<com.im.commons.Pair<java.lang.Integer,RendererFactory>>	findSuitableFactoriesAsPairs(com.im.df.api.ddl.DFField field, RendererFactory.RendererType type)	Finds suitable factories for given field and type of renderer.
java.lang.Iterable<IJCWidgetTableCellRenderer>	findTableCellRenderers(com.im.df.api.ddl.DFField field)	Returns a list of IJCWidgetTableCellRenderer instances for the given field.
java.lang.Iterable<IJCWidgetRenderer>	findWidgetRenderers(com.im.df.api.ddl.DFField field)	Returns a list of IJCWidgetRenderer instances for the given field.
java.lang.Iterable<IJCWidgetTextRenderer>	findWidgetTextRenderer(com.im.df.api.ddl.DFField field)	Returns a list of IJCWidgetTextRenderer instances for the given field.
static RenderersRegistry	getDefault()
static com.chemaxon.ijc.form.api.renderers.Renderer	getFormsModelRenderer(java.lang.Object ijcRenderer)	Gets FormsModel renderer from given ijcRenderer.
IJCWidgetTableCellRenderer	getTableCellRenderer(com.chemaxon.ijc.form.api.renderers.Renderer renderer, com.chemaxon.ijc.commons.datarequest.api.FieldReference field, com.im.df.api.ddl.DFSchema schema, com.im.ijc.cf.api.CFClassifier classifier)	Returns IJCWidgetTableCellRenderer instance for the given Forms Model renderer.
IJCWidgetRenderer	getWidgetRenderer(com.chemaxon.ijc.form.api.renderers.Renderer renderer, com.chemaxon.ijc.commons.datarequest.api.FieldReference field, com.im.df.api.ddl.DFSchema schema, com.im.ijc.cf.api.CFClassifier classifier)	Returns IJCWidgetRenderer instance for the given Forms Model renderer.
IJCWidgetTextRenderer	getWidgetTextRenderer(com.chemaxon.ijc.form.api.renderers.Renderer renderer, com.chemaxon.ijc.commons.datarequest.api.FieldReference field, com.im.df.api.ddl.DFSchema schema, com.im.ijc.cf.api.CFClassifier classifier)	Returns IJCWidgetTextRenderer instance for the given Forms Model renderer.
static void	updateUseCF(java.lang.Object renderer, int count)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefault

public static RenderersRegistry getDefault()

findTableCellRenderers

public java.lang.Iterable<IJCWidgetTableCellRenderer> findTableCellRenderers(com.im.df.api.ddl.DFField field)

Returns a list of IJCWidgetTableCellRenderer instances for the given field.

Parameters:

field - field for which to find renderer. Must not be null.

Returns:

list of list of IJCWidgetTableCellRenderer instances - always non-empty.

findMolMatrixExtraCellRenderers

public java.lang.Iterable<IJCWidgetTableCellRenderer> findMolMatrixExtraCellRenderers(com.im.df.api.ddl.DFField field)

Returns a list of IJCWidgetTableCellRenderer instances suitable for the given field which are able to participate in rendering of cells in Molecule Matrix widget.

Parameters:

field - field for which to find renderer. Must not be null.

Returns:

list of list of IJCWidgetTableCellRenderer instances - might be empty.

findWidgetRenderers

public java.lang.Iterable<IJCWidgetRenderer> findWidgetRenderers(com.im.df.api.ddl.DFField field)

Returns a list of IJCWidgetRenderer instances for the given field.

Parameters:

field - field for which to find renderer. Must not be null.

Returns:

list of list of IJCWidgetRenderer instances - always non-empty.

findWidgetTextRenderer

public java.lang.Iterable<IJCWidgetTextRenderer> findWidgetTextRenderer(com.im.df.api.ddl.DFField field)

Returns a list of IJCWidgetTextRenderer instances for the given field.

Parameters:

field - field for which to find renderer. Must not be null.

Returns:

list of list of IJCWidgetTextRenderer instances - always non-empty.

getTableCellRenderer

public IJCWidgetTableCellRenderer getTableCellRenderer(com.chemaxon.ijc.form.api.renderers.Renderer renderer,
                                                       com.chemaxon.ijc.commons.datarequest.api.FieldReference field,
                                                       com.im.df.api.ddl.DFSchema schema,
                                                       com.im.ijc.cf.api.CFClassifier classifier)

Returns IJCWidgetTableCellRenderer instance for the given Forms Model renderer. If renderer is null, then default renderer for given field type is returned.

Parameters:

renderer - FormsModel renderer

field - to get IJCWidgetTableCellRenderer from when given renderer is null

schema - DFSchema - helper for creating IJCWidgetTableCellRenderer

classifier - CFClassifier for conditional formatting

Returns:

IJCWidgetTableCellRenderer instance

Throws:

java.lang.IllegalStateException - when renderer factory was not found

Since:

19.10.0

getWidgetRenderer

public IJCWidgetRenderer getWidgetRenderer(com.chemaxon.ijc.form.api.renderers.Renderer renderer,
                                           com.chemaxon.ijc.commons.datarequest.api.FieldReference field,
                                           com.im.df.api.ddl.DFSchema schema,
                                           com.im.ijc.cf.api.CFClassifier classifier)

Returns IJCWidgetRenderer instance for the given Forms Model renderer. If renderer is null, then default renderer for given field type is returned.

Parameters:

renderer - FormsModel renderer

field - to get IJCWidgetRenderer from when given renderer is null

schema - DFSchema - helper for creating IJCWidgetRenderer

classifier - CFClassifier for conditional formatting

Returns:

IJCWidgetRenderer instance

Throws:

java.lang.IllegalStateException - when renderer factory was not found

Since:

19.10.0

getWidgetTextRenderer

public IJCWidgetTextRenderer getWidgetTextRenderer(com.chemaxon.ijc.form.api.renderers.Renderer renderer,
                                                   com.chemaxon.ijc.commons.datarequest.api.FieldReference field,
                                                   com.im.df.api.ddl.DFSchema schema,
                                                   com.im.ijc.cf.api.CFClassifier classifier)

Returns IJCWidgetTextRenderer instance for the given Forms Model renderer. If renderer is null, then default renderer for given field type is returned.

Parameters:

renderer - FormsModel renderer

field - to get IJCWidgetTextRenderer from when given renderer is null

schema - DFSchema - helper for creating IJCWidgetTextRenderer

classifier - CFClassifier for conditional formatting

Returns:

IJCWidgetTextRenderer instance

Throws:

java.lang.IllegalStateException - when renderer factory was not found

Since:

19.10.0

findSuitableFactoriesAsPairs

public java.lang.Iterable<com.im.commons.Pair<java.lang.Integer,RendererFactory>> findSuitableFactoriesAsPairs(com.im.df.api.ddl.DFField field,
                                                                                                                     RendererFactory.RendererType type)

Finds suitable factories for given field and type of renderer. It's simpler to use one of the other findXXX methods which are in this class (e.g. findTableCellRenderers(com.im.df.api.ddl.DFField), etc.).

Parameters:

field - Field to be rendered

type - Type of renderer

Returns:

List of pairs where first value represents suitability, the second is the factory. Returned list is sorted by suitability. Suitability is a number between 0 (=unsupported, exclusively) and 100 (maximum supported, inclusively). Unsupported factories are not returned. See RendererFactory constants for more info.

bindRenderer

public static void bindRenderer(java.lang.Object renderer,
                                com.im.df.api.ddl.DFField field)

bindRenderer

public static void bindRenderer(java.lang.Object renderer,
                                com.im.df.api.ddl.DFField field,
                                com.im.df.api.ddl.DFEntity entity,
                                com.im.df.api.dml.DFResultSet resultSet)

bindRenderer

public static void bindRenderer(java.lang.Object renderer,
                                com.im.df.api.ddl.DFField field,
                                com.im.df.api.ddl.DFEntity entity,
                                com.im.df.api.dml.DFResultSet resultSet,
                                com.im.ijc.cf.api.CFClassifier classifier,
                                int rowCount)

Utility method which binds, or associates, given object, which is supposed to be an IJC renderer, with some of the given parameters. To which exactly depends on the sub-interfaces the given renderer implements. See RenderersBinding and its sub-interfaces for more details.

Parameters:

renderer - the renderer to be associated

field - used when renderer implements RenderersBinding.Field

entity - used when renderer implements RenderersBinding.Entity

resultSet - used when renderer implements RenderersBinding.ResultSet

classifier - used when renderer implements RenderersBinding.Classifier

rowCount - use in the case of RenderersBinding.Classifier to check the IJC licence which restrict number of rows used together with classifier

updateUseCF

public static void updateUseCF(java.lang.Object renderer,
                               int count)

getFormsModelRenderer

public static com.chemaxon.ijc.form.api.renderers.Renderer getFormsModelRenderer(java.lang.Object ijcRenderer)
                                                                          throws java.lang.NullPointerException,
                                                                                 java.lang.IllegalArgumentException

Gets FormsModel renderer from given ijcRenderer.

Parameters:

ijcRenderer - usually IJCWidgetRenderer or IJCWidgetTextRenderer or IJCWidgetTableCellRenderer subclass.

Returns:

result of IJCWidgetRendererSettings.toFormsModel()

Throws:

java.lang.NullPointerException - when given ijcRenderer is null

java.lang.IllegalArgumentException - when given ijcRenderer is not instance of IJCWidgetRendererSettings

Since:

18.23.0

See Also:

IJCWidgetRendererSettings