org.argeo.cms.ui.viewers

Class AbstractPageViewer

java.lang.Object

org.eclipse.jface.viewers.Viewer

org.eclipse.jface.viewers.ContentViewer

org.argeo.cms.ui.viewers.AbstractPageViewer

All Implemented Interfaces:

java.io.Serializable, java.util.Observer, org.eclipse.jface.viewers.IInputProvider, org.eclipse.jface.viewers.IInputSelectionProvider, org.eclipse.jface.viewers.ISelectionProvider

Direct Known Subclasses:

FormPageViewer

public abstract class AbstractPageViewer
extends org.eclipse.jface.viewers.ContentViewer
implements java.util.Observer

Base class for viewers related to a page

See Also:

Serialized Form

Field Summary

Fields inherited from class org.eclipse.jface.viewers.Viewer

WIDGET_DATA_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPageViewer(Section parent, int style, CmsEditable cmsEditable)

Method Summary

Modifier and Type	Method and Description
protected void	cancelEdit()
protected void	checkEdited() Check whether the edited part is in a proper state
protected org.eclipse.swt.events.FocusListener	createFocusListener() Create (retrieve) the FocusListener to use.
protected org.eclipse.swt.events.MouseListener	createMouseListener() Create (retrieve) the MouseListener to use.
protected void	edit(EditablePart part, java.lang.Object caretPosition)
protected void	editingStateChanged(CmsEditable cmsEditable) Notified when the editing state changed.
protected EditablePart	findDataParent(org.eclipse.swt.widgets.Control parent) Find the first EditablePart in the parents hierarchy of this control
protected org.eclipse.swt.widgets.Composite	findPage(org.eclipse.swt.widgets.Composite composite)
CmsEditable	getCmsEditable()
protected EditablePart	getEdited()
org.eclipse.swt.events.FocusListener	getFocusListener()
org.eclipse.swt.events.MouseListener	getMouseListener()
org.eclipse.jface.viewers.ISelection	getSelection()
protected javax.security.auth.Subject	getViewerSubject()
protected void	initModel(Node node) Called if user can edit and model is not initialized
protected void	initModelIfNeeded(Node node) Can be called to simplify the called to isModelInitialized() and initModel()
protected java.lang.Boolean	isModelInitialized(Node node) Called if user can edit and model is not initialized
boolean	isReadOnly()
void	layout(org.eclipse.swt.widgets.Control... controls) Layout this controls from the related base page.
protected void	notifyEditionException(java.lang.Throwable e) Notify edition exception
protected void	persistChanges(Node anyNode) Convenience method using a Node in order to save the underlying session.
protected void	persistChanges(Session session) Persist all changes.
protected void	prepare(EditablePart part, java.lang.Object caretPosition) Prepare the edited part
void	refresh()
protected void	refresh(org.eclipse.swt.widgets.Control control) To be overridden in order to provide the actual refresh
protected void	save(EditablePart part) To be overridden.Save the edited part.
protected void	saveEdit()
void	setSelection(org.eclipse.jface.viewers.ISelection selection, boolean reveal)
void	update(java.util.Observable o, java.lang.Object arg)
protected void	updateContent(EditablePart part)

Methods inherited from class org.eclipse.jface.viewers.ContentViewer

getContentProvider, getInput, getLabelProvider, handleDispose, handleLabelProviderChanged, hookControl, labelProviderChanged, setContentProvider, setInput, setLabelProvider

Methods inherited from class org.eclipse.jface.viewers.Viewer

addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getControl, getData, handleHelpRequest, inputChanged, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPageViewer

protected AbstractPageViewer(Section parent,
                             int style,
                             CmsEditable cmsEditable)

Method Detail

initModelIfNeeded

protected void initModelIfNeeded(Node node)

Can be called to simplify the called to isModelInitialized() and initModel()

isModelInitialized

protected java.lang.Boolean isModelInitialized(Node node)
                                        throws RepositoryException

Called if user can edit and model is not initialized

Throws:

RepositoryException

initModel

protected void initModel(Node node)
                  throws RepositoryException

Called if user can edit and model is not initialized

Throws:

RepositoryException

createMouseListener

protected org.eclipse.swt.events.MouseListener createMouseListener()

Create (retrieve) the MouseListener to use.

createFocusListener

protected org.eclipse.swt.events.FocusListener createFocusListener()

Create (retrieve) the FocusListener to use.

findPage

protected org.eclipse.swt.widgets.Composite findPage(org.eclipse.swt.widgets.Composite composite)

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Specified by:

update in interface java.util.Observer

refresh

protected void refresh(org.eclipse.swt.widgets.Control control)
                throws RepositoryException

To be overridden in order to provide the actual refresh

Throws:

RepositoryException

save

protected void save(EditablePart part)
             throws RepositoryException

To be overridden.Save the edited part.

Throws:

RepositoryException

prepare

protected void prepare(EditablePart part,
                       java.lang.Object caretPosition)

Prepare the edited part

editingStateChanged

protected void editingStateChanged(CmsEditable cmsEditable)

Notified when the editing state changed. Does nothing, to be overridden

refresh

public void refresh()

Specified by:

refresh in class org.eclipse.jface.viewers.Viewer

setSelection

public void setSelection(org.eclipse.jface.viewers.ISelection selection,
                         boolean reveal)

Specified by:

setSelection in class org.eclipse.jface.viewers.Viewer

updateContent

protected void updateContent(EditablePart part)
                      throws RepositoryException

Throws:

RepositoryException

edit

protected void edit(EditablePart part,
                    java.lang.Object caretPosition)

saveEdit

protected void saveEdit()

cancelEdit

protected void cancelEdit()

layout

public void layout(org.eclipse.swt.widgets.Control... controls)

Layout this controls from the related base page.

findDataParent

protected EditablePart findDataParent(org.eclipse.swt.widgets.Control parent)

Find the first EditablePart in the parents hierarchy of this control

checkEdited

protected void checkEdited()

Check whether the edited part is in a proper state

persistChanges

protected void persistChanges(Session session)
                       throws RepositoryException

Persist all changes.

Throws:

RepositoryException

persistChanges

protected void persistChanges(Node anyNode)
                       throws RepositoryException

Convenience method using a Node in order to save the underlying session.

Throws:

RepositoryException

notifyEditionException

protected void notifyEditionException(java.lang.Throwable e)

Notify edition exception

getViewerSubject

protected javax.security.auth.Subject getViewerSubject()

isReadOnly

public boolean isReadOnly()

getEdited

protected EditablePart getEdited()

getMouseListener

public org.eclipse.swt.events.MouseListener getMouseListener()

getFocusListener

public org.eclipse.swt.events.FocusListener getFocusListener()

getCmsEditable

public CmsEditable getCmsEditable()

getSelection

public org.eclipse.jface.viewers.ISelection getSelection()

Specified by:

getSelection in interface org.eclipse.jface.viewers.ISelectionProvider

Specified by:

getSelection in class org.eclipse.jface.viewers.Viewer