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

Class AbstractPlanPage

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

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

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:

PlanActivityPage, PlanOverviewPage, PlanPoliciesPage

public abstract class AbstractPlanPage
extends AbstractPage

Base class for all Plan pages.

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 String	org
protected String	plan
protected String	version

Fields inherited from class io.apiman.manager.ui.client.local.pages.AbstractPage

bus, currentContext, errorPanel, i18n, logger, navHelper, navigation, pageLoadingWidget, rest

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractPlanPage() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_appPostConstruct()
protected int	doLoadPageData() Subclasses may implement this method.
protected String	getEntityStatus()
protected String	getOrganizationId()
protected boolean	isAuthorized() This method is invoked *after* the user bean has been retrieved.
protected void	loadPlanVersion(String version) Loads a version of a plan.
void	onLock(com.google.gwt.event.dom.client.ClickEvent event) Called when the user clicks the "Lock" button.
protected void	onPageLoaded() Called once all data has been loaded and the page has been rendered.
protected void	onPlanVersionLoaded() Called when the plan version is successfully loaded.
protected void	onVersionSelected(String value) Called when the user switches versions.
protected void	renderPage() Called once all page data has been loaded and the page is ready to be rendered.
protected void	renderPlanStatus() Updates various UI bits based on the status of the plan.
protected void	updatePlanDescription(String newDescription)

Methods inherited from class io.apiman.manager.ui.client.local.pages.AbstractPage

clearCurrentUser, dataPacketError, dataPacketLoaded, doPageLoadingLifecycle, getCurrentUserBean, getCurrentUserOrgs, getPageTitle, hasPermission, hasPermission, hasStatus, hideElementsBasedOnStatus, hideUnauthorizedElements, increaseExpectedDataPackets, isAdmin, isMemberOfOrg, onPageLoading, onPageShowing, setPageTitle, showPage

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

org

@PageState
protected String org

plan

@PageState
protected String plan

version

@PageState
protected String version

Constructor Detail

AbstractPlanPage

public AbstractPlanPage()

Constructor.

Method Detail

isAuthorized

protected boolean isAuthorized()

Description copied from class: AbstractPage

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

Overrides:

isAuthorized in class AbstractPage

Returns:

true only if the user is authorized to view this page

See Also:

AbstractPage.isAuthorized()

getOrganizationId

protected String getOrganizationId()

Overrides:

getOrganizationId in class AbstractPage

Returns:

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

See Also:

AbstractPage.getOrganizationId()

getEntityStatus

protected String getEntityStatus()

Overrides:

getEntityStatus in class AbstractPage

Returns:

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

See Also:

AbstractPage.getEntityStatus()

_appPostConstruct

@PostConstruct
protected void _appPostConstruct()

updatePlanDescription

protected void updatePlanDescription(String newDescription)

Parameters:

newDescription -

doLoadPageData

protected int doLoadPageData()

Description copied from class: AbstractPage

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.

Overrides:

doLoadPageData in class AbstractPage

See Also:

AbstractPage.doLoadPageData()

loadPlanVersion

protected void loadPlanVersion(String version)

Loads a version of a plan.

Parameters:

version -

onPlanVersionLoaded

protected void onPlanVersionLoaded()

Called when the plan version is successfully loaded. This provides a way for subclasses to start their own data fetching if they require the plan version to do it.

renderPage

protected void renderPage()

Description copied from class: AbstractPage

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

Overrides:

renderPage in class AbstractPage

See Also:

AbstractPage.renderPage()

onPageLoaded

protected void onPageLoaded()

Description copied from class: AbstractPage

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

Overrides:

onPageLoaded in class AbstractPage

See Also:

AbstractPage.onPageLoaded()

renderPlanStatus

protected void renderPlanStatus()

Updates various UI bits based on the status of the plan.

onLock

@EventHandler(value="lockButton")
public void onLock(com.google.gwt.event.dom.client.ClickEvent event)

Called when the user clicks the "Lock" button.

Parameters:

event -

onVersionSelected

protected void onVersionSelected(String value)

Called when the user switches versions.

Parameters:

value -