net.enilink.commons.ui.editor

Class EditorPartBook

java.lang.Object

net.enilink.commons.ui.editor.AbstractEditorPart

net.enilink.commons.ui.editor.EditorPartBook

All Implemented Interfaces:

IEditorPart, org.eclipse.jface.viewers.ISelectionChangedListener

public class EditorPartBook
extends AbstractEditorPart
implements org.eclipse.jface.viewers.ISelectionChangedListener

This managed form part handles the 'details' portion of the 'master/details' block. It has a page book that manages pages of details registered for the current selection.

By default, details part accepts any number of pages. If dynamic page provider is registered, this number may be excessive. To avoid running out of steam (by creating a large number of pages with widgets on each), maximum number of pages can be set to some reasonable value (e.g. 10). When this number is reached, old pages (those created first) will be removed and disposed as new ones are added. If the disposed pages are needed again after that, they will be created again.

Constructor Summary

Constructors

Constructor and Description
EditorPartBook(boolean commitIfDirty) Creates a details part by wrapping the provided page book.
EditorPartBook(boolean commitIfDirty, int style)

Method Summary

Modifier and Type	Method and Description
void	commit(boolean onSave) Commits the part by committing the current page.
protected void	commitPart(org.eclipse.jface.viewers.ISelection selection, IEditorPart detailsPart, boolean onSave)
void	createContents(org.eclipse.swt.widgets.Composite parent)
void	dispose()
org.eclipse.swt.widgets.Control	getControl()
IEditorPart	getCurrentPart() Returns the current page visible in the part.
int	getPartLimit() Returns the maximum number of pages that should be maintained in this part.
boolean	isDirty() Tests if the currently visible page is dirty.
boolean	isStale() Tests if the currently visible page is stale and needs refreshing.
void	refresh() Refreshes the current page.
protected void	refreshPart(IEditorPart detailsPart)
void	registerPart(Class<?> objectClass, IEditorPart page) Registers the details part to be used for all the objects of the provided object class.
void	selectionChanged(org.eclipse.jface.viewers.ISelection selection)
void	selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)
boolean	setEditorInput(Object input)
boolean	setFocus() Sets the focus to the currently visible page.
void	setInput(Object input)
void	setPartLimit(int partLimit) Sets the page limit for this part.
void	setPartProvider(IEditorPartProvider provider) Sets the dynamic page provider.

Methods inherited from class net.enilink.commons.ui.editor.AbstractEditorPart

activate, addPart, addPart, addTextBorder, asyncExec, commitParts, deactivate, disposeParts, getForm, getIgnoreChanges, getParts, getShell, getWidgetFactory, initialize, initialize, refreshParts, removePart, setDirty, setIgnoreChanges, setStale, syncExec

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorPartBook

public EditorPartBook(boolean commitIfDirty)

Creates a details part by wrapping the provided page book.

Parameters:

mform - the parent form

scrolledPageBook - the page book to wrap

EditorPartBook

public EditorPartBook(boolean commitIfDirty,
                      int style)

Method Detail

registerPart

public void registerPart(Class<?> objectClass,
                         IEditorPart page)

Registers the details part to be used for all the objects of the provided object class.

Parameters:

objectClass - an object of type 'java.lang.Class' to be used as a key for the provided page

page - the page to show for objects of the provided object class

setPartProvider

public void setPartProvider(IEditorPartProvider provider)

Sets the dynamic page provider. The dynamic provider can return different pages for objects of the same class based on their state.

Parameters:

provider - the provider to use

commit

public void commit(boolean onSave)

Commits the part by committing the current page.

Specified by:

commit in interface IEditorPart

Overrides:

commit in class AbstractEditorPart

Parameters:

onSave - true if commit is requested as a result of the 'save' action, false otherwise.

getCurrentPart

public IEditorPart getCurrentPart()

Returns the current page visible in the part.

Returns:

the current page

dispose

public void dispose()

Specified by:

dispose in interface IEditorPart

Overrides:

dispose in class AbstractEditorPart

isDirty

public boolean isDirty()

Tests if the currently visible page is dirty.

Specified by:

isDirty in interface IEditorPart

Overrides:

isDirty in class AbstractEditorPart

Returns:

true if the page is dirty, false otherwise.

isStale

public boolean isStale()

Tests if the currently visible page is stale and needs refreshing.

Specified by:

isStale in interface IEditorPart

Overrides:

isStale in class AbstractEditorPart

Returns:

true if the page is stale, false otherwise.

refresh

public void refresh()

Refreshes the current page.

Specified by:

refresh in interface IEditorPart

Overrides:

refresh in class AbstractEditorPart

setFocus

public boolean setFocus()

Sets the focus to the currently visible page.

Specified by:

setFocus in interface IEditorPart

Overrides:

setFocus in class AbstractEditorPart

getControl

public org.eclipse.swt.widgets.Control getControl()

setEditorInput

public boolean setEditorInput(Object input)

Specified by:

setEditorInput in interface IEditorPart

Overrides:

setEditorInput in class AbstractEditorPart

selectionChanged

public void selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)

Specified by:

selectionChanged in interface org.eclipse.jface.viewers.ISelectionChangedListener

selectionChanged

public void selectionChanged(org.eclipse.jface.viewers.ISelection selection)

refreshPart

protected void refreshPart(IEditorPart detailsPart)

commitPart

protected void commitPart(org.eclipse.jface.viewers.ISelection selection,
                          IEditorPart detailsPart,
                          boolean onSave)

getPartLimit

public int getPartLimit()

Returns the maximum number of pages that should be maintained in this part. When an attempt is made to add more pages, old pages are removed and disposed based on the order of creation (the oldest pages are removed). The exception is made for the page that should otherwise be disposed but is currently active.

Returns:

maximum number of pages for this part

setPartLimit

public void setPartLimit(int partLimit)

Sets the page limit for this part.

Parameters:

partLimit - the maximum number of pages that should be maintained in this part.

See Also:

getPartLimit()

createContents

public void createContents(org.eclipse.swt.widgets.Composite parent)

Specified by:

createContents in interface IEditorPart

setInput

public void setInput(Object input)

Specified by:

setInput in interface IEditorPart

Overrides:

setInput in class AbstractEditorPart