org.olat.core.gui.components.form.flexible.impl.elements
Class FormCancel

java.lang.Object
  org.olat.core.gui.components.form.flexible.impl.FormItemImpl
      org.olat.core.gui.components.form.flexible.impl.elements.FormCancel

All Implemented Interfaces:

Cancel, InlineElement, FormBaseComponentIdProvider, FormItem, Disposable

public class FormCancel
extends FormItemImpl
implements Disposable, Cancel

Description:
The form cancel triggers the form cancelled event and bypasses the normal form event infrastructure by using a conventional link and an inner controller that dispatches the link event and forwards it as an inner form event.

Initial Date: 06.07.2009

Author:

gnaegi

Field Summary

Fields inherited from interface org.olat.core.gui.components.form.flexible.FormItem

ERRORC, EXAMPLEC, LABELC

Fields inherited from interface org.olat.core.gui.components.form.flexible.FormBaseComponentIdProvider

DISPPREFIX

Constructor Summary

FormCancel(java.lang.String name, FormLayoutContainer formLayoutContainer, UserRequest ureq, WindowControl wControl)

Method Summary

void	dispose() disposes the disposable
void	evalFormRequest(UserRequest ureq) gets called if the implementing component is part of a form which gets partly submitted -> extract data for you and store it temporarly for redisplay without a validation
void	reset() reset the data in the field to a initial/predefined value.
void	setCustomDisabledLinkCSS(java.lang.String customDisabledLinkCSS) Set the css that is used for the disabled link status
void	setCustomEnabledLinkCSS(java.lang.String customEnabledLinkCSS)
void	setI18nKey(java.lang.String i18n) Set the i18n key for the link text
void	validate(java.util.List validationResults) validate the data in the field, create error messages or update any component.

Methods inherited from class org.olat.core.gui.components.form.flexible.impl.FormItemImpl

addActionListener, clearError, doDispatchFormRequest, getAction, getActionListenersFor, getComponent, getEmptyDisplayText, getErrorC, getErrorText, getExampleC, getExampleText, getFormDispatchId, getLabelC, getLabelText, getName, getRootForm, getTranslator, getUserObject, hasError, hasExample, hasFocus, hasLabel, isEnabled, isInlineEditingOn, isMandatory, isVisible, setEmptyDisplayText, setEnabled, setErrorComponent, setErrorKey, setExampleKey, setFocus, setLabel, setLabelComponent, setMandatory, setRootForm, setTranslator, setUserObject, setVisible, showError, showExample, showLabel, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.olat.core.gui.components.form.flexible.FormItem

addActionListener, clearError, doDispatchFormRequest, getAction, getActionListenersFor, getComponent, getErrorC, getErrorText, getExampleC, getExampleText, getLabelC, getLabelText, getName, getRootForm, getTranslator, getUserObject, hasError, hasExample, hasFocus, hasLabel, isEnabled, isMandatory, isVisible, setEnabled, setErrorComponent, setErrorKey, setExampleKey, setFocus, setLabel, setLabelComponent, setMandatory, setRootForm, setTranslator, setUserObject, setVisible, showError, showExample, showLabel

Methods inherited from interface org.olat.core.gui.components.form.flexible.FormBaseComponentIdProvider

getFormDispatchId

Constructor Detail

FormCancel

public FormCancel(java.lang.String name,
                  FormLayoutContainer formLayoutContainer,
                  UserRequest ureq,
                  WindowControl wControl)

Method Detail

evalFormRequest

public void evalFormRequest(UserRequest ureq)

Description copied from class: FormItemImpl

gets called if the implementing component is part of a form which gets partly submitted -> extract data for you and store it temporarly for redisplay without a validation

Specified by:

evalFormRequest in interface FormItem

Specified by:

evalFormRequest in class FormItemImpl

See Also:

FormItemImpl.evalFormRequest(org.olat.core.gui.UserRequest)

reset

public void reset()

Description copied from interface: FormItem

reset the data in the field to a initial/predefined value. This method is called if in a form a reset request is issued. It is the counterpart to the validate call which

Specified by:

reset in interface FormItem

Specified by:

reset in class FormItemImpl

See Also:

FormItemImpl.reset()

validate

public void validate(java.util.List validationResults)

Description copied from interface: FormItem

validate the data in the field, create error messages or update any component.

This method must be implemented by a specialised form item provider.

Specified by:

validate in interface FormItem

Specified by:

validate in class FormItemImpl

See Also:

FormItemImpl.validate(java.util.List)

setCustomDisabledLinkCSS

public void setCustomDisabledLinkCSS(java.lang.String customDisabledLinkCSS)

Description copied from interface: Cancel

Set the css that is used for the disabled link status

Specified by:

setCustomDisabledLinkCSS in interface Cancel

See Also:

Cancel.setCustomDisabledLinkCSS(java.lang.String)

setCustomEnabledLinkCSS

public void setCustomEnabledLinkCSS(java.lang.String customEnabledLinkCSS)

Specified by:

setCustomEnabledLinkCSS in interface Cancel

Parameters:

customEnabledLinkCSS - The customEnabledLinkCSS to set.

See Also:

Cancel.setCustomEnabledLinkCSS(java.lang.String)

setI18nKey

public void setI18nKey(java.lang.String i18n)

Description copied from interface: Cancel

Set the i18n key for the link text

Specified by:

setI18nKey in interface Cancel

See Also:

Cancel.setI18nKey(java.lang.String)

dispose

public void dispose()

Description copied from interface: Disposable

disposes the disposable

Specified by:

dispose in interface Disposable

See Also:

Disposable.dispose()