de.xima.fc.form.common.models

Interface IXItemBasic

All Known Subinterfaces:

IXItem, IXItemAppendable, IXItemWidget

All Known Implementing Classes:

XAppointment, XButtonList, XCheckbox, XContainer, XDefault, XFieldSet, XFooter, XHeader, XImage, XLine, XPage, XSelect, XSpacer, XSpan, XTextArea, XTextField, XUpload

public interface IXItemBasic

The base interface for all built-in form items and all widgets provided by plugins.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
default boolean	getAutoReRender()
ArrayList<XItemPropertyDesc>	getAvailableProperties(Locale locale)
String	getIcon()
String	getPrefix() Finds the prefix for form items of this type, such as cb for checkboxes or tf for input fields.
boolean	isSubmitsValues() Checks whether form items of this type can send values to the server when the form is submitted.
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.
default void	renderItemPreview(com.hp.gagawa.java.elements.Div container, XItemRenderData renderData, XItemRenderCtx renderCtx, IXFormRenderContext formRenderCtx) Similar to the renderItem(Div, XItemRenderData, XItemRenderCtx, IXFormRenderContext) method, but this is called when the form is viewed in the designer.
default List<IXValidationResult>	validate(IXValidationParams params) Validates the values that were submitted for this form item.
default IXValidationResult	validate(List<String[]> values, Locale locale, Map<Serializable,Serializable> frqSessionAttributes) Deprecated. Use validate(IXValidationParams).
default boolean	validateGlobal(IXGlobalValidationParams params) Validates the values that were submitted for all form items of this kind.

Method Detail

renderItem

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. You should append one or more HTML elements to the container that is passed to this method.

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:

renderItemPreview(Div, XItemRenderData, XItemRenderCtx, IXFormRenderContext)

renderItemPreview

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

Similar to the 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.

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:

renderItem(Div, XItemRenderData, XItemRenderCtx, IXFormRenderContext)

isSubmitsValues

boolean isSubmitsValues()

Checks whether form items of this type can send values to the server when the form is submitted. Form items that do not submit values are, for example, not validated and no values are ever stored in the database. Form items such as pictures or charts do no submit values, while classical form elements such as input fields and checkboxes are a prime example of form items that do submit values.

Returns:

Whether form element of this type can send values to the server when the form is submitted.

getAvailableProperties

ArrayList<XItemPropertyDesc> getAvailableProperties(Locale locale)

Parameters:

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

Returns:

A list of all properties

getIcon

String getIcon()

Returns:

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

getPrefix

String getPrefix()

Finds the prefix for form items of this type, such as cb for checkboxes or tf for input fields. This prefix is used, for example, in the designer to generate a default name for newly added form items (tf-1, cb-2).

Returns:

The prefix for form items of this type.

getAutoReRender

default boolean getAutoReRender()

Returns:

true to render the item automatically in the designer, or false otherwise. When set to false, you will need to display the item via JavaScript yourself.

validate

@Deprecated
default IXValidationResult validate(List<String[]> values,
                                                Locale locale,
                                                Map<Serializable,Serializable> frqSessionAttributes)

Deprecated. Use validate(IXValidationParams).

Validates the values that were submitted for this form item. This method is always called, even when server-side validation is not enabled (XPropertyEnum.servervalidate). In case you do not want to perform any validation when server-side validation is disabled, check whether the property XPropertyEnum.servervalidate is set.

In case validation fails, the form submission is not accepted and an appropriate error message is shown to the form user.

Parameters:

values - The values that were submitted for this form item.

locale - The current locale to be used for creating error messages.

frqSessionAttributes - All attributes from the current form request session.

Returns:

A result indicating whether the submitted values are valid.

validate

default List<IXValidationResult> validate(IXValidationParams params)

Validates the values that were submitted for this form item. This method is always called, even when server-side validation is not enabled (XPropertyEnum.servervalidate). In case you do not want to perform any validation when server-side validation is disabled, check whether the property XPropertyEnum.servervalidate is set.

In case validation fails, the form submission is not accepted and an appropriate error message is shown to the form user.

Parameters:

params - Parameters for the validation process the item can make use of, such as the submitted values.

Returns:

A list with a validation result for each value of the IXValidationParams.getValues(). Each result indicating whether the submitted values are valid.

validateGlobal

default boolean validateGlobal(IXGlobalValidationParams params)

Validates the values that were submitted for all form items of this kind. This method is always called, after other validations have been performed, even when server-side validation is not enabled (XPropertyEnum.servervalidate). In case you do not want to perform any validation when server-side validation is disabled, check whether the property XPropertyEnum.servervalidate is set.

In case validation fails, the form submission is not accepted and an appropriate error message is shown to the form user.

Parameters:

params - Parameters for the validation process the item can make use of, such as the submitted values.

Returns:

true if all items are valid, or false otherwise. To add an error message for a certain item, use IXFormRenderConfig.addValidationError(String, String) of the IXGlobalValidationParams.getFormRenderConfig().