public interface IPluginFormElementCatalogue extends IFCPlugin
CONFIG_FILENAME
ATTR_NAME, COL_NAME
ATTR_DISPLAY_NAME
Modifier and Type | Method and Description |
---|---|
com.alibaba.fastjson.JSONArray |
getCatalogueData(String catalogId,
Locale locale)
This methods should return all catalog form items contained in the given catalog.
|
com.alibaba.fastjson.JSONArray |
getCatalogueList(Locale locale)
This methods should return a list of all available form catalogs.
|
String |
getCatalogueName(Locale locale) |
String |
getId() |
getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall
com.alibaba.fastjson.JSONArray getCatalogueData(String catalogId, Locale locale)
XFooter
, XHeader
, XPage
, XContainer
,
XFieldSet
, XSpan
, XTextField
, XTextArea
, XSelect
, XButtonList
,
XCheckbox
, XImage
, XLine
, XSpacer
, or XUpload
Enum.name()
XPropertyEnum.catalogue
Must contain the given catalog ID.XPropertyEnum.cataloguename
Either the catalog ID or a human readable name of the catalog.XPropertyEnum.catalogueunique
An arbitrary, unique ID for this catalog.
In addition, each form items should also have more properties dependent of the type of form item
(className
). See IXItemBasic.getAvailableProperties(Locale)
for a list of properties required for each
item type, e.g. XButtonList.getAvailableProperties(Locale)
or
XTextField.getAvailableProperties(Locale)
.
You can also see which keys are used by existing FORMCYCLE form item types by opening the designer in a browser. Open the developer tools and inspect the following JavaScript object:
window.designer.config.xitemdescTo see the values the properties of an existing form item, inspect the following JavaScript object.
window.designer.items["<item-id>"]You can find the ID of a form item by inspecting
xi
attribute of the HTML container element with the class
xm-item-div
. For example, the first input field added to a new form will have the ID xi-tf-1
.catalogId
- An catalog ID, as returned by getCatalogueList(Locale)
.locale
- The locale for which the catalog should be returned. May be used for locale-specific catalogs.com.alibaba.fastjson.JSONArray getCatalogueList(Locale locale)
JSONObject
with the following properties:
locale
- The current locale for which the list of catalogs is shown. The name of the catalog may depend on
this locale.List
of available catalogs.String getCatalogueName(Locale locale)
locale
- The current locale for which this catalog plugin is shown.String getId()
Copyright © 2020 XIMA MEDIA GmbH. All rights reserved.