java.lang.Object
- de.xima.fc.form.common.models.AXItemPropertiesData

All Implemented Interfaces:

IXItemPropertiesData, Serializable

Direct Known Subclasses:

XItem, XItemRenderData
```
public class AXItemPropertiesData
extends Object
implements IXItemPropertiesData
```
Stores all the properties (XPropertyEnum) of a form item and offers methods to access these properties.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String className

protected Map<String,XPropertyValue> propertyMap

protected com.alibaba.fastjson.JSONObject version

Constructor Summary

Constructors
Constructor	Description
`AXItemPropertiesData(Map<String,XPropertyValue> propertyMap)`	Deprecated. Use `AXItemPropertiesData(Map, JSONObject)`
`AXItemPropertiesData(Map<String,XPropertyValue> propertyMap, com.alibaba.fastjson.JSONObject version)`	Deprecated. This is an internal method meant only for sub classes.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`contains(XPropertyEnum xPropertyEnum)`
`boolean`	`contains(String property)`
`XPropertyValue`	`get(XPropertyEnum xPropertyEnum)`
`XPropertyValue`	`get(String property)`
`String`	`getAlias()`
`com.alibaba.fastjson.JSONArray`	`getAttributes()`	Gets a list of custom HTML attributes that should be added to the form element.
`String`	`getClassName()`
`String`	`getDatatype()`
`String`	`getEquals()`
`String`	`getFileextension()`
`String`	`getHiddenif()`
`String`	`getHiddenifclear()`
`String`	`getHiddenifcomp()`
`String`	`getHiddenifvalue()`
`String`	`getId()`
`String`	`getMaxfilesize()`
`String`	`getMaxvalue()`
`String`	`getMinvalue()`
`String`	`getName()`
`com.alibaba.fastjson.JSONArray`	`getOptions()`
`String`	`getParentId()`
`Map<String,XPropertyValue>`	`getPropertyMap()`
`String`	`getReadonlyif()`
`String`	`getReadonlyifclear()`
`String`	`getReadonlyifcomp()`
`String`	`getReadonlyifvalue()`
`boolean`	`getRequired()`
`String`	`getRequiredgroup()`
`String`	`getRequiredif()`
`String`	`getRequiredifcomp()`
`String`	`getRequiredifvalue()`
`String`	`getResolvedAlias()`
`com.vdurmont.semver4j.Semver`	`getSemver()`
`com.alibaba.fastjson.JSONObject`	`getVersion()`
`String`	`getVrule()`
`boolean`	`isReadonlyStatusdependent()`
`boolean`	`isReadonlyUsergrouppendant()`
`boolean`	`isStatusdependent()`
`boolean`	`isUsergrouppendent()`
`boolean`	`isValidateOnServerSide()`
`void`	`put(String property, XPropertyValue xProperty)`	Sets the given property to the given value.
`void`	`set(XPropertyEnum xPropertyEnum, Object value)`	sets a property by XPropertyEnum
`void`	`set(String xPropertyName, Object value)`	sets a property by name
`void`	`setClassName(String className)`	Deprecated. Set the class name when creating an instance, don't mutate existing instances.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.xima.fc.form.common.models.IXItemPropertiesData
getAttributesEntries, getAttributeValue, hasAttribute, isOfType, isRepeated, isUploadMultiple, removeAttribute, setAttributeValue

- Field Detail
  - className
```
protected String className
```
  - propertyMap
```
protected Map<String,XPropertyValue> propertyMap
```
  - version
```
protected com.alibaba.fastjson.JSONObject version
```
- Constructor Detail
  - AXItemPropertiesData
```
@Deprecated
public AXItemPropertiesData(Map<String,XPropertyValue> propertyMap,
                            com.alibaba.fastjson.JSONObject version)
```
    Deprecated.
    This is an internal method meant only for sub classes. This will be changed to protected.
    
    Creates a new item properties wrapper for the given property map.
    
    Parameters:
    
    propertyMap - map of properties
    
    version - Version data of the form to which this item belongs.
  - AXItemPropertiesData
```
@Deprecated
public AXItemPropertiesData(Map<String,XPropertyValue> propertyMap)
```
    Deprecated.
    Use AXItemPropertiesData(Map, JSONObject)
    
    Creates a new item properties wrapper for the given property map.
    
    Parameters:
    
    propertyMap - Map of properties
- Method Detail
  - getPropertyMap
```
public Map<String,XPropertyValue> getPropertyMap()
```
    Specified by:
    
    getPropertyMap in interface IXItemPropertiesData
  - getClassName
```
public String getClassName()
```
    Specified by:
    
    getClassName in interface IXItemPropertiesData
    
    Returns:
    
    the className of an item XTextField, XPage etc.
  - setClassName
```
@Deprecated
public void setClassName(String className)
```
    Deprecated.
    Set the class name when creating an instance, don't mutate existing instances.
    
    Parameters:
    
    className - of the renderer to be for an item XTextField, XPage etc.
  - put
```
public void put(String property,
                XPropertyValue xProperty)
```
    Description copied from interface: IXItemPropertiesData
    
    Sets the given property to the given value. If the property does not exist, it is created. If the value is null, the property is removed.
    
    Specified by:
    
    put in interface IXItemPropertiesData
    
    Parameters:
    
    property - The name of the property to set.
    
    xProperty - The new value of the property. Null will remove the property.
  - get
```
public XPropertyValue get(XPropertyEnum xPropertyEnum)
```
    Specified by:
    
    get in interface IXItemPropertiesData
    
    Parameters:
    
    xPropertyEnum - - get a property by XPropertyEnum
    
    Returns:
    
    - a new XProperty if not exist
  - get
```
public XPropertyValue get(String property)
```
    Specified by:
    
    get in interface IXItemPropertiesData
    
    Parameters:
    
    property - - get a property by name
    
    Returns:
    
    - a new XProperty if not exist
  - set
```
public void set(XPropertyEnum xPropertyEnum,
                Object value)
```
    sets a property by XPropertyEnum
    
    Parameters:
    
    xPropertyEnum - the enum of the property
    
    value - the value of the property
  - set
```
public void set(String xPropertyName,
                Object value)
```
    sets a property by name
    
    Parameters:
    
    xPropertyName - the name of the property
    
    value - the value of the property
  - getVersion
```
public com.alibaba.fastjson.JSONObject getVersion()
```
    Returns:
    
    The version object of the form to which this item belongs.
  - getSemver
```
public com.vdurmont.semver4j.Semver getSemver()
```
    Returns:
    
    The parsed sem-version of the form to which this item belongs. May not exist for old forms, in which case 0.0.0 is returned.
  - contains
```
public boolean contains(String property)
```
    Specified by:
    
    contains in interface IXItemPropertiesData
    
    Parameters:
    
    property - the name of the property
    
    Returns:
    
    true if property exist
  - contains
```
public boolean contains(XPropertyEnum xPropertyEnum)
```
    Specified by:
    
    contains in interface IXItemPropertiesData
    
    Parameters:
    
    xPropertyEnum - the enum of the property
    
    Returns:
    
    true if property exist
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface IXItemPropertiesData
    
    Returns:
    
    the string value for the property id
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface IXItemPropertiesData
    
    Returns:
    
    The name of this item.
  - getAlias
```
public String getAlias()
```
    Specified by:
    
    getAlias in interface IXItemPropertiesData
    
    Returns:
    
    The alias of this item.
  - getResolvedAlias
```
public String getResolvedAlias()
```
    Specified by:
    
    getResolvedAlias in interface IXItemPropertiesData
    
    Returns:
    
    The effective alias of this item, either the alias when not empty, or the name otherwise.
  - getAttributes
```
public com.alibaba.fastjson.JSONArray getAttributes()
```
    Description copied from interface: IXItemPropertiesData
    
    Gets a list of custom HTML attributes that should be added to the form element. See XPropertyEnum.attributes.
    
    Specified by:
    
    getAttributes in interface IXItemPropertiesData
    
    Returns:
    
    A list of custom HTML attributes.
  - getParentId
```
public String getParentId()
```
    Specified by:
    
    getParentId in interface IXItemPropertiesData
    
    Returns:
    
    id of parent element
  - getOptions
```
public com.alibaba.fastjson.JSONArray getOptions()
```
    Specified by:
    
    getOptions in interface IXItemPropertiesData
    
    Returns:
    
    JSONArray of property Option
  - getRequiredgroup
```
public String getRequiredgroup()
```
    Specified by:
    
    getRequiredgroup in interface IXItemPropertiesData
  - getDatatype
```
public String getDatatype()
```
    Specified by:
    
    getDatatype in interface IXItemPropertiesData
  - getMinvalue
```
public String getMinvalue()
```
    Specified by:
    
    getMinvalue in interface IXItemPropertiesData
  - getMaxvalue
```
public String getMaxvalue()
```
    Specified by:
    
    getMaxvalue in interface IXItemPropertiesData
  - getVrule
```
public String getVrule()
```
    Specified by:
    
    getVrule in interface IXItemPropertiesData
  - getMaxfilesize
```
public String getMaxfilesize()
```
    Specified by:
    
    getMaxfilesize in interface IXItemPropertiesData
  - getFileextension
```
public String getFileextension()
```
    Specified by:
    
    getFileextension in interface IXItemPropertiesData
  - getEquals
```
public String getEquals()
```
    Specified by:
    
    getEquals in interface IXItemPropertiesData
  - getRequiredif
```
public String getRequiredif()
```
    Specified by:
    
    getRequiredif in interface IXItemPropertiesData
  - getReadonlyif
```
public String getReadonlyif()
```
    Specified by:
    
    getReadonlyif in interface IXItemPropertiesData
  - getHiddenif
```
public String getHiddenif()
```
    Specified by:
    
    getHiddenif in interface IXItemPropertiesData
  - getRequiredifcomp
```
public String getRequiredifcomp()
```
    Specified by:
    
    getRequiredifcomp in interface IXItemPropertiesData
  - getRequiredifvalue
```
public String getRequiredifvalue()
```
    Specified by:
    
    getRequiredifvalue in interface IXItemPropertiesData
  - getReadonlyifcomp
```
public String getReadonlyifcomp()
```
    Specified by:
    
    getReadonlyifcomp in interface IXItemPropertiesData
  - getReadonlyifvalue
```
public String getReadonlyifvalue()
```
    Specified by:
    
    getReadonlyifvalue in interface IXItemPropertiesData
  - getHiddenifcomp
```
public String getHiddenifcomp()
```
    Specified by:
    
    getHiddenifcomp in interface IXItemPropertiesData
  - getHiddenifclear
```
public String getHiddenifclear()
```
    Specified by:
    
    getHiddenifclear in interface IXItemPropertiesData
  - getReadonlyifclear
```
public String getReadonlyifclear()
```
    Specified by:
    
    getReadonlyifclear in interface IXItemPropertiesData
  - getHiddenifvalue
```
public String getHiddenifvalue()
```
    Specified by:
    
    getHiddenifvalue in interface IXItemPropertiesData
  - getRequired
```
public boolean getRequired()
```
    Specified by:
    
    getRequired in interface IXItemPropertiesData
    
    Returns:
    
    true required equals 1
  - isValidateOnServerSide
```
public boolean isValidateOnServerSide()
```
    Specified by:
    
    isValidateOnServerSide in interface IXItemPropertiesData
    
    Returns:
    
    true if XPropertyEnum.servervalidate is set to 1.
  - isStatusdependent
```
public boolean isStatusdependent()
```
    Specified by:
    
    isStatusdependent in interface IXItemPropertiesData
    
    Returns:
    
    the statusdependent
  - isUsergrouppendent
```
public boolean isUsergrouppendent()
```
    Specified by:
    
    isUsergrouppendent in interface IXItemPropertiesData
    
    Returns:
    
    the usergrouppendent
  - isReadonlyStatusdependent
```
public boolean isReadonlyStatusdependent()
```
    Specified by:
    
    isReadonlyStatusdependent in interface IXItemPropertiesData
    
    Returns:
    
    the readonly statusdependent
  - isReadonlyUsergrouppendant
```
public boolean isReadonlyUsergrouppendant()
```
    Specified by:
    
    isReadonlyUsergrouppendant in interface IXItemPropertiesData
    
    Returns:
    
    the readonly usergrouppendant

Modifier and Type	Field	Description
`protected String`	`className`
`protected Map<String,XPropertyValue>`	`propertyMap`
`protected com.alibaba.fastjson.JSONObject`	`version`

Class AXItemPropertiesData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.xima.fc.form.common.models.IXItemPropertiesData

Field Detail

className

propertyMap

version

Constructor Detail

AXItemPropertiesData

AXItemPropertiesData

Method Detail

getPropertyMap

getClassName

setClassName

put

get

get

set

set

getVersion

getSemver

contains

contains

getId

getName

getAlias

getResolvedAlias

getAttributes

getParentId

getOptions

getRequiredgroup

getDatatype

getMinvalue

getMaxvalue

getVrule

getMaxfilesize

getFileextension

getEquals

getRequiredif

getReadonlyif

getHiddenif

getRequiredifcomp

getRequiredifvalue

getReadonlyifcomp

getReadonlyifvalue

getHiddenifcomp

getHiddenifclear

getReadonlyifclear

getHiddenifvalue

getRequired

isValidateOnServerSide

isStatusdependent

isUsergrouppendent

isReadonlyStatusdependent

isReadonlyUsergrouppendant