org.eclipse.ui.internal.views.markers.MarkerPriorityField.java Source code

Introduction

Here is the source code for org.eclipse.ui.internal.views.markers.MarkerPriorityField.java

Source

/*******************************************************************************
 * Copyright (c) 2007, 2009 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 org.eclipse.ui.internal.views.markers;

import org.eclipse.core.resources.IMarker;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.viewers.CellEditor;
import org.eclipse.jface.viewers.ColumnViewer;
import org.eclipse.jface.viewers.ComboBoxCellEditor;
import org.eclipse.jface.viewers.EditingSupport;
import org.eclipse.jface.viewers.ViewerCell;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.internal.ide.Policy;
import org.eclipse.ui.views.markers.MarkerField;
import org.eclipse.ui.views.markers.MarkerItem;
import org.eclipse.ui.views.markers.internal.MarkerMessages;

/**
 * MarkerPriorityField is the field for task priority.
 * 
 * @since 3.4
 * 
 */
public class MarkerPriorityField extends MarkerField {

    private class PriorityEditingSupport extends EditingSupport {

        private ComboBoxCellEditor editor;

        /**
         * Create a new instance of the receiver.
         * 
         * @param viewer
         */
        public PriorityEditingSupport(ColumnViewer viewer) {
            super(viewer);
            this.editor = new ComboBoxCellEditor((Composite) viewer.getControl(), priorities, SWT.READ_ONLY);
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.eclipse.jface.viewers.EditingSupport#canEdit(java.lang.Object)
         */
        protected boolean canEdit(Object element) {
            if (element instanceof MarkerEntry)
                return ((MarkerEntry) element).getAttributeValue(IMarker.USER_EDITABLE, false);
            return false;
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.eclipse.jface.viewers.EditingSupport#getCellEditor(java.lang.Object)
         */
        protected CellEditor getCellEditor(Object element) {
            return editor;
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.eclipse.jface.viewers.EditingSupport#getValue(java.lang.Object)
         */
        protected Object getValue(Object element) {
            return new Integer(
                    ((MarkerEntry) element).getAttributeValue(IMarker.PRIORITY, IMarker.PRIORITY_NORMAL));
        }

        /*
         * (non-Javadoc)
         * 
         * @see org.eclipse.jface.viewers.EditingSupport#setValue(java.lang.Object,
         *      java.lang.Object)
         */
        protected void setValue(Object element, Object value) {
            MarkerEntry entry = (MarkerEntry) element;
            Integer integerValue = (Integer) value;
            try {
                entry.getMarker().setAttribute(IMarker.PRIORITY, integerValue.intValue());
            } catch (CoreException e) {
                Policy.handle(e);
            }

        }
    }

    static final String HIGH_PRIORITY_IMAGE_PATH = "$nl$/icons/full/obj16/hprio_tsk.gif"; //$NON-NLS-1$

    static final String LOW_PRIORITY_IMAGE_PATH = "$nl$/icons/full/obj16/lprio_tsk.gif"; //$NON-NLS-1$

    private static String[] priorities = new String[] { MarkerMessages.priority_low, MarkerMessages.priority_normal,
            MarkerMessages.priority_high };

    /**
     * Return a new priority field.
     */
    public MarkerPriorityField() {
        super();
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.internal.provisional.views.markers.api.MarkerField#compare(org.eclipse.ui.internal.provisional.views.markers.api.MarkerItem,
     *      org.eclipse.ui.internal.provisional.views.markers.api.MarkerItem)
     */
    public int compare(MarkerItem item1, MarkerItem item2) {
        return item2.getAttributeValue(IMarker.PRIORITY, IMarker.PRIORITY_NORMAL)
                - item1.getAttributeValue(IMarker.PRIORITY, IMarker.PRIORITY_NORMAL);
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.internal.provisional.views.markers.MarkerField#getColumnHeaderText()
     */
    public String getColumnHeaderText() {
        return MarkerSupportInternalUtilities.EMPTY_STRING;
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.internal.provisional.views.markers.api.MarkerField#getColumnTooltipText()
     */
    public String getColumnTooltipText() {
        return getName();
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.internal.provisional.views.markers.api.MarkerField#getDefaultColumnWidth(org.eclipse.swt.widgets.Control)
     */
    public int getDefaultColumnWidth(Control control) {
        return getHighPriorityImage().getBounds().width;
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.internal.provisional.views.markers.api.MarkerField#getEditingSupport(org.eclipse.jface.viewers.ColumnViewer)
     */
    public EditingSupport getEditingSupport(ColumnViewer viewer) {
        return new PriorityEditingSupport(viewer);
    }

    /**
     * Get the image for high priority
     * 
     * @return Image
     */
    private Image getHighPriorityImage() {
        return MarkerSupportInternalUtilities.createImage(HIGH_PRIORITY_IMAGE_PATH, getImageManager());
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.internal.provisional.views.markers.MarkerField#getValue(org.eclipse.ui.internal.provisional.views.markers.MarkerItem)
     */
    public String getValue(MarkerItem item) {
        return MarkerSupportInternalUtilities.EMPTY_STRING;
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.views.markers.MarkerField#update(org.eclipse.jface.viewers.ViewerCell)
     */
    public void update(ViewerCell cell) {
        super.update(cell);
        try {
            switch (((MarkerItem) cell.getElement()).getAttributeValue(IMarker.PRIORITY, IMarker.PRIORITY_NORMAL)) {
            case IMarker.PRIORITY_HIGH:
                cell.setImage(getHighPriorityImage());
                break;
            case IMarker.PRIORITY_NORMAL:
                cell.setImage(null);
                break;
            case IMarker.PRIORITY_LOW:
                cell.setImage(
                        MarkerSupportInternalUtilities.createImage(LOW_PRIORITY_IMAGE_PATH, getImageManager()));
                break;
            default:
                break;
            }

        } catch (NumberFormatException e) {
            return;
        }
    }
}