org.viewaframework.view
Interface ViewContainer

All Superinterfaces:
ApplicationAware, ComponentsAware, DelegatorAware, MessageAware, RootPaneContainer, ViewContainerEventAware, ViewContainerEventControllerAware, ViewControllerAware, ViewModelAware
All Known Subinterfaces:
ViewContainerDialog, ViewContainerEditor, ViewContainerFrame
All Known Implementing Classes:
AboutView, AbstractViewContainer, AbstractViewContainerDialog, AbstractViewContainerFrame, AbstractViewContainerTray, DefaultViewContainer, DefaultViewContainerEditor, DefaultViewContainerFrame, DetailView, LoginView, MasterView

public interface ViewContainer
extends ViewContainerEventAware, ViewContainerEventControllerAware, ApplicationAware, ComponentsAware, ViewControllerAware, ViewModelAware, DelegatorAware, RootPaneContainer, MessageAware

This class it is the container of all graphical components.

Author:
Mario Garcia

Field Summary
static String CONTENTPANE
           
static String FRAME
           
static String MENUBAR
           
static String ROOTPANE
           
static String TOOLBAR
           
 
Method Summary
 List<ViewActionDescriptor> getActionDescriptors()
           
 Image getIconImage()
          Returns the image that represents this view
 String getId()
          Returns the id of the view
 JToolBar getJToolBar()
           
 String getTitle()
          Returns the title of the view
 void setActionDescriptors(List<ViewActionDescriptor> descriptors)
           
 void setIconImage(Image image)
          Sets a representative image for this view
 void setId(String name)
          Sets the name view.
 void setJToolbar(JToolBar toolBar)
           
 void setTitle(String title)
          Sets the title of the view
 void viewClose()
          Closes the view
 void viewFinalUIState()
          Once background actions has been performed we can establish the final aspect of the view within this method.
 void viewInit()
          Initializes the view.
 void viewInitBackActions()
          Background actions affecting the final view.
 void viewInitUIState()
          How the view is visualized before background actions are performed.
 
Methods inherited from interface org.viewaframework.view.event.ViewContainerEventAware
fireViewClose, fireViewFinalUIState, fireViewInit, fireViewInitBackActions, fireViewInitUIState
 
Methods inherited from interface org.viewaframework.view.event.ViewContainerEventControllerAware
addViewContainerListener, getViewContainerListeners, removeViewContainerListener, setViewContainerListeners
 
Methods inherited from interface org.viewaframework.core.ApplicationAware
getApplication, setApplication
 
Methods inherited from interface org.viewaframework.view.ComponentsAware
getComponentByName, getComponentsByName, getNamedComponents, setNamedComponents
 
Methods inherited from interface org.viewaframework.controller.ViewControllerAware
getViewControllerMap, setViewControllerMap
 
Methods inherited from interface org.viewaframework.model.ViewModelAware
addModelValue, getModelValue, getViewModelMap, setViewModelMap
 
Methods inherited from interface org.viewaframework.view.delegator.DelegatorAware
addDelegator, getDelegators, removeDelegator, setDelegators
 
Methods inherited from interface javax.swing.RootPaneContainer
getContentPane, getGlassPane, getLayeredPane, getRootPane, setContentPane, setGlassPane, setLayeredPane
 
Methods inherited from interface org.viewaframework.core.MessageAware
getMessage, getMessageBundle, setMessageBundle
 

Field Detail

CONTENTPANE

static final String CONTENTPANE
See Also:
Constant Field Values

FRAME

static final String FRAME
See Also:
Constant Field Values

MENUBAR

static final String MENUBAR
See Also:
Constant Field Values

ROOTPANE

static final String ROOTPANE
See Also:
Constant Field Values

TOOLBAR

static final String TOOLBAR
See Also:
Constant Field Values
Method Detail

getActionDescriptors

List<ViewActionDescriptor> getActionDescriptors()
Returns:

getIconImage

Image getIconImage()
Returns the image that represents this view

Returns:

getId

String getId()
Returns the id of the view

Returns:
the name

getJToolBar

JToolBar getJToolBar()
Returns:

getTitle

String getTitle()
Returns the title of the view

Returns:

setActionDescriptors

void setActionDescriptors(List<ViewActionDescriptor> descriptors)
Parameters:
descriptors -

setIconImage

void setIconImage(Image image)
Sets a representative image for this view

Parameters:
image -

setId

void setId(String name)
Sets the name view.

Parameters:
name - the id to set

setJToolbar

void setJToolbar(JToolBar toolBar)
Parameters:
toolBar -

setTitle

void setTitle(String title)
Sets the title of the view

Parameters:
title -

viewClose

void viewClose()
               throws ViewException
Closes the view

Throws:
ViewException

viewFinalUIState

void viewFinalUIState()
                      throws ViewException
Once background actions has been performed we can establish the final aspect of the view within this method.

Throws:
ViewException

viewInit

void viewInit()
              throws ViewException
Initializes the view. It should be implemented by an abstract class and it should call sequentially to the following methods.

viewInitUIState();
viewInitBackActions();
viewFinalUIState();

Throws:
ViewException

viewInitBackActions

void viewInitBackActions()
                         throws ViewException
Background actions affecting the final view. Actions that could freeze the UI, should be done here.

Throws:
ViewException

viewInitUIState

void viewInitUIState()
                     throws ViewException
How the view is visualized before background actions are performed. For example, if we want to keep disabled the UI until some database actions finished we should do it here.

Throws:
ViewException


Copyright © 2010. All Rights Reserved.