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

public class XItemRenderData
extends AXItemPropertiesData

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	XItemRenderData.I18N	Helper class for with convenience methods to access the localized value for a given item property.
class	XItemRenderData.Value
static class	XItemRenderData.XItemRenderDataBuilder

Field Summary

Fields

Modifier and Type	Field	Description
XItemRenderData.I18N	i18n	Helper for accessing the localized value for a given item property, resolved according to the requested language.
XItemRenderData.Value	value

Fields inherited from class de.xima.fc.form.common.models.AXItemPropertiesData

className, propertyMap, version

Constructor Summary

Constructors

Constructor	Description
XItemRenderData(String className, Map<String,XPropertyValue> propertyMap, IXFormRenderConfig xFormRenderConfig, Map<String,List<String[]>> valuesMap, boolean forceDisabled)	Deprecated. Use XItemRenderData.XItemRenderDataBuilder.
XItemRenderData(String className, Map<String,XPropertyValue> propertyMap, IXFormRenderConfig xFormRenderConfig, Map<String,List<String[]>> valuesMap, boolean forceDisabled, com.alibaba.fastjson.JSONObject version)	Deprecated. Use XItemRenderData.XItemRenderDataBuilder.

Method Summary

Modifier and Type	Method	Description
String	getCssClassesCustom()
String	getCssClassesItemName(XItemRenderCtx ctx)
String	getCssClassesItemType()
String	getCssClassesLabelDirection()
String	getCssHtmlAttrString()	Deprecated. Use getCssHtmlAttrString(boolean) or getCssHtmlAttrString(XItemRenderCtx).
String	getCssHtmlAttrString(boolean withName)	Creates the class names that should be added as the class attribute to a form element.
String	getCssHtmlAttrString(XItemRenderCtx ctx)	Creates the class names that should be added as the class attribute to a form element.
protected String	getDatasourceField(com.alibaba.fastjson.JSONObject options, XPropertyEnum fieldEnum, String fieldName)
String	getOptionText(com.alibaba.fastjson.JSONObject opt)
String	getOptionTitle(com.alibaba.fastjson.JSONObject opt)
String	getOptionValue(com.alibaba.fastjson.JSONObject opt)
XItemRenderData	getProperties()
String	getStyleHtmlAttrString()
XItemRenderData.Value	getValue()
Map<String,List<String[]>>	getValuesMap()
IXFormRenderConfig	getXFormRenderConfig()
boolean	isDisabled()
boolean	isForceDisabled()
boolean	isHidden()
boolean	isPlainDisabled()
boolean	isReadonly()
void	setForceDisabled(boolean forceDisabled)	Deprecated. Use XItemRenderData.XItemRenderDataBuilder to configure an instance, don't mutate existing instances.
void	setValuesMap(Map<String,List<String[]>> valuesMap)	Deprecated. Use XItemRenderData.XItemRenderDataBuilder to configure an instance, don't mutate existing instances.
void	setXFormRenderConfig(IXFormRenderConfig xFormRenderConfig)	Deprecated. Use XItemRenderData.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

Methods inherited from class java.lang.Object

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

Field Detail

value

public final XItemRenderData.Value value

i18n

public final XItemRenderData.I18N i18n

Helper for accessing the localized value for a given item property, resolved according to the requested language.

Constructor Detail

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.

Use XItemRenderData.XItemRenderDataBuilder.

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.

Use XItemRenderData.XItemRenderDataBuilder.

Creates a new render data object that stores all the properties of an item and offers methods to access them.

Method Detail

getXFormRenderConfig

public IXFormRenderConfig getXFormRenderConfig()

setXFormRenderConfig

@Deprecated
public void setXFormRenderConfig(IXFormRenderConfig xFormRenderConfig)

Deprecated.

Use XItemRenderData.XItemRenderDataBuilder to configure an instance, don't mutate existing instances.

Parameters:

xFormRenderConfig - New form render configuration to use.

getValuesMap

public Map<String,List<String[]>> getValuesMap()

setValuesMap

@Deprecated
public void setValuesMap(Map<String,List<String[]>> valuesMap)

Deprecated.

Use XItemRenderData.XItemRenderDataBuilder to configure an instance, don't mutate existing instances.

Parameters:

valuesMap - New values map to use.

isForceDisabled

public boolean isForceDisabled()

setForceDisabled

@Deprecated
public void setForceDisabled(boolean forceDisabled)

Deprecated.

Use XItemRenderData.XItemRenderDataBuilder to configure an instance, don't mutate existing instances.

Parameters:

forceDisabled - New value for isForceDisabled().

getProperties

public XItemRenderData getProperties()

getOptionValue

public String getOptionValue(com.alibaba.fastjson.JSONObject opt)

getOptionText

public String getOptionText(com.alibaba.fastjson.JSONObject opt)

getOptionTitle

public String getOptionTitle(com.alibaba.fastjson.JSONObject opt)

getDatasourceField

protected String getDatasourceField(com.alibaba.fastjson.JSONObject options,
                                    XPropertyEnum fieldEnum,
                                    String fieldName)

getValue

public XItemRenderData.Value getValue()

getCssHtmlAttrString

@Deprecated
public String getCssHtmlAttrString()

Deprecated.

Use getCssHtmlAttrString(boolean) or getCssHtmlAttrString(XItemRenderCtx).

Returns:

All CSS style classes for the form element.

getCssHtmlAttrString

public String getCssHtmlAttrString(XItemRenderCtx ctx)

Creates the class names that should be added as the class 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

public String getCssClassesCustom()

Returns:

All custom CSS classes set by the user via XPropertyEnum.cssclasses.

getCssClassesItemType

public String getCssClassesItemType()

Returns:

All CSS classes for the type of the form element, e.g. XItem XTextField.

getCssClassesLabelDirection

public String getCssClassesLabelDirection()

Returns:

All CSS classes for label direction, e.g. left-top.

getCssClassesItemName

public String getCssClassesItemName(XItemRenderCtx ctx)

Parameters:

ctx - Current render context.

Returns:

All CSS classes derived from the name of the item, if element class name mode is enabled.

getCssHtmlAttrString

public String getCssHtmlAttrString(boolean withName)

Creates the class names that should be added as the class attribute to a form element. This is simply a combination of getCssClassesItemType(), getCssClassesCustom(), getCssClassesLabelDirection(), and getCssClassesItemName() if element 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

public String 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 equals 1 or disabled equals 1 or forceDisabled is set to true

See Also:

isPlainDisabled()

isPlainDisabled

public boolean isPlainDisabled()

Returns:

true iff: readonly equals 1 or disabled equals 1.

See Also:

isDisabled()

isHidden

public boolean isHidden()

Returns:

true ishidden equals 1