net.enilink.commons.ui.editor

Class EditorMasterDetailsBlock

java.lang.Object

net.enilink.commons.ui.editor.AbstractEditorPart

net.enilink.commons.ui.editor.EditorMasterDetailsBlock

All Implemented Interfaces:

IEditorPart, org.eclipse.jface.viewers.ISelectionChangedListener

public abstract class EditorMasterDetailsBlock
extends AbstractEditorPart
implements org.eclipse.jface.viewers.ISelectionChangedListener

This class implements the 'master/details' UI pattern suitable for inclusion in a form. The block consists of two parts: 'master' and 'details' in a sash form that allows users to change the relative ratio on the page. The master part needs to be created by the users of this class. The details part is created by the block.

The master part is responsible for adding itself as a form part and firing selection events. The details part catches the selection events and tries to load a page registered to handle the selected object(s). The page shows the details of the selected object(s) and allows users to edit them.

Details pages can be registered statically using 'registerPage' or dynamically through the use of 'IElementDetailsPartProvider' in case where different pages need to be shown for objects of the same type depending on their state.

Subclasses are required to implement abstract methods of this class. Master part must be created and at least one details page should be registered in order to show details of the objects selected in the master part. Tool bar actions can be optionally added to the tool bar manager.

Field Summary

Fields

Modifier and Type	Field and Description
protected EditorPartBook	detailsPartBook Details part created by the block.
protected CSashForm	sashForm The form that is the parent of both master and details part.

Constructor Summary

Constructors

Constructor and Description
EditorMasterDetailsBlock()

Method Summary

Modifier and Type	Method and Description
void	commit(boolean onSave)
void	createContents(org.eclipse.swt.widgets.Composite parent) Creates the content of the master/details block inside the managed form.
protected abstract void	createMasterPart(org.eclipse.swt.widgets.Composite parent) Implement this method to create a master part in the provided parent.
protected void	detailsCommitted(org.eclipse.jface.viewers.ISelection selection)
protected void	detailsRefreshed(IEditorPart detailsPart)
void	dispose()
boolean	isDirty()
boolean	isStale()
void	refresh()
protected abstract void	registerParts(EditorPartBook detailsMainPart) Implement this method to statically register parts for the expected object types.
void	selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)

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, setEditorInput, setFocus, setIgnoreChanges, setInput, setStale, syncExec

Methods inherited from class java.lang.Object

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

Field Detail

detailsPartBook

protected EditorPartBook detailsPartBook

Details part created by the block. No attempt should be made to access this field inside createMasterPart because it has not been created yet and will be null.

sashForm

protected CSashForm sashForm

The form that is the parent of both master and details part. The form allows users to change the ratio between the two parts.

Constructor Detail

EditorMasterDetailsBlock

public EditorMasterDetailsBlock()

Method Detail

createContents

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

Creates the content of the master/details block inside the managed form. This method should be called as late as possible inside the parent part.

Specified by:

createContents in interface IEditorPart

Parameters:

managedForm - the managed form to create the block in

createMasterPart

protected abstract void createMasterPart(org.eclipse.swt.widgets.Composite parent)

Implement this method to create a master part in the provided parent. Typical master parts are section parts that contain tree or table viewer.

Parameters:

parent - the parent composite

registerParts

protected abstract void registerParts(EditorPartBook detailsMainPart)

Implement this method to statically register parts for the expected object types. This mechanism can be used when there is 1->1 mapping between object classes and details pages.

Parameters:

detailsMainPart - the details part

selectionChanged

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

Specified by:

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

detailsCommitted

protected void detailsCommitted(org.eclipse.jface.viewers.ISelection selection)

detailsRefreshed

protected void detailsRefreshed(IEditorPart detailsPart)

commit

public void commit(boolean onSave)

Specified by:

commit in interface IEditorPart

Overrides:

commit in class AbstractEditorPart

isDirty

public boolean isDirty()

Specified by:

isDirty in interface IEditorPart

Overrides:

isDirty in class AbstractEditorPart

isStale

public boolean isStale()

Specified by:

isStale in interface IEditorPart

Overrides:

isStale in class AbstractEditorPart

refresh

public void refresh()

Specified by:

refresh in interface IEditorPart

Overrides:

refresh in class AbstractEditorPart

dispose

public void dispose()

Specified by:

dispose in interface IEditorPart

Overrides:

dispose in class AbstractEditorPart