org.jminor.framework.client.ui
Class EntityPanelProvider

java.lang.Object
  extended by org.jminor.framework.client.ui.EntityPanelProvider
All Implemented Interfaces:
Comparable

public class EntityPanelProvider
extends Object
implements Comparable

A class providing EntityPanel instances. Note: this class has a natural ordering based on the caption which is inconsistent with equals.


Field Summary
protected static org.slf4j.Logger LOG
           
 
Constructor Summary
EntityPanelProvider(String entityID)
          Instantiates a new EntityPanelProvider for the given entity type
EntityPanelProvider(String entityID, Class<? extends EntityModel> entityModelClass, Class<? extends EntityPanel> entityPanelClass)
          Instantiates a new EntityPanelProvider
EntityPanelProvider(String entityID, String caption)
          Instantiates a new EntityPanelProvider for the given entity type
EntityPanelProvider(String entityID, String caption, Class<? extends EntityModel> entityModelClass, Class<? extends EntityPanel> entityPanelClass)
          Instantiates a new EntityPanelProvider
 
Method Summary
 EntityPanelProvider addDetailPanelProvider(EntityPanelProvider panelProvider)
           
 int compareTo(Object o)
           
protected  void configureEditModel(EntityEditModel editModel)
           
protected  void configureEditPanel(EntityEditPanel editPanel)
           
protected  void configureModel(EntityModel entityModel)
           
protected  void configurePanel(EntityPanel entityPanel)
           
protected  void configureTableModel(EntityTableModel tableModel)
           
protected  void configureTablePanel(EntityTablePanel tablePanel)
           
 EntityEditPanel createEditPanel(EntityConnectionProvider connectionProvider)
           
 EntityPanel createPanel(EntityConnectionProvider connectionProvider)
           
 EntityPanel createPanel(EntityConnectionProvider connectionProvider, boolean detailPanel)
           
 EntityPanel createPanel(EntityModel model)
           
 EntityTablePanel createTablePanel(EntityConnectionProvider connectionProvider)
           
 boolean equals(Object obj)
          
 String getCaption()
           
 List<EntityPanelProvider> getDetailPanelProviders()
           
 int getDetailPanelState()
           
 double getDetailSplitPanelResizeWeight()
           
 Class<? extends EntityEditModel> getEditModelClass()
           
 Class<? extends EntityEditPanel> getEditPanelClass()
           
 String getEntityID()
           
 Class<? extends EntityModel> getModelClass()
           
 Class<? extends EntityPanel> getPanelClass()
           
static EntityPanelProvider getProvider(String entityID)
           
 Class<? extends EntityTableModel> getTableModelClass()
           
 Class<? extends EntityTablePanel> getTablePanelClass()
           
 int hashCode()
          
 boolean isRefreshOnInit()
           
 boolean isTableSearchPanelVisible()
           
 EntityPanelProvider register()
           
 EntityPanelProvider setDetailPanelState(int detailPanelState)
           
 EntityPanelProvider setDetailSplitPanelResizeWeight(double detailSplitPanelResizeWeight)
           
 EntityPanelProvider setEditModelClass(Class<? extends EntityEditModel> editModelClass)
           
 EntityPanelProvider setEditPanelClass(Class<? extends EntityEditPanel> editPanelClass)
           
 EntityPanelProvider setModelClass(Class<? extends EntityModel> modelClass)
           
 EntityPanelProvider setPanelClass(Class<? extends EntityPanel> panelClass)
           
 EntityPanelProvider setRefreshOnInit(boolean refreshOnInit)
           
 EntityPanelProvider setTableModelClass(Class<? extends EntityTableModel> tableModelClass)
           
 EntityPanelProvider setTablePanelClass(Class<? extends EntityTablePanel> tablePanelClass)
           
 EntityPanelProvider setTableSearchPanelVisible(boolean tableSearchPanelVisible)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

protected static final org.slf4j.Logger LOG
Constructor Detail

EntityPanelProvider

public EntityPanelProvider(String entityID)
Instantiates a new EntityPanelProvider for the given entity type

Parameters:
entityID - the entity ID

EntityPanelProvider

public EntityPanelProvider(String entityID,
                           String caption)
Instantiates a new EntityPanelProvider for the given entity type

Parameters:
entityID - the entity ID
caption - the panel caption

EntityPanelProvider

public EntityPanelProvider(String entityID,
                           Class<? extends EntityModel> entityModelClass,
                           Class<? extends EntityPanel> entityPanelClass)
Instantiates a new EntityPanelProvider

Parameters:
entityID - the entity ID
entityModelClass - the Class of the EntityModel
entityPanelClass - the Class of the EntityPanel

EntityPanelProvider

public EntityPanelProvider(String entityID,
                           String caption,
                           Class<? extends EntityModel> entityModelClass,
                           Class<? extends EntityPanel> entityPanelClass)
Instantiates a new EntityPanelProvider

Parameters:
entityID - the entityID
caption - the caption to use when this EntityPanelProvider is shown in f.x. menus
entityModelClass - the Class of the EntityModel
entityPanelClass - the Class of the EntityPanel
Method Detail

register

public final EntityPanelProvider register()

getEntityID

public final String getEntityID()
Returns:
the entity ID

getCaption

public final String getCaption()
Returns:
the caption to use when this EntityPanelProvider is shown in f.x. menus

addDetailPanelProvider

public final EntityPanelProvider addDetailPanelProvider(EntityPanelProvider panelProvider)

getDetailPanelProviders

public final List<EntityPanelProvider> getDetailPanelProviders()

isRefreshOnInit

public final boolean isRefreshOnInit()

setRefreshOnInit

public final EntityPanelProvider setRefreshOnInit(boolean refreshOnInit)

isTableSearchPanelVisible

public final boolean isTableSearchPanelVisible()

setTableSearchPanelVisible

public final EntityPanelProvider setTableSearchPanelVisible(boolean tableSearchPanelVisible)

getDetailPanelState

public final int getDetailPanelState()

setDetailPanelState

public final EntityPanelProvider setDetailPanelState(int detailPanelState)

getDetailSplitPanelResizeWeight

public final double getDetailSplitPanelResizeWeight()

setDetailSplitPanelResizeWeight

public final EntityPanelProvider setDetailSplitPanelResizeWeight(double detailSplitPanelResizeWeight)

setModelClass

public final EntityPanelProvider setModelClass(Class<? extends EntityModel> modelClass)

setPanelClass

public final EntityPanelProvider setPanelClass(Class<? extends EntityPanel> panelClass)

setEditPanelClass

public final EntityPanelProvider setEditPanelClass(Class<? extends EntityEditPanel> editPanelClass)

setTablePanelClass

public final EntityPanelProvider setTablePanelClass(Class<? extends EntityTablePanel> tablePanelClass)

setEditModelClass

public final EntityPanelProvider setEditModelClass(Class<? extends EntityEditModel> editModelClass)

setTableModelClass

public final EntityPanelProvider setTableModelClass(Class<? extends EntityTableModel> tableModelClass)

getModelClass

public final Class<? extends EntityModel> getModelClass()
Returns:
the EntityModel Class to use when instantiating an EntityPanel

getPanelClass

public final Class<? extends EntityPanel> getPanelClass()
Returns:
the EntityPanel Class to instantiate

getEditPanelClass

public final Class<? extends EntityEditPanel> getEditPanelClass()

getTablePanelClass

public final Class<? extends EntityTablePanel> getTablePanelClass()

getEditModelClass

public final Class<? extends EntityEditModel> getEditModelClass()

getTableModelClass

public final Class<? extends EntityTableModel> getTableModelClass()

compareTo

public final int compareTo(Object o)
Specified by:
compareTo in interface Comparable

equals

public final boolean equals(Object obj)

Overrides:
equals in class Object

hashCode

public final int hashCode()

Overrides:
hashCode in class Object

createPanel

public final EntityPanel createPanel(EntityConnectionProvider connectionProvider)

createPanel

public final EntityPanel createPanel(EntityConnectionProvider connectionProvider,
                                     boolean detailPanel)

createPanel

public final EntityPanel createPanel(EntityModel model)

createEditPanel

public final EntityEditPanel createEditPanel(EntityConnectionProvider connectionProvider)

createTablePanel

public final EntityTablePanel createTablePanel(EntityConnectionProvider connectionProvider)

getProvider

public static EntityPanelProvider getProvider(String entityID)

configurePanel

protected void configurePanel(EntityPanel entityPanel)

configureEditPanel

protected void configureEditPanel(EntityEditPanel editPanel)

configureTablePanel

protected void configureTablePanel(EntityTablePanel tablePanel)

configureModel

protected void configureModel(EntityModel entityModel)

configureEditModel

protected void configureEditModel(EntityEditModel editModel)

configureTableModel

protected void configureTableModel(EntityTableModel tableModel)