org.olat.core.gui.components.form.flexible.impl
Class FormBasicController

java.lang.Object
  org.olat.core.gui.control.DefaultController
      org.olat.core.gui.control.controller.BasicController
          org.olat.core.gui.components.form.flexible.impl.FormBasicController

All Implemented Interfaces:

Controller, ControllerEventListener, Disposable

Direct Known Subclasses:

AbstractCreateItemForm, AdvancedPropertySearchForm, AdvancedSearchInputController, AjaxAdminController, AssessmentForm, AttributeEasyRowAdderController, BGAreaFormController, BGContextFormController, BlogPostFormController, BookmarkForm, BusinessGroupFormController, ChangeUserPasswordForm, ChecklistEditCheckpointsController, ChoiceController, ConditionConfigEasyController, ContextHelpResultController, ContextHelpTopNavController, CPFileImportController, CPMDFlexiForm, CrumbFormBasicController, CustomfieldsFormController, DateChooserController, DateChooserForm, DENDatesForm, DENEditForm, DENManageParticipantsForm, DisclaimerFormController, DisplayFeedUrlController, EmailOrUsernameFormController, EpisodeFormController, ExternalFeedFormController, FeedbackFormController, FileSystemTestForm, FileUploadController, ForumThreadViewModeController, GlossaryFlexionController, GlossaryMorphServiceSettingsController, GlossaryRegisterSettingsController, GlossaryTermAndSynonymController, GotoDateCalendarsForm, GroupOrAreaSelectionController, GuiDemoFlexiForm, GuiDemoFlexiFormAdvancedController, GuiDemoFlexiFormCustomlayout, GuiDemoFlexiFormHideUnhide, GuiDemoFlexiFormSubworkflow, GuiDemoFlexiTablesController, GuiDemoInlineEditingBasedOnFlexiForm, HTMLEditorController, HTMLEditorControllerWithoutFile, InfoMsgForm, InlineEditDetailsFormController, InstantMessagingAdminController, ItemMetadataFormController, LanguageChooserController, LanguageChooserController, LayoutAdminController, LLEditForm, MaterialFormController, MessageEditController, MetaInfoFormController, ModulesFormController, MSEditFormController, NewsFormController, NoAccessExplanationFormController, NodeConfigFormController, NoteController, OptionsFormController, PortletAutoSortingConfigurator, PreferencesFormController, PreviewSettingsForm, ProfileFormController, ProjectEditDetailsFormController, ProjectEventFormController, QuotaForm, RepositoryEntryDetailsFormController, ResultsController, SearchAdminForm, SearchInputController, SendMessageForm, SessionAdminForm, SessionAdminOldestSessionForm, StandardResultController, STCourseNodeDisplayConfigFormController, StepFormBasicController, StepsMainRunController, SystemRegistrationAdminController, TaskFormController, ToggleAnonymousForm, UserCommentFormController, VersionAdminController, VersionCommentController, WebDAVPasswordController, WikiArticleSearchForm

public abstract class FormBasicController
extends BasicController

Description:
The form basic controller acts as a facade for Flexi.Form generation.

• subclass it, and generate a constructor calling super(..)
• add also initForm(this.flc, this, ureq) to your constructor as a last line
• if you want your form layout, provide the velocity page name in the super(..,name) call.
• add your desired form elements in the initForm(..) method implementaion
• add your complex business validation logic by overriding the method validateFormLogic(..)
• add your code to read form values and process them further in the formOK(..) method implementation
• in complex forms with subworkflows the formInnerEvent(..) method can be overwritten and used the same way as known from event(..).

Initial Date: 01.02.2007

Author:

patrickb

Field Summary

static int	LAYOUT_CUSTOM
static int	LAYOUT_DEFAULT
static int	LAYOUT_HORIZONTAL
static int	LAYOUT_VERTICAL

Constructor Summary

FormBasicController(UserRequest ureq, WindowControl wControl)

FormBasicController(UserRequest ureq, WindowControl wControl, java.lang.String pageName)

FormBasicController(UserRequest ureq, WindowControl wControl, java.lang.String pageName, Translator fallbackTranslator)

Method Summary

void	dispose() Adding disposing of form items that implement the disposable interface.
void	event(UserRequest ureq, Component source, Event event) abstract event method for subclasses.

Methods inherited from class org.olat.core.gui.control.DefaultController

addControllerListener, addLoggingResourceable, dispatchEvent, dispatchEvent, getControllerCount, getInitialComponent, getUserActivityLogger, getWindowControlForDebug, isDisposed, toString

Methods inherited from class java.lang.Object

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

Field Detail

LAYOUT_DEFAULT

public static final int LAYOUT_DEFAULT

See Also:

Constant Field Values

LAYOUT_HORIZONTAL

public static final int LAYOUT_HORIZONTAL

See Also:

Constant Field Values

LAYOUT_VERTICAL

public static final int LAYOUT_VERTICAL

See Also:

Constant Field Values

LAYOUT_CUSTOM

public static final int LAYOUT_CUSTOM

See Also:

Constant Field Values

Constructor Detail

FormBasicController

public FormBasicController(UserRequest ureq,
                           WindowControl wControl)

FormBasicController

public FormBasicController(UserRequest ureq,
                           WindowControl wControl,
                           java.lang.String pageName)

FormBasicController

public FormBasicController(UserRequest ureq,
                           WindowControl wControl,
                           java.lang.String pageName,
                           Translator fallbackTranslator)

Method Detail

event

public void event(UserRequest ureq,
                  Component source,
                  Event event)

Description copied from class: DefaultController

abstract event method for subclasses. the event received from the component we are listening to are always rerouted to this method here, except when the component has been disposed, in which case the events are simply ignored.

See Also:

DefaultController.event(org.olat.core.gui.UserRequest, org.olat.core.gui.components.Component, org.olat.core.gui.control.Event)

dispose

public void dispose()

Adding disposing of form items that implement the disposable interface. Some Form items might generate temporary data that needs to be cleaned up.

First, super.dispose() is called.

Specified by:

dispose in interface Controller

Specified by:

dispose in interface Disposable

Overrides:

dispose in class DefaultController

See Also:

DefaultController.dispose()