Java tutorial
/******************************************************************************* * Copyright (c) 2011, 2012 Wind River Systems, Inc. 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: * Wind River Systems - initial API and implementation *******************************************************************************/ package org.eclipse.tcf.te.ui.forms.parts; import java.util.Arrays; import java.util.List; import org.eclipse.core.runtime.Assert; import org.eclipse.jface.dialogs.IDialogConstants; import org.eclipse.jface.layout.PixelConverter; import org.eclipse.jface.resource.JFaceResources; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionAdapter; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.widgets.FormToolkit; /** * Abstract part with buttons implementation. */ public abstract class AbstractPartWithButtons extends AbstractPart { // The button labels private final List<String> labels; // The buttons list private Button[] buttons = null; /** * Constructor. * * @param labels The list of label to apply to the created buttons in the given order. Must not be <code>null</code>. */ public AbstractPartWithButtons(String[] labels) { super(); Assert.isNotNull(labels); this.labels = Arrays.asList(labels); } /* (non-Javadoc) * @see org.eclipse.tcf.te.ui.forms.parts.AbstractPart#createControl(org.eclipse.swt.widgets.Composite, int, int, org.eclipse.ui.forms.widgets.FormToolkit) */ @Override public void createControl(Composite parent, int style, int span, FormToolkit toolkit) { Assert.isNotNull(parent); createMainLabel(parent, span, toolkit); createMainControl(parent, style, span - ((labels != null && labels.size() > 0) ? 1 : 0), toolkit); createButtonsPanel(parent, toolkit); } /** * Creates the part main control(s). * * @param parent The parent composite. Must not be <code>null</code>. * @param style The control style if applicable. * @param span The horizontal span if applicable. * @param toolkit The form toolkit or <code>null</code>. */ protected abstract void createMainControl(Composite parent, int style, int span, FormToolkit toolkit); /** * Create the part main label control. * * @param parent The parent composite. Must not be <code>null</code>. * @param span The horizontal span if applicable. * @param toolkit The form toolkit or <code>null</code>. */ protected void createMainLabel(Composite parent, int span, FormToolkit toolkit) { Assert.isNotNull(parent); } /** * Create the buttons panel. * * @param parent The parent composite. Must not be <code>null</code>. * @param toolkit The form toolkit or <code>null</code>. * * @return The buttons panel composite or <code>null</code>. */ protected Composite createButtonsPanel(Composite parent, FormToolkit toolkit) { if (labels == null || labels.size() == 0) { return null; } buttons = new Button[labels.size()]; Composite panel = createComposite(parent, toolkit); GridLayout layout = new GridLayout(); layout.marginHeight = 0; layout.marginWidth = 0; panel.setLayout(layout); GridData layoutData = new GridData(SWT.BEGINNING, SWT.FILL, false, true); panel.setLayoutData(layoutData); panel.setBackground(parent.getBackground()); SelectionListener listener = new SelectionAdapter() { @Override public void widgetSelected(SelectionEvent e) { AbstractPartWithButtons.this.onButtonSelected((Button) e.widget); } }; for (int i = 0; i < labels.size(); i++) { if (labels.get(i) != null) { Button button = toolkit != null ? toolkit.createButton(panel, null, SWT.PUSH) : new Button(panel, SWT.PUSH); Assert.isNotNull(button); button.setFont(JFaceResources.getDialogFont()); button.setText(labels.get(i)); button.setData(Integer.valueOf(i)); button.setBackground(panel.getBackground()); button.addSelectionListener(listener); onButtonCreated(button); layoutData = new GridData(SWT.FILL, SWT.BEGINNING, true, false); layoutData.widthHint = Math.max( new PixelConverter(button).convertHorizontalDLUsToPixels(IDialogConstants.BUTTON_WIDTH), button.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).x); button.setLayoutData(layoutData); buttons[i] = button; } else { createEmptySpace(panel, 1, toolkit); } } return panel; } /** * Called from {@link #createButtonsPanel(Composite, FormToolkit)} for each created button. * <p> * <b>Note:</b> The button layout data is set by {@link #createButtonsPanel(Composite, FormToolkit)} * after this method has been returned. * * @param button The created button. Must not be <code>null</code>. */ protected void onButtonCreated(Button button) { Assert.isNotNull(button); } /** * Called from the buttons selection listener to signal when * the user clicked on the button. * * @param button The button selected. Must not be <code>null</code> */ protected void onButtonSelected(Button button) { Assert.isNotNull(button); } /* (non-Javadoc) * @see org.eclipse.tcf.te.ui.forms.parts.AbstractPart#onEnabledStateChanged() */ @Override protected void onEnabledStateChanged() { for (Button button : buttons) { if (button != null && !button.isDisposed()) { button.setEnabled(isEnabled()); } } } /** * Returns the button with the given label. * * @param label The button label. * @return The button or <code>null</code>. */ public Button getButton(String label) { return labels != null ? getButton(labels.indexOf(label)) : null; } /** * Returns the button at the given index. * * @param index The index. * @return The button or <code>null</code>. */ public Button getButton(int index) { if (buttons == null) return null; return index >= 0 && index < buttons.length ? buttons[index] : null; } }