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

Interface IXItemWidget

All Superinterfaces:

IXItem, IXItemBasic

public interface IXItemWidget
extends IXItem

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IXItemWidget.Resource

Method Summary

Modifier and Type	Method	Description
default String	getCssData()
default String	getCssPath()
default String	getCssResourceURL()
default String	getIcon()
default String	getJavaScriptData()
default String	getJavaScriptPath()
default String	getJavaScriptResourceURL()
default String	getLabel()	Deprecated. Use getLabel(Locale)
default String	getLabel(Locale locale)
default InputStream	getResource(String path)
default String	getResourceAsString(String path)
default 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 interface de.xima.fc.form.common.models.IXItemBasic

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

Method Detail

getLabel

@Deprecated
default String getLabel()

Deprecated.

Use getLabel(Locale)

Returns:

The label of this widget.

getLabel

default String getLabel(Locale locale)

Parameters:

locale - Locale for which to find the label.

Returns:

The localized label of this widget.

getIcon

default String getIcon()

Specified by:

getIcon in interface IXItemBasic

Returns:

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

getJavaScriptResourceURL

default String getJavaScriptResourceURL()

getCssResourceURL

default String getCssResourceURL()

getJavaScriptPath

default String getJavaScriptPath()

getCssPath

default String getCssPath()

getResource

default InputStream getResource(String path)

getResourceAsString

default String getResourceAsString(String path)

getJavaScriptData

default String getJavaScriptData()

getCssData

default String getCssData()

renderItemPreview

default 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)