|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.richclient.application.support.ApplicationServicesAccessor
org.springframework.richclient.factory.AbstractControlFactory
org.springframework.richclient.application.support.AbstractApplicationPage
public abstract class AbstractApplicationPage
Abstract "convenience" implementation of ApplicationPage
.
Field Summary |
---|
Fields inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor |
---|
logger |
Constructor Summary | |
---|---|
AbstractApplicationPage()
|
|
AbstractApplicationPage(ApplicationWindow window,
PageDescriptor pageDescriptor)
|
Method Summary | |
---|---|
protected void |
addPageComponent(PageComponent pageComponent)
Adds the pageComponent to the components list while registering listeners and firing appropriate events. |
void |
addPageComponentListener(PageComponentListener listener)
|
boolean |
close()
Closes this ApplicationPage . |
boolean |
close(PageComponent pageComponent)
Closes the given PageComponent . |
boolean |
closeAllEditors()
|
protected PageComponent |
createPageComponent(PageComponentDescriptor descriptor)
Creates a PageComponent for the given PageComponentDescriptor. |
protected PageComponentPane |
createPageComponentPane(PageComponent pageComponent)
|
protected abstract void |
doAddPageComponent(PageComponent pageComponent)
This method must add the given PageComponent in the ui. |
protected abstract void |
doRemovePageComponent(PageComponent pageComponent)
This method must remove the given PageComponent from the
ui. |
protected PageComponent |
findPageComponent(String viewDescriptorId)
|
protected void |
fireClosed(PageComponent component)
|
protected void |
fireFocusGained(PageComponent component)
|
protected void |
fireFocusLost(PageComponent component)
|
protected void |
fireOpened(PageComponent component)
|
PageComponent |
getActiveComponent()
Returns the active PageComponent , or null
if none. |
ApplicationEventMulticaster |
getApplicationEventMulticaster()
|
String |
getId()
|
Set |
getPageComponents()
|
protected PageDescriptor |
getPageDescriptor()
|
protected ViewDescriptor |
getViewDescriptor(String viewDescriptorId)
|
ApplicationWindow |
getWindow()
|
protected abstract boolean |
giveFocusTo(PageComponent pageComponent)
This method must transfer the focus to the given PageComponent . |
void |
openEditor(Object editorInput)
|
void |
removePageComponentListener(PageComponentListener listener)
|
protected void |
setActiveComponent()
|
void |
setActiveComponent(PageComponent pageComponent)
Activates the given PageComponent . |
void |
setApplicationWindow(ApplicationWindow window)
|
void |
setDescriptor(PageDescriptor descriptor)
|
void |
showView(String viewDescriptorId)
|
void |
showView(ViewDescriptor viewDescriptor)
|
protected void |
updatePageComponentProperties(PageComponent pageComponent)
Called when the PageComponent changes any of its
properties (display name, caption, icon, ...). |
Methods inherited from class org.springframework.richclient.factory.AbstractControlFactory |
---|
createControl, createControlIfNecessary, getControl, isControlCreated, isSingleton, setSingleton |
Methods inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor |
---|
getActiveWindow, getApplication, getApplicationContext, getApplicationName, getApplicationServices, getCommandConfigurer, getComponentFactory, getConversionService, getIconSource, getImageSource, getMessage, getMessage, getMessage, getMessage, getMessages, getMessageSource, getObjectConfigurer, getService |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.springframework.richclient.factory.ControlFactory |
---|
getControl |
Constructor Detail |
---|
public AbstractApplicationPage()
public AbstractApplicationPage(ApplicationWindow window, PageDescriptor pageDescriptor)
Method Detail |
---|
protected void updatePageComponentProperties(PageComponent pageComponent)
PageComponent
changes any of its
properties (display name, caption, icon, ...).
This method should be overridden when these changes must be reflected in the ui.
pageComponent
- the PageComponent
that has changedprotected PageComponent findPageComponent(String viewDescriptorId)
public void addPageComponentListener(PageComponentListener listener)
addPageComponentListener
in interface ApplicationPage
public void removePageComponentListener(PageComponentListener listener)
removePageComponentListener
in interface ApplicationPage
protected void fireOpened(PageComponent component)
protected void fireFocusGained(PageComponent component)
protected void setActiveComponent()
protected ViewDescriptor getViewDescriptor(String viewDescriptorId)
public PageComponent getActiveComponent()
PageComponent
, or null
if none.
getActiveComponent
in interface ApplicationPage
PageComponent
public void setActiveComponent(PageComponent pageComponent)
PageComponent
. Does nothing if it is
already the active one.
Does nothing if this ApplicationPage
doesn't contain the
given PageComponent
.
setActiveComponent
in interface ApplicationPage
pageComponent
- the PageComponent
protected void fireFocusLost(PageComponent component)
protected abstract void doAddPageComponent(PageComponent pageComponent)
PageComponent
in the ui.
Implementors may choose to add the PageComponent
's
control directly, or add the PageComponentPane
's control.
pageComponent
- the PageComponent
to addprotected abstract void doRemovePageComponent(PageComponent pageComponent)
PageComponent
from the
ui.
pageComponent
- the PageComponent
to removeprotected abstract boolean giveFocusTo(PageComponent pageComponent)
PageComponent
. This could involve making an internal
frame visible, selecting a tab in a tabbed pane, ...
pageComponent
- the PageComponent
true
if the operation was successful,
false
otherwiseprotected PageComponentPane createPageComponentPane(PageComponent pageComponent)
protected void fireClosed(PageComponent component)
public String getId()
getId
in interface ApplicationPage
public ApplicationWindow getWindow()
getWindow
in interface ApplicationPage
public boolean close(PageComponent pageComponent)
PageComponent
. This method disposes the
PageComponent
, triggers all necessary events ("focus
lost" and "closed"), and will activate another PageComponent
(if there is one).
Returns false
if this ApplicationPage
doesn't contain the given PageComponent
.
close
in interface ApplicationPage
pageComponent
- the PageComponent
true
if pageComponent was successfully
closed.public boolean close()
ApplicationPage
. This method calls
close(PageComponent)
for each open PageComponent
.
close
in interface ApplicationPage
true
if the operation was successful,
false
otherwise.public void showView(String viewDescriptorId)
showView
in interface ApplicationPage
public void showView(ViewDescriptor viewDescriptor)
showView
in interface ApplicationPage
public void openEditor(Object editorInput)
openEditor
in interface ApplicationPage
public boolean closeAllEditors()
closeAllEditors
in interface ApplicationPage
protected void addPageComponent(PageComponent pageComponent)
pageComponent
- the pageComponent to add.protected PageComponent createPageComponent(PageComponentDescriptor descriptor)
descriptor
- the descriptor
public Set getPageComponents()
public final void setApplicationWindow(ApplicationWindow window)
public final void setDescriptor(PageDescriptor descriptor)
protected PageDescriptor getPageDescriptor()
public ApplicationEventMulticaster getApplicationEventMulticaster()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |