Package de.xima.fc.form.common.models

Class XItemRenderCtx

java.lang.Object

de.xima.fc.form.common.models.XItemRenderCtx

public class XItemRenderCtx
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XItemRenderCtx.XItemRenderCtxBuilder

Constructor Summary

Constructors

Constructor	Description
XItemRenderCtx(XItemRenderData renderData, HashMap<String,com.hp.gagawa.java.FertileNode> parents, boolean designerPreview, boolean attributeW3CMode, boolean elementClassNameMode)	Deprecated. Use XItemRenderCtx.XItemRenderCtxBuilder.

Method Summary

Modifier and Type	Method	Description
void	addHtmlAttributes(com.hp.gagawa.java.Node node)
void	addValidationAttributes(com.hp.gagawa.java.Node node)	Deprecated. Validation rules are not registered with HTML attributes anymore.
String	encodeXfAction(XButtonDescriptor buttonDescriptor, XButtonActionDescriptor action, Map<Serializable,Serializable> frqSessionMap)
Map<String,? extends IFormContainerMetaData>	getDynFieldMap()
XItemConditionProcessor	getItemRenderConditionProcessor()
boolean	isAttributeW3CMode()
boolean	isDesignerPreview()
boolean	isElementClassNameMode()
boolean	isValidateSubmitAction()
void	registerParent(com.hp.gagawa.java.FertileNode node)
void	registerParent(String id, com.hp.gagawa.java.FertileNode node)
void	setAttributeW3CMode(boolean attributeW3CMode)	Deprecated. Use XItemRenderCtx.XItemRenderCtxBuilder to configure 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

Constructor Detail

XItemRenderCtx

@Deprecated
public XItemRenderCtx(XItemRenderData renderData,
                      HashMap<String,com.hp.gagawa.java.FertileNode> parents,
                      boolean designerPreview,
                      boolean attributeW3CMode,
                      boolean elementClassNameMode)

Deprecated.

Use XItemRenderCtx.XItemRenderCtxBuilder.

Parameters:

renderData - Item render data for the currently rendered item.

parents - Map between the ID of an element and its immediate parent, if any.

designerPreview - Whether the form is rendered within the form designer preview (as opposed to the live form users can fill in).

attributeW3CMode - Whether to comply with the W3C HTML spec. This is for backwards compatibility only, new elements should always be spec-compliant.

elementClassNameMode - Whether to add the name of the element as a CSS class.

Method Detail

registerParent

public void registerParent(String id,
                           com.hp.gagawa.java.FertileNode node)

registerParent

public void registerParent(com.hp.gagawa.java.FertileNode node)

addHtmlAttributes

public void addHtmlAttributes(com.hp.gagawa.java.Node node)

addValidationAttributes

@Deprecated
public void addValidationAttributes(com.hp.gagawa.java.Node node)

Deprecated.

Validation rules are not registered with HTML attributes anymore. They will be available in global JSON object XM_FORM_MODEL.validation.fields in the client.

Parameters:

node - HTML element to which to add the attributes.

isDesignerPreview

public boolean isDesignerPreview()

isValidateSubmitAction

public boolean isValidateSubmitAction()

setAttributeW3CMode

@Deprecated
public void setAttributeW3CMode(boolean attributeW3CMode)

Deprecated.

Use XItemRenderCtx.XItemRenderCtxBuilder to configure an instance, don't mutate existing instances.

Parameters:

attributeW3CMode - The new value for isAttributeW3CMode().

isAttributeW3CMode

public boolean isAttributeW3CMode()

isElementClassNameMode

public boolean isElementClassNameMode()

Returns:

true if the name of the element should be added as a CSS style class, false otherwise.

getDynFieldMap

public Map<String,? extends IFormContainerMetaData> getDynFieldMap()

Returns:

Map between the ID of a repeated element and the meta data for the element repetition.

getItemRenderConditionProcessor

public XItemConditionProcessor getItemRenderConditionProcessor()

Returns:

The processor for evaluating whether an item is available or disabled based on a state or user group.

encodeXfAction

public String encodeXfAction(XButtonDescriptor buttonDescriptor,
                             XButtonActionDescriptor action,
                             Map<Serializable,Serializable> frqSessionMap)