org.olat.core.gui.control
Interface Controller

All Superinterfaces:

Disposable

All Known Subinterfaces:

Activateable, CalendarController, ChiefController, CloneableController, ContentableChiefController, ContentableController, CrumbController, MainLayout3ColumnsController, MainLayoutController, PopupBrowserWindowController, PortletToolController, ResultController, SearchController, SpringController, StepFormController, TabbableController, ToolController, VetoableCloseController, WizardCloseResourceController

All Known Implementing Classes:

AbstractCreateItemForm, AbstractPortletRunController, ActivateableTabbableDefaultController, AddAndEditBookmarkController, AddFileResourceController, AddNewQTIDocumentController, AdvancedPropertiesController, AdvancedPropertySearchForm, AdvancedSearchInputController, AfterLoginInterceptionController, AjaxAdminController, AjaxController, AllCachesController, ArchiverMainController, AssessmentController, AssessmentEditController, AssessmentForm, AssessmentMainController, AttributeEasyRowAdderController, AuthenticationController, AutoCompleterController, BandWidthAdminController, BaseChiefController, BaseFullWebappController, BaseFullWebappPopupBrowserWindow, BasicController, BCCourseNodeEditController, BCCourseNodeRunController, BCPeekviewController, BCPreviewController, BGAreaEditController, BGAreaFormController, BGContextEditController, BGContextFormController, BGContextManagementController, BGCopyWizardController, BGMainController, BGManagementController, BGMultipleCopyWizardController, BlogNodeEditController, BlogPostFormController, BookmarkForm, BookmarksPortletRunController, BreadCrumbController, BreadCrumbController, BulkAssessmentMainController, BulkAssessmentWizardController, BulkDeleteController, BusinessGroupEditController, BusinessGroupFormController, BusinessGroupMainRunController, CalEditController, CalendarColorChooserController, CalendarExportController, CalendarFileUploadController, CalendarImportByUrlController, CalendarPortletRunController, CalRunController, CampusManagementController, CatalogAjaxAddController, CatalogAjaxMoveController, CatalogController, CatalogEntryAddController, CatalogEntryMoveController, ChangeEMailController, ChangeEMailExecuteController, ChangeIMSettingsController, ChangePasswordController, ChangePrefsController, ChangeUserPasswordForm, ChatController, ChatManagerController, ChecklistDisplayController, ChecklistEditCheckpointsController, ChecklistEditController, ChecklistManageCheckpointsController, ChoiceController, ChoiceItemController, ChooseStepsController, ClipboardDemoController, ClipboardTrayController, CloneController, CloseableModalController, CloseableModalWindowController, ClusterAdminControllerCluster, ClusterAdminControllerSingleVM, CmdCreateFile, CmdCreateFolder, CmdDelete, CmdDeletedFiles, CmdEditContent, CmdEditMeta, CmdEditQuota, CmdMoveCopy, CmdUnzip, CmdUpload, CmdViewRevisions, CmdZip, COEditController, CollaborationToolsSettingsController, ConditionConfigEasyController, ConditionEditController, ConnectedClientsListController, ContactFormController, ContextHelpResultController, ContextHelpTopNavController, ContextualSubscriptionController, CopyEventToCalendarController, CopyToClipboardController, CORunController, CourseCalendarConfigController, CourseCalendarController, CourseCalendarController, CourseCalendarPeekViewController, CourseChatSettingController, CourseConfigGlossaryController, CourseEfficencyStatementController, CourseForumsArchiveController, CourseGlossaryToolLinkController, CourseGroupManagementMainController, CourseLayoutController, CourseLinkProviderController, CourseLogsArchiveController, CourseQTIArchiveController, CourseSharedFolderController, CPContentController, CPDisplayController, CPEditController, CPEditMainController, CPFileImportController, CPMDFlexiForm, CPMetadataEditController, CPPageEditController, CPRunController, CPTreeController, CreateBlogController, CreateNewCourseController, CreateNewCPController, CreateNewGlossaryController, CreateNewSharedFolderController, CreatePodcastController, CrumbBasicController, CrumbFormBasicController, CustomfieldsFormController, CustomLinkChooserController, CustomMediaChooserController, DailyStatisticDisplayController, DateChooserController, DateChooserForm, DefaultChiefController, DefaultController, DefaultFooterController, DefaultMinimalTopNavController, DefaultShibbolethAuthenticationController, DefaultSpringController, DefaultTopNavController, DeletableUserSearchController, DeletedFileListController, DemoController, DENDatesForm, DENEditController, DENEditForm, DENManageDatesController, DENManageParticipantsController, DENManageParticipantsForm, DENRunController, DevelopmentController, DialogBoxController, DialogController, DialogCourseNodeEditController, DialogCourseNodeRunController, DialogElementsController, DidYouKnowPortletRunController, DirectDeleteController, DisclaimerController, DisclaimerFormController, DisplayFeedUrlController, DisplayPortraitController, DockController, DropboxController, DropboxScoringViewController, EditorMainController, EfficiencyStatementController, EfficiencyStatementsListController, EfficiencyStatementsPortletRunController, EmailOrUsernameFormController, EmptyHeaderController, ENEditController, ENRunController, EpisodeFormController, ErrorDemoController, EssayItemController, ExceptionWindowController, ExpColController, ExternalFeedFormController, FeedbackFormController, FeedMainController, FeedNodeEditController, FeedPeekviewController, FIBItemController, FileChooseCreateEditController, FileChooserController, FileChooserController, FileLinkChooserController, FileSystemTestController, FileSystemTestForm, FileUploadController, FilterForUserController, FloatingResizableDialogController, FOCourseNodeEditController, FOCourseNodeRunController, FolderRunController, FOPeekviewController, FOPreviewController, FormBasicController, ForumController, ForumThreadViewModeController, GenericArchiveController, GenericMainController, GenericQuotaEditController, GlossaryDefinitionController, GlossaryFlexionController, GlossaryItemEditorController, GlossaryMainController, GlossaryMarkupItemController, GlossaryMorphServiceSettingsController, GlossaryRegisterSettingsController, GlossaryTermAndSynonymController, GotoDateCalendarsForm, GroupAndAreaSelectController, GroupChatManagerController, GroupChatManagerControllerCluster, GroupChatManagerControllerSingleVM, GroupController, GroupOrAreaSelectionController, GroupOverviewController, GroupsPortletRunController, GuestHomeMainController, GuiDebugDispatcherController, GuiDemoAjaxTreeController, GuiDemoBreadCrumbController, GuiDemoController, GUIDemoCSSJSController, GuiDemoDialogController, GuiDemoFileChooserController, GuiDemoFlexiForm, GuiDemoFlexiFormAdvancedController, GuiDemoFlexiFormCustomlayout, GuiDemoFlexiFormHideUnhide, GuiDemoFlexiFormMainController, GuiDemoFlexiFormSubworkflow, GuiDemoFlexiTablesController, GuiDemoFloatingPanelController, GuiDemoFormsController, GuiDemoInlineEditingBasedOnFlexiForm, GuiDemoLinksController, GUIDemoMainController, GuiDemoPanesController, GuiDemoPushPopController, GuiDemoSoaController, GuiDemoStepsRunner, GuiDemoTablesController, GuiDemoTextMarkerController, GuiDemoTooltipsController, GuiDemoWindowControlController, HelloWorldController, HelloWorldController, HomeCalendarController, HomeMainController, HomePageDisplayController, HTMLEditorController, HTMLEditorControllerWithoutFile, IdentityAssessmentEditController, IdentityAssessmentOverviewController, IFrameDisplayController, IframePortletRunController, IframeTunnelController, ImportCourseController, ImportedCalendarConfigurationController, ImportGlossaryReferencesController, ImportReferencesController, ImportSharedfolderReferencesController, InfoMessageControllerCluster, InfoMessageControllerSingleVM, InfoMsgForm, InfoMsgPortletRunController, InlineEditDetailsFormController, InlineTranslationInterceptHandlerController, InOutWizardController, InsertNodeController, InstantMessagingAdminController, InstantMessagingGroupChatController, InstantMessagingMainController, InstitutionPortletRunController, IQDisplayController, IQEditController, IQEditReplaceWizard, IQPreviewController, IQRunController, ItemController, ItemMetadataFormController, ItemNodeTabbedFormController, ItemPreviewController, ItemsController, JavaScriptTracingController, JFreeChartController, JMXInfoController, KalendarConfigurationController, KalendarEntryDetailsController, LanguageChooserController, LanguageChooserController, LayoutAdminController, LayoutController, LayoutMain3ColsBackController, LayoutMain3ColsController, LayoutMain3ColsPreviewController, LDAPAdminController, LDAPAuthenticationController, LinkChooseCreateEditController, LinkChooserController, LinksPortletRunController, LLEditController, LLEditForm, LLRunController, LoginAuthprovidersController, LogoWithLinkHeaderController, LogRealTimeViewerController, MacartneyPortletRunController, MailNotificationEditController, MainLayoutBasicController, ManageBookmarkController, ManageCalendarsController, MaterialFormController, MemberListWizardController, MessageController, MessageEditController, MessageWindowController, MetaInfoFormController, ModulesFormController, MoveCopySubtreeController, MSCourseNodeEditController, MSCourseNodeRunController, MSEditFormController, NewAreaController, NewBGController, NewsFormController, NewUsersNotificationsController, NoAccessExplanationFormController, NoAccessExplEditController, NodeConfigFormController, NodeEditController, NoteController, NoteListController, NotesPortletRunController, NotificationsEmailAdminController, NotificationsPortletRunController, NotificationSubscriptionAndNewsController, NotificationSubscriptionController, OLATAuthenticationController, OlatDmzTopNavController, OlatFooterController, OlatGuestFooterController, OlatGuestTopNavController, OlatMinimalTopNavController, OLATResourceableListeningWrapperController, OlatTopNavController, OptionsFormController, PasteFromClipboardController, PeekViewWrapperController, PersonalSettingsController, PlainTextEditorController, PodcastNodeEditController, PolicyController, PollDemoController, PortalImpl, PortletAutoSortingConfigurator, PortletContainer, PortletManualSortingConfigurator, PortletToolSortingControllerImpl, PortraitUploadController, PreferencesFormController, PreviewConfigController, PreviewRunController, PreviewSettingsForm, ProfileAndHomePageEditController, ProfileFormController, ProjectBrokerCourseEditorController, ProjectBrokerDropboxController, ProjectBrokerDropboxScoringViewController, ProjectBrokerReturnboxController, ProjectController, ProjectDetailsDisplayController, ProjectDetailsPanelController, ProjectEditDetailsFormController, ProjectEventFormController, ProjectFolderController, ProjectGroupController, ProjectListController, PublishController, PwChangeController, QTIArchiveWizardController, QTIEditorMainController, QTIResultDetailsController, QuickstartPortletRunController, QuotaController, QuotaForm, ReadyToDeleteController, ReadyToDeleteController, ReadyToDeleteController, ReferencableEntriesSearchController, RegistrationController, RepoEntryCategoriesTableController, RepositoryAddController, RepositoryCopyController, RepositoryDetailsController, RepositoryEditDescriptionController, RepositoryEditPropertiesController, RepositoryEntryDetailsFormController, RepositoryEntryImageController, RepositoryMainController, RepositoryPortletRunController, RepositorySearchController, RepositorySearchMultiSelectController, ResultsController, ResultsSearchController, ReturnboxController, RevisionListController, RunMainController, ScoreAccountingArchiveController, ScormAPIandDisplayController, ScormArchiveWizardController, ScormEditController, ScormResultArchiveController, ScormResultDetailsController, ScormRunController, SearchAdminController, SearchAdminForm, SearchAllCalendarsController, SearchInputController, SectionController, SelectionController, SelectionController, SelectionController, SendMessageForm, SessionAdminForm, SessionAdministrationController, SessionAdminOldestSessionForm, SharedFolderDisplayController, SharedFolderEditorController, ShibbolethAuthenticationController, ShibbolethRegistrationController, ShibLoginPortletRunController, ShrinkController, SimpleBaseController, SimpleMessageController, SimpleNewsController, SimplePopupWindowBaseController, SinglePageController, SolutionController, SourceViewController, SPEditController, SPPeekviewController, SPRunController, StandardResultController, StatisticDisplayController, StatisticMainController, StatisticMainDescription, StatisticsAdminController, StatusController, StatusController, StatusController, STCourseNodeDisplayConfigFormController, STCourseNodeEditController, STCourseNodeRunController, StepFormBasicController, StepsMainRunController, STPeekViewController, SysinfoController, SystemAdminMainController, SystemRegistrationAdminController, SystemRolesAndRightsController, TabbableDefaultController, TabbedPaneController, TabbedPaneController, TabbedPaneController, TableController, TACourseNodeEditController, TACourseNodeRunController, TaskController, TaskFormController, TitledWrapperController, ToggleAnonymousForm, ToggleBoxController, TransactionTestController, TranslationDevMainController, TranslationToolLauncherController, TreeController, TUEditController, TunnelController, TURunController, TUStartController, UserAdminController, UserAdminMainController, UserAuthenticationsEditorController, UserChangePasswordController, UserCommentDisplayController, UserCommentFormController, UserCommentsAndRatingsController, UserCommentsController, UserCreateController, UserImportController, UserInfoMainController, UsermanagerUserSearchController, UserPropertiesController, UserSearchController, UserSessionController, UserShortDescription, UsersToGroupWizardController, VersionAdminController, VersionCommentController, WaitingGroupController, WebDAVPasswordController, WebsiteDisplayController, WeeklyCalendarController, WeeklyStatisticDisplayController, WikiArticleSearchForm, WikiCreateController, WikiEditController, WikiMainController, WikiRunController, WizardAddOwnersController, WizardCloseCourseController, WizardController, WizardInfoController, YearNavigationController, ZsuzStep01Form, ZsuzStepUserDataForm

public interface Controller
extends Disposable

Description:

Author:

Felix Jost

Method Summary

void	addControllerListener(ControllerEventListener el) Adds a controller as listener to this controller
void	dispatchEvent(UserRequest ureq, Component source, Event event) The event method will be called when a listener is added to a source and the source fires an event
void	dispose() disposes the controller.
Component	getInitialComponent() Get the initial component from this controller.
IUserActivityLogger	getUserActivityLogger()
WindowControl	getWindowControlForDebug() used for debugging and errorlog information only!!!
boolean	isDisposed()

Method Detail

addControllerListener

void addControllerListener(ControllerEventListener el)

Adds a controller as listener to this controller

Parameters:

el - The controller that should be added as listener

getInitialComponent

Component getInitialComponent()

Get the initial component from this controller.

Returns:

Component The initial component

dispatchEvent

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

The event method will be called when a listener is added to a source and the source fires an event

Parameters:

ureq - The user request

source - The component who fired the event

event - The event

dispose

void dispose()

disposes the controller. to be called only by the same user that created the controller (or better: make sure event(...) and dispose run sequentially). the behavior must be stable even if multiple invocations occur

Specified by:

dispose in interface Disposable

isDisposed

boolean isDisposed()

Returns:

true if the controller is already disposed

getUserActivityLogger

IUserActivityLogger getUserActivityLogger()

Returns:

UserActivityLogger of this controller or null if no logger is used

getWindowControlForDebug

WindowControl getWindowControlForDebug()

used for debugging and errorlog information only!!!

Returns: