Package de.xima.fc.form.common.models
Class XItemRenderData
java.lang.Object
de.xima.fc.form.common.models.AXItemPropertiesData
de.xima.fc.form.common.models.XItemRenderData
- All Implemented Interfaces:
IXItemPropertiesData
,Serializable
- Author:
- XIMA MEDIA GmbH
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
Helper class for with convenience methods to access the localized value for a given item property.class
static final class
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal XItemRenderData.I18N
Helper for accessing the localized value for a given item property, resolved according to the requested language.final XItemRenderData.Value
Fields inherited from class de.xima.fc.form.common.models.AXItemPropertiesData
className, propertyMap, version
-
Constructor Summary
ConstructorsConstructorDescriptionXItemRenderData
(String className, Map<String, XPropertyValue> propertyMap, IXFormRenderConfig xFormRenderConfig, Map<String, List<String[]>> valuesMap, boolean forceDisabled) Deprecated.XItemRenderData
(String className, Map<String, XPropertyValue> propertyMap, IXFormRenderConfig xFormRenderConfig, Map<String, List<String[]>> valuesMap, boolean forceDisabled, com.alibaba.fastjson.JSONObject version) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAriaAttributesToInput
(com.hp.gagawa.java.Node node) Deprecated.getCssHtmlAttrString
(boolean withName) Creates the class names that should be added as theclass
attribute to a form element.Creates the class names that should be added as theclass
attribute to a form element.protected String
getDatasourceField
(com.alibaba.fastjson.JSONObject options, XPropertyEnum fieldEnum, String fieldName) getOptionText
(com.alibaba.fastjson.JSONObject opt) getOptionTitle
(com.alibaba.fastjson.JSONObject opt) getOptionValue
(com.alibaba.fastjson.JSONObject opt) getValue()
boolean
boolean
boolean
isHidden()
boolean
boolean
void
setForceDisabled
(boolean forceDisabled) Deprecated.UseXItemRenderData.XItemRenderDataBuilder
to configure an instance, don't mutate existing instances.void
setValuesMap
(Map<String, List<String[]>> valuesMap) Deprecated.UseXItemRenderData.XItemRenderDataBuilder
to configure an instance, don't mutate existing instances.void
setXFormRenderConfig
(IXFormRenderConfig xFormRenderConfig) Deprecated.UseXItemRenderData.XItemRenderDataBuilder
to configure an instance, don't mutate existing instances.Methods inherited from class de.xima.fc.form.common.models.AXItemPropertiesData
contains, contains, get, get, getAlias, getAttributes, getClassName, getDatatype, getEquals, getFileextension, getHiddenif, getHiddenifclear, getHiddenifcomp, getHiddenifvalue, getId, getMaxfilesize, getMaxvalue, getMinvalue, getName, getOptions, getParentId, getPropertyMap, getReadonlyif, getReadonlyifclear, getReadonlyifcomp, getReadonlyifvalue, getRequired, getRequiredgroup, getRequiredif, getRequiredifcomp, getRequiredifvalue, getResolvedAlias, getSemver, getVersion, getVrule, isReadonlyStatusdependent, isReadonlyUsergrouppendant, isStatusdependent, isUsergrouppendent, isValidateOnServerSide, put, set, set, setClassName
-
Field Details
-
value
-
i18n
Helper for accessing the localized value for a given item property, resolved according to the requested language.
-
-
Constructor Details
-
XItemRenderData
@Deprecated public XItemRenderData(String className, Map<String, XPropertyValue> propertyMap, IXFormRenderConfig xFormRenderConfig, Map<String, List<String[]>> valuesMap, boolean forceDisabled, com.alibaba.fastjson.JSONObject version) Deprecated.Creates a new render data object that stores all the properties of an item and offers methods to access them. -
XItemRenderData
@Deprecated public XItemRenderData(String className, Map<String, XPropertyValue> propertyMap, IXFormRenderConfig xFormRenderConfig, Map<String, List<String[]>> valuesMap, boolean forceDisabled) Deprecated.Creates a new render data object that stores all the properties of an item and offers methods to access them.
-
-
Method Details
-
getXFormRenderConfig
-
setXFormRenderConfig
Deprecated.UseXItemRenderData.XItemRenderDataBuilder
to configure an instance, don't mutate existing instances.- Parameters:
xFormRenderConfig
- New form render configuration to use.
-
getValuesMap
-
setValuesMap
Deprecated.UseXItemRenderData.XItemRenderDataBuilder
to configure an instance, don't mutate existing instances.- Parameters:
valuesMap
- New values map to use.
-
isForceDisabled
public boolean isForceDisabled() -
setForceDisabled
Deprecated.UseXItemRenderData.XItemRenderDataBuilder
to configure an instance, don't mutate existing instances.- Parameters:
forceDisabled
- New value forisForceDisabled()
.
-
getProperties
-
getOptionValue
-
getOptionText
-
getOptionTitle
-
getDatasourceField
protected String getDatasourceField(com.alibaba.fastjson.JSONObject options, XPropertyEnum fieldEnum, String fieldName) -
getValue
-
getCssHtmlAttrString
Deprecated.- Returns:
- All CSS style classes for the form element.
-
getCssHtmlAttrString
Creates the class names that should be added as theclass
attribute to a form element. Includes the simpleName of rendered class (such as XTextField, XTextArea etc.)- Parameters:
ctx
- Current render context indicating whether the name of the element should be added as a CSS style class.- Returns:
- All CSS style classes for the form element.
-
getCssClassesCustom
- Returns:
- All custom CSS classes set by the user via
XPropertyEnum.cssclasses
.
-
getCssClassesItemType
- Returns:
- All CSS classes for the type of the form element, e.g.
XItem XTextField
.
-
getCssClassesLabelDirection
- Returns:
- All CSS classes for
label direction
, e.g.left-top
.
-
getCssClassesItemName
- Parameters:
ctx
- Current render context.- Returns:
- All CSS classes derived from the name of the item, if
element class name mode
is enabled.
-
getCssHtmlAttrString
Creates the class names that should be added as theclass
attribute to a form element. This is simply a combination ofgetCssClassesItemType()
,getCssClassesCustom()
,getCssClassesLabelDirection()
, andgetCssClassesItemName()
ifelement class name mode
is enabled- Parameters:
withName
- Whether the name of the element should be included as a style class.- Returns:
- All CSS style classes for the form element.
-
getStyleHtmlAttrString
- Returns:
- String of inline styles like min-height max-width and min-width if property is set
-
isReadonly
public boolean isReadonly()- Returns:
- true if property readonly equals is 2 the value 1 means disabled
-
isDisabled
public boolean isDisabled()- Returns:
true
iff: readonly equals1
ordisabled
equals1
orforceDisabled
is set totrue
- See Also:
-
isPlainDisabled
public boolean isPlainDisabled()- Returns:
true
iff: readonly equals1
ordisabled
equals1
.- See Also:
-
isHidden
public boolean isHidden()- Returns:
- true ishidden equals 1
-
addAriaAttributesToInput
public void addAriaAttributesToInput(com.hp.gagawa.java.Node node)
-
XItemRenderData.XItemRenderDataBuilder
.