LoginFrameworkController
Description
The login framework consists of views. A view represents a panel. Each panel that is loaded in the login framework must possess a controller and create a view. The view is assigned to the controller. See also chapter Login framework, basics.
The LoginFrameworkController class implements the controller logic to control the panels. The LoginFrameworkController class is a mediator between the different panels (parent and child) of the login framework.
The LoginFrameworkController class is also a singleton meaning that only one instance of the class exists at any time. This class is part of a simplified MVC (Model View Controller) pattern.
Each panel in the login framework receives the instance of the LoginFrameworkController class. A panel again must pass an instance to the LoginFrameworkController class by using the setLoginFrameworkChildView() method. Via the function setLoginFrameworkChildView() a panel view is assigned to a controller.
Note that you do not have to change the LoginFrameworkController class. Implement the necessary methods and call the necessary methods of the LoginFrameworkController class in the LoginFrameworkChildView class.
Read also the chapter Login framework, basics.
Methods
| Member method | Description | Type |
|---|---|---|
| displayFailedLogin() | The method displays a warning panel when the login via the login.pnl fails. | public void |
| getNextPanel() | The method returns the path of the next panel in the login framework structure. | public string |
| getState() | The method returns the current state of the login process saved in the member variable m_state. | public |
| handleSSO() | ||
| setBtnAcceptEnabled() | Sets the enabled state of the "Accept" button btn_accept of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setBtnAcceptText() | Sets the text of the button "Accept" btn_accept of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setBtnAcceptToolTip() | Sets the tooltip of the button Accept btn_accept of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setBtnAcceptVisible() | Sets the visible state of the button Accept (btn_accept) of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setBtnCancelEnabled() | Sets the enabled state of the button Cancel (btn_cancle) of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setBtnCancelText() | Sets the text of the button Cancel (btn_cancle) of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setBtnCancelToolTip() | Sets the tooltip of the button Cancel (btn_cancle) of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setBtnCancelVisible() | Sets the visible state of the button Cancel (btn_cancle) of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setCloseModules | Via this method the closeModules parameter is set. The parameter is used for the function call of the afterLogin() and can be used to close the login panel without opening another panel or by closing the module. | public void |
| setCmbBxLanguageChanged() | The method is called when the selected language in the language combo box of the wincc_oa_path/panels/vision/login.pnl. is changed. The method then changes the current language index. | public void |
| setCmbBxLanguageItems() | Sets the items of the language combo box of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setLanguage() | Sets the selected language for all objects in the views/panels of the login framework. | public void |
| setOaAuthUI() | The method saves an OaAuthUI object in the controller instance. | public void |
| setOpenMonitorConfiguration() | The method sets the member variable m_openMonitorConfiguration, which determines if the monitor settings dialog is opened before starting the UI. | public void |
| setState() | Allows setting the current state of the login process manually. | public void |
| setTxtPlatformVisible() | Sets the visible state of the text txt_platform of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setTxtVersionVisible() | Sets the visible state of the text txt_version of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setTxtWelcomeVisible() | Sets the visible state of the text txt_welcome of the wincc_oa_path/panels/vision/login.pnl. | public void |
| setUseUserLanguage() | Sets the member variable m_useUserLanguage, which determines if the UI should be started with the selected language or the language saved in the users data point _Users.Language. | public void |
| startLogin() | The method startLogin() starts the login process. | public void |
| useSystemNotification() | The method returns the information whether system use notifications are used or not. | public bool |
