org.eclipse.jface.viewers.CheckboxCellEditor Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2000, 2014 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.viewers;
import org.eclipse.core.runtime.Assert;
import org.eclipse.pde.api.tools.annotations.NoExtend;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
/**
* A cell editor that manages a checkbox.
* The cell editor's value is a boolean.
*
* This class may be instantiated; it is not intended to be subclassed.
*
*
* Note that this implementation simply fakes it and does does not create
* any new controls. The mere activation of this editor means that the value
* of the check box is being toggled by the end users; the listener method
* applyEditorValue is immediately called to signal the change.
*
*/
@NoExtend
public class CheckboxCellEditor extends CellEditor {
/**
* The checkbox value.
*/
/* package */
boolean value = false;
/**
* Default CheckboxCellEditor style
*/
private static final int defaultStyle = SWT.NONE;
/**
* Creates a new checkbox cell editor with no control
* @since 2.1
*/
public CheckboxCellEditor() {
setStyle(defaultStyle);
}
/**
* Creates a new checkbox cell editor parented under the given control.
* The cell editor value is a boolean value, which is initially false.
* Initially, the cell editor has no cell validator.
*
* @param parent the parent control
*/
public CheckboxCellEditor(Composite parent) {
this(parent, defaultStyle);
}
/**
* Creates a new checkbox cell editor parented under the given control.
* The cell editor value is a boolean value, which is initially false.
* Initially, the cell editor has no cell validator.
*
* @param parent the parent control
* @param style the style bits
* @since 2.1
*/
public CheckboxCellEditor(Composite parent, int style) {
super(parent, style);
}
/**
* The CheckboxCellEditor implementation of
* this CellEditor framework method simulates
* the toggling of the checkbox control and notifies
* listeners with ICellEditorListener.applyEditorValue.
*/
@Override
public void activate() {
value = !value;
fireApplyEditorValue();
}
/**
* The CheckboxCellEditor implementation of
* this CellEditor framework method does
* nothing and returns null.
*/
@Override
protected Control createControl(Composite parent) {
return null;
}
/**
* The CheckboxCellEditor implementation of
* this CellEditor framework method returns
* the checkbox setting wrapped as a Boolean.
*
* @return the Boolean checkbox value
*/
@Override
protected Object doGetValue() {
return value ? Boolean.TRUE : Boolean.FALSE;
}
@Override
protected void doSetFocus() {
// Ignore
}
/**
* The CheckboxCellEditor implementation of
* this CellEditor framework method accepts
* a value wrapped as a Boolean.
*
* @param value a Boolean value
*/
@Override
protected void doSetValue(Object value) {
Assert.isTrue(value instanceof Boolean);
this.value = ((Boolean) value).booleanValue();
}
@Override
public void activate(ColumnViewerEditorActivationEvent activationEvent) {
if (activationEvent.eventType != ColumnViewerEditorActivationEvent.TRAVERSAL) {
super.activate(activationEvent);
}
}
}