Package com.im.ijc.core.api.views
Class DesignerHandleDescriptor
- java.lang.Object
-
- com.im.ijc.core.api.views.DesignerHandleDescriptor
-
public final class DesignerHandleDescriptor extends java.lang.Object
Describes properties common to all instances ofIJCWidget.DesignerHandle
interface such as id, settings, etc. See getters methods for details.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DesignerHandleDescriptor
derive(java.lang.Object settings)
Derives a new instance from this one with a given settings.DesignerHandleDescriptor
derive(java.util.List<? extends com.im.df.api.ddl.DFField> fields)
Derives a new instance from this one with a given fields.java.lang.String
getFactoryId()
java.util.List<? extends com.im.df.api.ddl.DFField>
getFields()
java.lang.String
getID()
java.lang.Object
getSettings()
com.im.df.api.ddl.DFView
getView()
static DesignerHandleDescriptor
of(com.chemaxon.ijc.form.api.AbstractWidget widget, java.lang.Object widgetSettings, com.im.df.api.ddl.DFView view)
Creates descriptor based on existing FormsModel widget.static DesignerHandleDescriptor
of(java.lang.String id, com.chemaxon.ijc.form.api.AbstractWidget widget, java.util.Collection<com.im.df.api.ddl.DFField> fields, java.lang.Object widgetSettings, com.im.df.api.ddl.DFView view)
Creates descriptor based on existing FormsModel widget.static DesignerHandleDescriptor
of(java.lang.String id, IJCWidgetFactory factory, com.im.df.api.ddl.DFView view)
Seeof(String, String, DFView)
for description of parameters.static DesignerHandleDescriptor
of(java.lang.String id, IJCWidgetFactory factory, com.im.df.api.ddl.DFView view, java.lang.Object settings)
Seeof(String, String, DFView, Object)
for description of parameters.static DesignerHandleDescriptor
of(java.lang.String id, IJCWidgetFactory factory, com.im.df.api.ddl.DFView view, java.lang.Object settings, java.util.List<? extends com.im.df.api.ddl.DFField> fields)
Seeof(String, String, DFView, Object, List)
for description of other parameters.static DesignerHandleDescriptor
of(java.lang.String id, java.lang.String factoryId, com.im.df.api.ddl.DFView view)
Passesnull
forsettings
parameter.static DesignerHandleDescriptor
of(java.lang.String id, java.lang.String factoryId, com.im.df.api.ddl.DFView view, java.lang.Object settings)
Uses empty list forfields
parameter.static DesignerHandleDescriptor
of(java.lang.String id, java.lang.String factoryId, com.im.df.api.ddl.DFView view, java.lang.Object settings, java.util.List<? extends com.im.df.api.ddl.DFField> fields)
Most generic creator ofDesignerHandleDescriptor
class.
-
-
-
Method Detail
-
of
public static DesignerHandleDescriptor of(java.lang.String id, IJCWidgetFactory factory, com.im.df.api.ddl.DFView view)
Seeof(String, String, DFView)
for description of parameters.
-
of
public static DesignerHandleDescriptor of(java.lang.String id, java.lang.String factoryId, com.im.df.api.ddl.DFView view)
Passesnull
forsettings
parameter.
Seeof(String, String, DFView, Object)
for description of parameters.
-
of
public static DesignerHandleDescriptor of(java.lang.String id, IJCWidgetFactory factory, com.im.df.api.ddl.DFView view, java.lang.Object settings)
Seeof(String, String, DFView, Object)
for description of parameters.
-
of
public static DesignerHandleDescriptor of(java.lang.String id, java.lang.String factoryId, com.im.df.api.ddl.DFView view, java.lang.Object settings)
Uses empty list forfields
parameter.
Seeof(String, String, DFView, Object, List)
for description of parameters.
-
of
public static DesignerHandleDescriptor of(java.lang.String id, IJCWidgetFactory factory, com.im.df.api.ddl.DFView view, java.lang.Object settings, java.util.List<? extends com.im.df.api.ddl.DFField> fields)
Seeof(String, String, DFView, Object, List)
for description of other parameters.
-
of
public static DesignerHandleDescriptor of(java.lang.String id, java.lang.String factoryId, com.im.df.api.ddl.DFView view, java.lang.Object settings, java.util.List<? extends com.im.df.api.ddl.DFField> fields)
Most generic creator ofDesignerHandleDescriptor
class.- Parameters:
id
- unique identifier of designer handle. The context of uniqueness is currently within theview
to which the designer handle belongs.factoryId
- identifier of the factory by which the designer handle was created.view
- containing view for a widgetsettings
- stored settings to be used for widget re-creation.fields
- fields to which this widget shall be bound- Returns:
- new instance of
DesignerHandleDescriptor
-
of
public static DesignerHandleDescriptor of(com.chemaxon.ijc.form.api.AbstractWidget widget, java.lang.Object widgetSettings, com.im.df.api.ddl.DFView view)
Creates descriptor based on existing FormsModel widget.- Parameters:
widget
- FormsModel widgetwidgetSettings
- instance of widget's settingsview
-DFView
- Returns:
- new instance of
DesignerHandleDescriptor
- Since:
- 18.23.0
-
of
public static DesignerHandleDescriptor of(java.lang.String id, com.chemaxon.ijc.form.api.AbstractWidget widget, java.util.Collection<com.im.df.api.ddl.DFField> fields, java.lang.Object widgetSettings, com.im.df.api.ddl.DFView view)
Creates descriptor based on existing FormsModel widget.- Parameters:
id
- unique identifier of designer handle. The context of uniqueness is currently within theview
to which the designer handle belongs.widget
- FormsModel widgetfields
- bound fieldswidgetSettings
- instance of widget's settingsview
-DFView
- Returns:
- new instance of
DesignerHandleDescriptor
- Since:
- 18.23.0
-
getID
public java.lang.String getID()
- Returns:
- see
of(String, String, DFView, Object, List)
for the description
-
getFactoryId
public java.lang.String getFactoryId()
- Returns:
- see
of(String, String, DFView, Object, List)
for the description
-
getView
public com.im.df.api.ddl.DFView getView()
- Returns:
- see
of(String, String, DFView, Object, List)
for the description
-
getFields
public java.util.List<? extends com.im.df.api.ddl.DFField> getFields()
- Returns:
- see
of(String, String, DFView, Object, List)
for the description
-
getSettings
public java.lang.Object getSettings()
- Returns:
- see
of(String, String, DFView, Object, List)
for the description
-
derive
public DesignerHandleDescriptor derive(java.lang.Object settings)
Derives a new instance from this one with a given settings.- Parameters:
settings
- settings to be used- Returns:
- see
of(String, String, DFView, Object, List)
for the description
-
derive
public DesignerHandleDescriptor derive(java.util.List<? extends com.im.df.api.ddl.DFField> fields)
Derives a new instance from this one with a given fields.- Parameters:
fields
- fields to be used- Returns:
- see
of(String, String, DFView, Object, List)
for the description
-
-