org.jboss.as.console.client.shared.viewframework

Class AbstractEntityView<T>

java.lang.Object

com.gwtplatform.mvp.client.ViewImpl

org.jboss.as.console.client.core.SuspendableViewImpl

org.jboss.as.console.client.shared.viewframework.AbstractEntityView<T>

All Implemented Interfaces:

com.google.gwt.user.client.ui.IsWidget, com.gwtplatform.mvp.client.View, SuspendableView, FormItemObserver, FrameworkPresenter, FrameworkView

Direct Known Subclasses:

AbstractCacheView, AbstractLoggingSubview, AbstractSingleEntityView, AbstractThreadPoolView, BeanPoolsView, CacheContainerView, EJB3View, JacOrbView, ScannerView, SecurityDomainsView, SecuritySubsystemView, ThreadFactoryView

public abstract class AbstractEntityView<T>
extends SuspendableViewImpl
implements FrameworkView, FrameworkPresenter, FormItemObserver

An abstract view class with a full EntityEditor. This class assembles the editor and reacts to FrameworkView callbacks.

Author:

Stan Silvert, Heiko Braun

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.console.client.shared.viewframework.FormItemObserver

FormItemObserver.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected AddressBinding	address
protected Class<?>	beanType
protected EntityDetails<T>	entityDetails
protected EntityEditor<T>	entityEditor
protected FormMetaData	formMetaData
protected EnumSet<FrameworkButton>	hideButtons

Fields inherited from class org.jboss.as.console.client.core.SuspendableViewImpl

widgetInstance

Constructor Summary

Constructors

Constructor and Description
AbstractEntityView(Class<?> beanType, ApplicationMetaData propertyMetaData)
AbstractEntityView(Class<?> beanType, ApplicationMetaData propertyMetaData, EnumSet<FrameworkButton> hideButtons)

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.user.client.ui.Widget	createEmbeddableWidget() Creates a default widgets without the top most tab.
protected org.jboss.ballroom.client.widgets.tools.ToolStrip	createToolStrip()
protected org.jboss.ballroom.client.widgets.tools.ToolStrip	createToolStrip(String resourceAddress)
com.google.gwt.user.client.ui.Widget	createWidget() This is the default view assembly routine.
protected AddressBinding	getAddress() Get the DMR address for this entity.
abstract EntityToDmrBridge<T>	getEntityBridge() Get the EntityToDmrBridge for the Entity.
protected abstract String	getEntityDisplayName() Get the plural name of the Entity to be displayed.
protected FormMetaData	getFormMetaData() Get the FormMetaData for the Entity.
void	initialLoad() Call for Entities to be loaded into the view for the first time.
void	initialLoad(ModelNode baseAddress)
void	itemAction(FormItemObserver.Action action, ObservableFormItem item)
protected abstract org.jboss.ballroom.client.widgets.forms.FormAdapter<T>	makeAddEntityForm() Create the form with fields used for creating a new Entity.
protected EntityPopupWindow<T>	makeAddEntityPopup()
protected org.jboss.ballroom.client.widgets.forms.FormAdapter<T>	makeEditEntityDetailsForm()
protected org.jboss.ballroom.client.widgets.forms.FormAdapter<T>	makeEditEntityDetailsForm(String resourceAddress) Creates an details for for the Entity.
protected EntityEditor<T>	makeEntityEditor() Create the EntityEditor with the following pieces: - A title obtained from getPluralEntityName() - A table obtained from makeEntityTable() - An AddEntityWindow with a form from makeAddEntityForm() - An EntityDetails with a form from makeEditEntityDetailsForm()
protected abstract org.jboss.ballroom.client.widgets.tables.DefaultCellTable<T>	makeEntityTable() Create the table with the desired columns for the Entity.
protected DataProviderFilter.Predicate<T>	makeFilterPredicate()
protected org.jboss.ballroom.client.widgets.forms.FormAdapter<T>	makeSimpleForm()
protected org.jboss.ballroom.client.widgets.forms.FormAdapter<T>	makeSimpleForm(String resourceAddress)
protected List<SingleEntityView<T>>	provideAdditionalTabs(Class<?> beanType, FormMetaData formMetaData, FrameworkPresenter presenter) In case a tabbed form layout is used, implementations can provide additional custom tabs by overriding this method.
void	refresh() Called whenever there is a change to any Entity
void	setDescription(String description)
void	setEditingEnabled(boolean isEnabled) Called when the user requests details to be edited.

Methods inherited from class org.jboss.as.console.client.core.SuspendableViewImpl

asWidget, onResume

Methods inherited from class com.gwtplatform.mvp.client.ViewImpl

addToSlot, initWidget, removeFromSlot, setInSlot

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.console.client.shared.viewframework.FrameworkView

asWidget

Methods inherited from interface com.gwtplatform.mvp.client.View

addToSlot, removeFromSlot, setInSlot

Field Detail

beanType

protected Class<?> beanType

hideButtons

protected EnumSet<FrameworkButton> hideButtons

formMetaData

protected FormMetaData formMetaData

address

protected AddressBinding address

entityEditor

protected EntityEditor<T> entityEditor

entityDetails

protected EntityDetails<T> entityDetails

Constructor Detail

AbstractEntityView

public AbstractEntityView(Class<?> beanType,
                  ApplicationMetaData propertyMetaData)

AbstractEntityView

public AbstractEntityView(Class<?> beanType,
                  ApplicationMetaData propertyMetaData,
                  EnumSet<FrameworkButton> hideButtons)

Method Detail

setDescription

public void setDescription(String description)

getFormMetaData

protected FormMetaData getFormMetaData()

Get the FormMetaData for the Entity.

Returns:

The FormMetaData.

getAddress

protected AddressBinding getAddress()

Get the DMR address for this entity.

Returns:

The address.

getEntityBridge

public abstract EntityToDmrBridge<T> getEntityBridge()

Get the EntityToDmrBridge for the Entity.

Specified by:

getEntityBridge in interface FrameworkPresenter

Returns:

The bridge.

makeEntityTable

protected abstract org.jboss.ballroom.client.widgets.tables.DefaultCellTable<T> makeEntityTable()

Create the table with the desired columns for the Entity.

Returns:

The table.

makeAddEntityForm

protected abstract org.jboss.ballroom.client.widgets.forms.FormAdapter<T> makeAddEntityForm()

Create the form with fields used for creating a new Entity.

Returns:

The Console.CONSTANTS.common_label_add() form.

getEntityDisplayName

protected abstract String getEntityDisplayName()

Get the plural name of the Entity to be displayed.

Returns:

The Entity name.

createWidget

public com.google.gwt.user.client.ui.Widget createWidget()

This is the default view assembly routine. It simly creates a single top level tab and adds the editors contents to it.

Feel free to override this method in order to create more sophisticated view compositions.

Specified by:

createWidget in interface SuspendableView

Returns:

createEmbeddableWidget

public com.google.gwt.user.client.ui.Widget createEmbeddableWidget()

Creates a default widgets without the top most tab. It can be easily embedded into a TablayoutPanel for instance.

Returns:

createToolStrip

protected org.jboss.ballroom.client.widgets.tools.ToolStrip createToolStrip()

createToolStrip

protected org.jboss.ballroom.client.widgets.tools.ToolStrip createToolStrip(String resourceAddress)

makeEntityEditor

protected EntityEditor<T> makeEntityEditor()

Create the EntityEditor with the following pieces: - A title obtained from getPluralEntityName() - A table obtained from makeEntityTable() - An AddEntityWindow with a form from makeAddEntityForm() - An EntityDetails with a form from makeEditEntityDetailsForm()

Returns:

The EntityEditor

makeAddEntityPopup

protected EntityPopupWindow<T> makeAddEntityPopup()

makeFilterPredicate

protected DataProviderFilter.Predicate<T> makeFilterPredicate()

makeEditEntityDetailsForm

protected org.jboss.ballroom.client.widgets.forms.FormAdapter<T> makeEditEntityDetailsForm()

makeEditEntityDetailsForm

protected org.jboss.ballroom.client.widgets.forms.FormAdapter<T> makeEditEntityDetailsForm(String resourceAddress)

Creates an details for for the Entity. This method will add all the Entity's Attributes to the form in a 2-column format. If you desire a different layout or you want to exclude some attributes, you should override this method.

Returns:

The details form.

provideAdditionalTabs

protected List<SingleEntityView<T>> provideAdditionalTabs(Class<?> beanType,
                                              FormMetaData formMetaData,
                                              FrameworkPresenter presenter)

In case a tabbed form layout is used, implementations can provide additional custom tabs by overriding this method.

Parameters:

beanType -

formMetaData -

presenter -

makeSimpleForm

protected org.jboss.ballroom.client.widgets.forms.FormAdapter<T> makeSimpleForm()

makeSimpleForm

protected org.jboss.ballroom.client.widgets.forms.FormAdapter<T> makeSimpleForm(String resourceAddress)

setEditingEnabled

public void setEditingEnabled(boolean isEnabled)

Called when the user requests details to be edited.

Specified by:

setEditingEnabled in interface FrameworkView

Parameters:

isEnabled -

initialLoad

public void initialLoad()

Description copied from interface: FrameworkView

Call for Entities to be loaded into the view for the first time.

Specified by:

initialLoad in interface FrameworkView

initialLoad

public void initialLoad(ModelNode baseAddress)

refresh

public void refresh()

Called whenever there is a change to any Entity

Specified by:

refresh in interface FrameworkView

itemAction

public void itemAction(FormItemObserver.Action action,
              ObservableFormItem item)

Specified by:

itemAction in interface FormItemObserver