mirror of
https://github.com/eclipse-sailing-analytics/sailing-analytics.git
synced 2026-10-15 16:51:07 +00:00
Added JavaDoc to AbstractAuthenticationPlace and AuthenticationView
classes
This commit is contained in:
1 parent
2ceea7e346
commit
f76bdde3c7
2 files changed
+19
No files matched your search
+3
@@ -1,9 +1,12 @@
|
||||
package com.sap.sse.security.ui.authentication;
|
||||
|
||||
import com.google.gwt.place.shared.Place;
|
||||
import com.sap.sse.security.ui.authentication.view.AuthenticationView;
|
||||
|
||||
/**
|
||||
* Super class for {@link Place}s within the authentication management, defining a header text for each {@link Place}.
|
||||
*
|
||||
* @see AuthenticationView#setHeading(String)
|
||||
*/
|
||||
public abstract class AbstractAuthenticationPlace extends Place {
|
||||
|
||||
|
||||
+16
@@ -2,9 +2,25 @@ package com.sap.sse.security.ui.authentication.view;
|
||||
|
||||
import com.google.gwt.user.client.ui.AcceptsOneWidget;
|
||||
import com.google.gwt.user.client.ui.IsWidget;
|
||||
import com.sap.sse.security.ui.authentication.AuthenticationCallback;
|
||||
import com.sap.sse.security.ui.authentication.AuthenticationClientFactory;
|
||||
import com.sap.sse.security.ui.authentication.AuthenticationPlaceManagementController;
|
||||
import com.sap.sse.security.ui.authentication.WrappedPlaceManagementController.PlaceManagementConfiguration;
|
||||
|
||||
/**
|
||||
* Interface for views working as content display within the wrapped authentication management.
|
||||
*
|
||||
* @see AuthenticationPlaceManagementController#AuthenticationPlaceManagementController(AuthenticationClientFactory,
|
||||
* AuthenticationCallback, AuthenticationView, EventBus)
|
||||
* @see PlaceManagementConfiguration#getDisplay()
|
||||
*/
|
||||
public interface AuthenticationView extends AcceptsOneWidget, IsWidget {
|
||||
|
||||
/**
|
||||
* Set the given header text or hide header, if the no text is given.
|
||||
*
|
||||
* @param heading the header text to set, or <code>null</code> to hide the header
|
||||
*/
|
||||
void setHeading(String heading);
|
||||
|
||||
}
|
||||
Reference in new issue
Block a user