Skip to main content
summaryrefslogtreecommitdiffstats
blob: 7141dcb88a66026d2f8cddd4f886e67bb12e540e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*******************************************************************************
 * Copyright (c) 2001, 2008 Oracle Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Oracle Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jst.jsf.common.ui.internal.form;

import java.util.List;

import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.BusyIndicator;
import org.eclipse.swt.custom.SashForm;
import org.eclipse.swt.custom.StackLayout;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.forms.widgets.Form;
import org.eclipse.ui.forms.widgets.FormToolkit;

/**
 * An alternative to MasterDetailBlock that doesn't use the ScrolledForm
 * that causes problems as described here:
 * 
 * http://dev.eclipse.org/newslists/news.eclipse.platform/msg73145.html

 * @author cbateman
 *
 */
public abstract class AbstractMasterDetailBlock implements
        ISelectionChangedListener
{
    private AbstractMasterForm        _masterForm;
    private Composite                 _detailsPanel;
    private AbstractDetailsForm       _curPage;
    private FormToolkit               _toolkit;
    private StackLayout               _detailLayout;
    private List<AbstractDetailsForm> _detailForms;
    private BlankDetailsForm          _blankDetails;

    /**
     * 
     */
    protected AbstractMasterDetailBlock()
    {
        super();
    }

    /**
     * Disposes the master detail form
     */
    public final void dispose()
    {
        _masterForm.dispose();

        for (final AbstractDetailsForm detailsForm : _detailForms)
        {
            detailsForm.dispose();
        }

        doDispose();
    }

    /**
     * Override to get custom dispose logic. Do not use this to dispose of
     * master or details forms. This is done automatically for you before
     * doDispose is called.
     */
    protected void doDispose()
    {
        // do nothing by default
    }

    /**
     * @param toolkit
     * @param form
     */
    public final void createContent(final FormToolkit toolkit, final Form form)
    {
        _toolkit = toolkit;

        final GridLayout layout = new GridLayout();
        layout.marginWidth = 5;
        layout.marginHeight = 5;
        form.getBody().setLayout(layout);
        final SashForm sashForm = new SashForm(form.getBody(), SWT.NULL);
        // sashForm.setData("form", managedForm); //$NON-NLS-1$
        _toolkit.adapt(sashForm, false, false);
        sashForm.setMenu(form.getBody().getMenu());
        sashForm.setLayoutData(new GridData(GridData.FILL_BOTH));
        initializeMasterPart(_toolkit, sashForm);
        createDetailsPart(sashForm);

        _masterForm.createHead(form);
        createToolBarActions(form);
        form.updateToolBar();
    }

    /**
     * @param toolkit
     * @return the master form.
     */
    protected abstract AbstractMasterForm createMasterPart(
            final FormToolkit toolkit);

    private void initializeMasterPart(final FormToolkit toolkit,
            final Composite parent)
    {
        _masterForm = createMasterPart(toolkit);
        _masterForm.initialize(this);
        _masterForm.createClientArea(parent);
    }

    private void createToolBarActions(final Form form)
    {
        _masterForm.contributeActions(form.getToolBarManager());
    }

    private void createDetailsPart(final Composite parent)
    {
        _detailsPanel = new Composite(parent, SWT.NONE);
        _detailLayout = new StackLayout();
        _detailsPanel.setLayout(_detailLayout);

        _detailForms = createDetailPages();

        for (final AbstractDetailsForm detailForm : _detailForms)
        {
            detailForm.initialize(_toolkit);
            detailForm.createContents(_detailsPanel);
        }

        // create default blank page
        _blankDetails = new BlankDetailsForm();
        _blankDetails.initialize(_toolkit);
        _blankDetails.createContents(_detailsPanel);

        _curPage = _blankDetails;
        _detailLayout.topControl = _curPage.getControl();
        _detailsPanel.layout();
    }

    public final void selectionChanged(final SelectionChangedEvent event)
    {
        final Object selectedObj = ((IStructuredSelection) event.getSelection())
                .getFirstElement();
        final AbstractDetailsForm page = selectPage(selectedObj);
        if (page != null)
        {
            final AbstractDetailsForm fpage = page;
            BusyIndicator.showWhile(_detailsPanel.getDisplay(), new Runnable()
            {
                public void run()
                {
                    final AbstractDetailsForm oldPage = _curPage;
                    _curPage = fpage;
                    // commit the current page
                    if (oldPage != null && oldPage.isDirty())
                    {
                        oldPage.commit(false);
                    }
                    // refresh the new page
                    if (fpage.isStale())
                    {
                        fpage.refresh();
                    }
                    _curPage.selectionChanged(event.getSelection());
                    // _pageBook.showPage(_curPage.getTextSection().getControl());
                    _detailLayout.topControl = _curPage.getControl();
                    _detailsPanel.layout();
                }
            });
        }
    }

    /**
     * @return a list of detail forms
     */
    protected abstract List<AbstractDetailsForm> createDetailPages();

    /**
     * @param forModel
     * @return the details form for 'forModel'. If implementer returns null,
     *         then a blank page will be provided
     */
    protected abstract AbstractDetailsForm doSelectPage(final Object forModel);

    private AbstractDetailsForm selectPage(final Object forModel)
    {
        final AbstractDetailsForm clientForm = doSelectPage(forModel);

        if (clientForm != null)
        {
            return clientForm;
        }
        return _blankDetails;
    }

}

Back to the top