Package de.xima.fc.form.common.items

Class XContainerInvisible

java.lang.Object

de.xima.fc.form.common.items.XContainer

de.xima.fc.form.common.items.XContainerInvisible

All Implemented Interfaces:

IXItem, IXItemAppendable, IXItemBasic

public class XContainerInvisible
extends XContainer
implements IXItemAppendable

Constructor Summary

Constructors

Constructor	Description
XContainerInvisible()

Method Summary

Modifier and Type	Method	Description
ArrayList<XItemPropertyDesc>	getAvailableProperties(Locale locale)
String	getIcon()
void	renderItem(com.hp.gagawa.java.elements.Div container, XItemRenderData renderData, XItemRenderCtx renderCtx, IXFormRenderContext formRenderCtx)	Creates the HTML for this form item that is included in the final rendered form.
void	renderItemPreview(com.hp.gagawa.java.elements.Div container, XItemRenderData renderData, XItemRenderCtx renderCtx, IXFormRenderContext formRenderCtx)	Similar to the IXItemBasic.renderItem(Div, XItemRenderData, XItemRenderCtx, IXFormRenderContext) method, but this is called when the form is viewed in the designer.

Methods inherited from class de.xima.fc.form.common.items.XContainer

getPrefix, isSubmitsValues

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.IXItemBasic

getAutoReRender, getPrefix, isShouldRenderUnit, isSubmitsValues, processUpload, validate, validate, validateGlobal

Constructor Detail

XContainerInvisible

public XContainerInvisible()

Method Detail

getAvailableProperties

public ArrayList<XItemPropertyDesc> getAvailableProperties(Locale locale)

Specified by:

getAvailableProperties in interface IXItemBasic

Overrides:

getAvailableProperties in class XContainer

Parameters:

locale - The current locale that can be used for locale dependent properties.

Returns:

A list of all properties

getIcon

public String getIcon()

Specified by:

getIcon in interface IXItemBasic

Overrides:

getIcon in class XContainer

Returns:

The CSS class for the icon of this form item, such as for example ico-fc-XCheckbox.

renderItem

public void renderItem(com.hp.gagawa.java.elements.Div container,
                       XItemRenderData renderData,
                       XItemRenderCtx renderCtx,
                       IXFormRenderContext formRenderCtx)

Description copied from interface: IXItemBasic

Creates the HTML for this form item that is included in the final rendered form. You should append one or more HTML elements to the container that is passed to this method.

Specified by:

renderItem in interface IXItemBasic

Overrides:

renderItem in class XContainer

Parameters:

container - The container that will contain this form item in the final form. You should append children to this container.

renderData - The current render data with the properties and options of the item.

renderCtx - The current render context giving you access to the global configuration.

formRenderCtx - The form render context giving you access to the global form configuration.

See Also:

IXItemBasic.renderItemPreview(Div, XItemRenderData, XItemRenderCtx, IXFormRenderContext)

renderItemPreview

public void renderItemPreview(com.hp.gagawa.java.elements.Div container,
                              XItemRenderData renderData,
                              XItemRenderCtx renderCtx,
                              IXFormRenderContext formRenderCtx)

Description copied from interface: IXItemBasic

Similar to the IXItemBasic.renderItem(Div, XItemRenderData, XItemRenderCtx, IXFormRenderContext) method, but this is called when the form is viewed in the designer. You can, if necessary, render the form slightly differently in the desigern. This is useful, for example, when when you do not want users to be able to interact with the form element directly in the designer preview area.

Specified by:

renderItemPreview in interface IXItemBasic

Parameters:

container - The container that will contain this form item in the final form. You should append children to this container.

renderData - The current render data with the properties and options of the item.

renderCtx - The current render context giving you access to the global configuration.

formRenderCtx - The form render context giving you access to the global form configuration.

See Also:

IXItemBasic.renderItem(Div, XItemRenderData, XItemRenderCtx, IXFormRenderContext)