io.apiman.manager.ui.client.local.pages

Class AbstractPage

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

io.apiman.manager.ui.client.local.pages.AbstractPage

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

Direct Known Subclasses:

AbstractAdminPage, AbstractAppPage, AbstractOrgPage, AbstractPlanPage, AbstractPolicyPage, AbstractServicePage, AbstractUserPage, ConsumerOrgPage, ConsumerOrgsPage, ConsumerServicePage, ConsumerServicesPage, DashboardPage, EditGatewayPage, EditPluginPage, EditRolePage, ImportPolicyDefPage, ImportServicesPage, NewAppPage, NewAppVersionPage, NewContractPage, NewGatewayPage, NewMemberPage, NewOrgPage, NewPlanPage, NewPlanVersionPage, NewPluginPage, NewRolePage, NewServicePage, NewServiceVersionPage, OrgManageMembersPage, SettingsProfilePage

public abstract class AbstractPage
extends com.google.gwt.user.client.ui.Composite

Base class for all pages, includes/handles the header and footer.

Author:

eric.wittmann@redhat.com

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jboss.errai.bus.client.api.ClientMessageBus	bus
protected CurrentContextService	currentContext
protected PageErrorPanel	errorPanel
protected org.jboss.errai.ui.client.local.spi.TranslationService	i18n
protected LoggerService	logger
protected NavigationHelperService	navHelper
protected org.jboss.errai.ui.nav.client.local.Navigation	navigation
protected PageLoadingWidget	pageLoadingWidget
protected RestInvokerService	rest

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractPage() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	clearCurrentUser()
protected void	dataPacketError(Throwable t) Called when an error occurs trying to load page data.
protected void	dataPacketLoaded() Called when a single piece of data that the page requires is successfully loaded.
protected int	doLoadPageData() Subclasses may implement this method.
protected void	doPageLoadingLifecycle() Execute the "page loading" lifecycle.
io.apiman.manager.api.beans.idm.UserBean	getCurrentUserBean()
protected static Set<String>	getCurrentUserOrgs()
protected String	getEntityStatus()
protected String	getOrganizationId()
protected abstract String	getPageTitle()
protected boolean	hasPermission(io.apiman.manager.api.beans.idm.PermissionType permission) Returns true if the currently authenticated user has the
protected boolean	hasPermission(String permission) String variant of hasPermission.
protected boolean	hasStatus(String requiredStatus) Returns true if the current page entity has the given status.
protected void	hideElementsBasedOnStatus() Finds all elements in the UI that have status requirements and hides the ones that should not be available due to current entity status.
protected void	hideUnauthorizedElements() Finds all elements in the UI that have authorization requirements and hides the ones that the current user should not see.
protected void	increaseExpectedDataPackets(int additionalExpectedPackets) Increments the number of data packets we're expecting to receive during the data load phase of page lifecycle.
protected boolean	isAdmin()
protected boolean	isAuthorized() This method is invoked *after* the user bean has been retrieved.
protected boolean	isMemberOfOrg(String organizationId)
protected void	onPageLoaded() Called once all data has been loaded and the page has been rendered.
protected void	onPageLoading() Subclasses can implement this to do any work they need done when the page is about to be shown.
protected void	onPageShowing() Subclasses can implement onPageShowing by overriding this method.
protected void	renderPage() Called once all page data has been loaded and the page is ready to be rendered.
protected void	setPageTitle(String title) Sets the page title.
protected void	showPage() Called after all data has been loaded.

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

bus

@Inject
protected org.jboss.errai.bus.client.api.ClientMessageBus bus

pageLoadingWidget

@Inject
protected PageLoadingWidget pageLoadingWidget

navigation

@Inject
protected org.jboss.errai.ui.nav.client.local.Navigation navigation

rest

@Inject
protected RestInvokerService rest

navHelper

@Inject
protected NavigationHelperService navHelper

errorPanel

@Inject
protected PageErrorPanel errorPanel

i18n

@Inject
protected org.jboss.errai.ui.client.local.spi.TranslationService i18n

currentContext

@Inject
protected CurrentContextService currentContext

logger

@Inject
protected LoggerService logger

Constructor Detail

AbstractPage

public AbstractPage()

Constructor.

Method Detail

clearCurrentUser

protected static void clearCurrentUser()

getCurrentUserOrgs

protected static Set<String> getCurrentUserOrgs()

getPageTitle

protected abstract String getPageTitle()

Returns:

the title for this page

onPageShowing

protected void onPageShowing()

Subclasses can implement onPageShowing by overriding this method.

doPageLoadingLifecycle

protected void doPageLoadingLifecycle()

Execute the "page loading" lifecycle. The lifecycle consists of the following steps: 1) begin data loading (pages can kick off async data fetching here) 2) wait for all data to be loaded (pages must call dataLoaded() to indicate a piece of data was loaded successfully) 3) render and display page

increaseExpectedDataPackets

protected void increaseExpectedDataPackets(int additionalExpectedPackets)

Increments the number of data packets we're expecting to receive during the data load phase of page lifecycle.

Parameters:

additionalExpectedPackets -

isAuthorized

protected boolean isAuthorized()

This method is invoked *after* the user bean has been retrieved.

Returns:

true only if the user is authorized to view this page

isAdmin

protected boolean isAdmin()

Returns:

true if the current user is an admin

getOrganizationId

protected String getOrganizationId()

Returns:

the organization ID of the currently in-scope organization or null if none

getEntityStatus

protected String getEntityStatus()

Returns:

the status of whatever entity is currently being displayed or null if N/A

isMemberOfOrg

protected boolean isMemberOfOrg(String organizationId)

Parameters:

organizationId -

Returns:

true if the current user is a member of the given org

hasPermission

protected boolean hasPermission(io.apiman.manager.api.beans.idm.PermissionType permission)

Returns true if the currently authenticated user has the

Parameters:

permission -

hasPermission

protected boolean hasPermission(String permission)

String variant of hasPermission.

Parameters:

permission -

hasStatus

protected boolean hasStatus(String requiredStatus)

Returns true if the current page entity has the given status. Note that the given status might actually be a list of statuses. In that case the current entity status must be in that list.

Parameters:

requiredStatus -

doLoadPageData

protected int doLoadPageData()

Subclasses may implement this method. This method represents an opportunity for the page to load its data asynchronously. The method should return the number of data packets it expects to receive asynchronously. Only after all of the packets have been received will the page render. Subclasses should call dataPacketLoaded() each time an asynchronous data packet is returned from the server.

dataPacketLoaded

protected void dataPacketLoaded()

Called when a single piece of data that the page requires is successfully loaded. Subclasses should call this method upon return of an async data call.

dataPacketError

protected void dataPacketError(Throwable t)

Called when an error occurs trying to load page data. TODO also support a version of this with additional provided context information - sometimes we know what we were doing when a problem happened

showPage

protected void showPage()

Called after all data has been loaded.

hideUnauthorizedElements

protected void hideUnauthorizedElements()

Finds all elements in the UI that have authorization requirements and hides the ones that the current user should not see.

hideElementsBasedOnStatus

protected void hideElementsBasedOnStatus()

Finds all elements in the UI that have status requirements and hides the ones that should not be available due to current entity status.

onPageLoading

protected void onPageLoading()

Subclasses can implement this to do any work they need done when the page is about to be shown.

renderPage

protected void renderPage()

Called once all page data has been loaded and the page is ready to be rendered.

onPageLoaded

protected void onPageLoaded()

Called once all data has been loaded and the page has been rendered.

setPageTitle

protected void setPageTitle(String title)

Sets the page title.

Parameters:

title -

getCurrentUserBean

public io.apiman.manager.api.beans.idm.UserBean getCurrentUserBean()

Returns:

the currentUserBean