chuck.terran.admin.ui.jface.LineFieldEditor.java Source code

Introduction

Here is the source code for chuck.terran.admin.ui.jface.LineFieldEditor.java

Source

/*******************************************************************************
 * Copyright (c) 2000, 2013 IBM 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package chuck.terran.admin.ui.jface;

import jo.util.ui.utils.LineAttributesLogic;

import org.eclipse.jface.preference.FieldEditor;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;

/**
 * A field editor for a color type preference.
 */
public class LineFieldEditor extends FieldEditor {

    /**
     * The color selector, or <code>null</code> if none.
     */
    private LineSelector lineSelector;

    /**
     * Creates a new color field editor
     */
    protected LineFieldEditor() {
        //No default behavior
    }

    /**
     * Creates a color field editor.
     *
     * @param name
     *            the name of the preference this field editor works on
     * @param labelText
     *            the label text of the field editor
     * @param parent
     *            the parent of the field editor's control
     */
    public LineFieldEditor(String name, String labelText, Composite parent) {
        super(name, labelText, parent);
    }

    @Override
    protected void adjustForNumColumns(int numColumns) {
        ((GridData) lineSelector.getButton().getLayoutData()).horizontalSpan = numColumns - 1;
    }

    /**
     * Computes the size of the color image displayed on the button.
     * <p>
     * This is an internal method and should not be called by clients.
     * </p>
     *
     * @param window
     *            the window to create a GC on for calculation.
     * @return Point The image size
     *
     */
    protected Point computeImageSize(Control window) {
        // Make the image height as high as a corresponding character. This
        // makes sure that the button has the same size as a "normal" text
        // button.
        GC gc = new GC(window);
        Font f = JFaceResources.getFontRegistry().get(JFaceResources.DEFAULT_FONT);
        gc.setFont(f);
        int height = gc.getFontMetrics().getHeight();
        gc.dispose();
        Point p = new Point(height * 3 - 6, height);
        return p;
    }

    @Override
    protected void doFillIntoGrid(Composite parent, int numColumns) {
        Control control = getLabelControl(parent);
        GridData gd = new GridData();
        gd.horizontalSpan = numColumns - 1;
        control.setLayoutData(gd);

        Button colorButton = getChangeControl(parent);
        colorButton.setLayoutData(new GridData());

    }

    @Override
    protected void doLoad() {
        if (lineSelector == null) {
            return;
        }
        lineSelector
                .setLineValue(LineAttributesLogic.fromString(getPreferenceStore().getString(getPreferenceName())));
    }

    @Override
    protected void doLoadDefault() {
        if (lineSelector == null) {
            return;
        }
        lineSelector.setLineValue(
                LineAttributesLogic.fromString(getPreferenceStore().getDefaultString(getPreferenceName())));
    }

    @Override
    protected void doStore() {
        getPreferenceStore().setValue(getPreferenceName(),
                LineAttributesLogic.toString(lineSelector.getLineValue()));
    }

    /**
     * Get the color selector used by the receiver.
     *
     * @return LineSelector/
     */
    public LineSelector getLineSelector() {
        return lineSelector;
    }

    /**
     * Returns the change button for this field editor.
     *
     * @param parent
     *            The control to create the button in if required.
     * @return the change button
     */
    protected Button getChangeControl(Composite parent) {
        if (lineSelector == null) {
            lineSelector = new LineSelector(parent);
            lineSelector.addListener(new IPropertyChangeListener() {
                // forward the property change of the color selector
                @Override
                public void propertyChange(PropertyChangeEvent event) {
                    LineFieldEditor.this.fireValueChanged(event.getProperty(), event.getOldValue(),
                            event.getNewValue());
                    setPresentsDefaultValue(false);
                }
            });

        } else {
            checkParent(lineSelector.getButton(), parent);
        }
        return lineSelector.getButton();
    }

    @Override
    public int getNumberOfControls() {
        return 2;
    }

    @Override
    public void setEnabled(boolean enabled, Composite parent) {
        super.setEnabled(enabled, parent);
        getChangeControl(parent).setEnabled(enabled);
    }

}