1 package org
.argeo
.cms
.ui
.viewers
;
3 import java
.security
.AccessControlContext
;
4 import java
.security
.AccessController
;
5 import java
.security
.PrivilegedAction
;
6 import java
.util
.Observable
;
7 import java
.util
.Observer
;
10 import javax
.jcr
.RepositoryException
;
11 import javax
.jcr
.Session
;
12 import javax
.security
.auth
.Subject
;
14 import org
.argeo
.api
.cms
.CmsEditable
;
15 import org
.argeo
.api
.cms
.CmsLog
;
16 import org
.argeo
.cms
.ui
.widgets
.ScrolledPage
;
17 import org
.argeo
.jcr
.JcrException
;
18 import org
.eclipse
.jface
.viewers
.ContentViewer
;
19 import org
.eclipse
.jface
.viewers
.ISelection
;
20 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
21 import org
.eclipse
.swt
.SWT
;
22 import org
.eclipse
.swt
.events
.FocusEvent
;
23 import org
.eclipse
.swt
.events
.FocusListener
;
24 import org
.eclipse
.swt
.events
.MouseAdapter
;
25 import org
.eclipse
.swt
.events
.MouseListener
;
26 import org
.eclipse
.swt
.widgets
.Composite
;
27 import org
.eclipse
.swt
.widgets
.Control
;
28 import org
.eclipse
.swt
.widgets
.Widget
;
29 import org
.xml
.sax
.SAXParseException
;
31 /** Base class for viewers related to a page */
32 public abstract class AbstractPageViewer
extends ContentViewer
implements Observer
{
33 private static final long serialVersionUID
= 5438688173410341485L;
35 private final static CmsLog log
= CmsLog
.getLog(AbstractPageViewer
.class);
37 private final boolean readOnly
;
38 /** The basis for the layouts, typically a ScrolledPage. */
39 private final Composite page
;
40 private final CmsEditable cmsEditable
;
42 private MouseListener mouseListener
;
43 private FocusListener focusListener
;
45 private EditablePart edited
;
46 private ISelection selection
= StructuredSelection
.EMPTY
;
48 private AccessControlContext accessControlContext
;
50 protected AbstractPageViewer(Section parent
, int style
, CmsEditable cmsEditable
) {
51 // read only at UI level
52 readOnly
= SWT
.READ_ONLY
== (style
& SWT
.READ_ONLY
);
54 this.cmsEditable
= cmsEditable
== null ? CmsEditable
.NON_EDITABLE
: cmsEditable
;
55 if (this.cmsEditable
instanceof Observable
)
56 ((Observable
) this.cmsEditable
).addObserver(this);
58 if (cmsEditable
.canEdit()) {
59 mouseListener
= createMouseListener();
60 focusListener
= createFocusListener();
62 page
= findPage(parent
);
63 accessControlContext
= AccessController
.getContext();
67 * Can be called to simplify the called to isModelInitialized() and initModel()
69 protected void initModelIfNeeded(Node node
) {
71 if (!isModelInitialized(node
))
72 if (getCmsEditable().canEdit()) {
74 node
.getSession().save();
76 } catch (RepositoryException e
) {
77 throw new JcrException("Cannot initialize model", e
);
81 /** Called if user can edit and model is not initialized */
82 protected Boolean
isModelInitialized(Node node
) throws RepositoryException
{
86 /** Called if user can edit and model is not initialized */
87 protected void initModel(Node node
) throws RepositoryException
{
90 /** Create (retrieve) the MouseListener to use. */
91 protected MouseListener
createMouseListener() {
92 return new MouseAdapter() {
93 private static final long serialVersionUID
= 1L;
97 /** Create (retrieve) the FocusListener to use. */
98 protected FocusListener
createFocusListener() {
99 return new FocusListener() {
100 private static final long serialVersionUID
= 1L;
103 public void focusLost(FocusEvent event
) {
107 public void focusGained(FocusEvent event
) {
112 protected Composite
findPage(Composite composite
) {
113 if (composite
instanceof ScrolledPage
) {
114 return (ScrolledPage
) composite
;
116 if (composite
.getParent() == null)
118 return findPage(composite
.getParent());
122 public void layoutPage() {
124 page
.layout(true, true);
127 protected void showControl(Control control
) {
128 if (page
!= null && (page
instanceof ScrolledPage
))
129 ((ScrolledPage
) page
).showControl(control
);
133 public void update(Observable o
, Object arg
) {
134 if (o
== cmsEditable
)
135 editingStateChanged(cmsEditable
);
138 /** To be overridden in order to provide the actual refresh */
139 protected void refresh(Control control
) throws RepositoryException
{
142 /** To be overridden.Save the edited part. */
143 protected void save(EditablePart part
) throws RepositoryException
{
146 /** Prepare the edited part */
147 protected void prepare(EditablePart part
, Object caretPosition
) {
150 /** Notified when the editing state changed. Does nothing, to be overridden */
151 protected void editingStateChanged(CmsEditable cmsEditable
) {
155 public void refresh() {
156 // TODO check actual context in order to notice a discrepancy
157 Subject viewerSubject
= getViewerSubject();
158 Subject
.doAs(viewerSubject
, (PrivilegedAction
<Void
>) () -> {
160 if (cmsEditable
.canEdit() && !readOnly
)
161 mouseListener
= createMouseListener();
163 mouseListener
= null;
164 refresh(getControl());
165 // layout(getControl());
166 if (!getControl().isDisposed())
168 } catch (RepositoryException e
) {
169 throw new JcrException("Cannot refresh", e
);
176 public void setSelection(ISelection selection
, boolean reveal
) {
177 this.selection
= selection
;
180 protected void updateContent(EditablePart part
) throws RepositoryException
{
184 protected void edit(EditablePart part
, Object caretPosition
) {
189 if (edited
!= null && edited
!= part
) {
190 EditablePart previouslyEdited
= edited
;
193 } catch (Exception e
) {
194 notifyEditionException(e
);
195 edit(previouslyEdited
, caretPosition
);
203 prepare(part
, caretPosition
);
204 edited
.getControl().addFocusListener(new FocusListener() {
205 private static final long serialVersionUID
= 6883521812717097017L;
208 public void focusLost(FocusEvent event
) {
213 public void focusGained(FocusEvent event
) {
217 layout(part
.getControl());
218 showControl(part
.getControl());
219 } catch (RepositoryException e
) {
220 throw new JcrException("Cannot edit " + part
, e
);
224 protected void stopEditing(Boolean save
) {
225 if (edited
instanceof Widget
&& ((Widget
) edited
).isDisposed()) {
230 assert edited
!= null;
231 if (edited
== null) {
232 if (log
.isTraceEnabled())
233 log
.warn("Told to stop editing while not editing anything");
241 edited
.stopEditing();
242 EditablePart editablePart
= edited
;
243 Control control
= ((EditablePart
) edited
).getControl();
245 // TODO make edited state management more robust
246 updateContent(editablePart
);
248 } catch (RepositoryException e
) {
249 throw new JcrException("Cannot stop editing", e
);
255 // METHODS AVAILABLE TO EXTENDING CLASSES
256 protected void saveEdit() {
261 protected void cancelEdit() {
266 /** Layout this controls from the related base page. */
267 public void layout(Control
... controls
) {
268 page
.layout(controls
);
272 * Find the first {@link EditablePart} in the parents hierarchy of this control
274 protected EditablePart
findDataParent(Control parent
) {
275 if (parent
instanceof EditablePart
) {
276 return (EditablePart
) parent
;
278 if (parent
.getParent() != null)
279 return findDataParent(parent
.getParent());
281 throw new IllegalStateException("No data parent found");
285 /** Check whether the edited part is in a proper state */
286 protected void checkEdited() {
287 if (edited
== null || (edited
instanceof Widget
) && ((Widget
) edited
).isDisposed())
288 throw new IllegalStateException("Edited should not be null or disposed at this stage");
291 /** Persist all changes. */
292 protected void persistChanges(Session session
) throws RepositoryException
{
294 session
.refresh(false);
295 // TODO notify that changes have been persisted
298 /** Convenience method using a Node in order to save the underlying session. */
299 protected void persistChanges(Node anyNode
) throws RepositoryException
{
300 persistChanges(anyNode
.getSession());
303 /** Notify edition exception */
304 protected void notifyEditionException(Throwable e
) {
305 Throwable eToLog
= e
;
306 if (e
instanceof IllegalArgumentException
)
307 if (e
.getCause() instanceof SAXParseException
)
308 eToLog
= e
.getCause();
309 log
.error(eToLog
.getMessage(), eToLog
);
310 // if (log.isTraceEnabled())
311 // log.trace("Full stack of " + eToLog.getMessage(), e);
312 // TODO Light error notification popup
315 protected Subject
getViewerSubject() {
317 if (accessControlContext
!= null) {
318 res
= Subject
.getSubject(accessControlContext
);
321 throw new IllegalStateException("No subject associated with this viewer");
326 public boolean isReadOnly() {
330 protected EditablePart
getEdited() {
334 public MouseListener
getMouseListener() {
335 return mouseListener
;
338 public FocusListener
getFocusListener() {
339 return focusListener
;
342 public CmsEditable
getCmsEditable() {
347 public ISelection
getSelection() {