examples/org.eclipse.ui.examples.readmetool/Eclipse UI Examples Readme Tool/org/eclipse/ui/examples/readmetool/DirtyStateContribution.java

package org.eclipse.ui.examples.readmetool;

/*
 * (c) Copyright IBM Corp. 2000, 2001.
 * All Rights Reserved.
 */
import org.eclipse.jface.action.ControlContribution;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.*;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IPropertyListener;

/**
 * This class demonstrates the contribution of a custom control to the 
 * status line for the readme editor.  The control shows the
 * dirty status of the editor.
 */
public class DirtyStateContribution extends ControlContribution
	implements IPropertyListener
{
	private Composite composite;
	private Label label;
	private IEditorPart activeEditor;
/**
 * Creates a new DirtyStateContribution.
 */
protected DirtyStateContribution() {
	super("DirtyState"); //$NON-NLS-1$
}
/* (non-Javadoc)
 * Method declared on ControlContribution
 */
protected Control createControl(Composite parent) {
	// If the composite is good just return it.
	if (composite != null && !composite.isDisposed())
		return composite;
		
	// Create composite for border.
	composite = new Composite(parent, SWT.BORDER);
	composite.setData(this);

	// Create label inside composite.	
	label = new Label(composite, SWT.NONE);
	label.setSize(80, 15);
	
	updateState();
	return composite;
}
/**
 * Called when an editor is activated.
 *
 * @see ReadmeEditorActionBarContributor#setActiveEditor(IEditorPart)
 */
public void editorChanged(IEditorPart part) {
	if (activeEditor != null) {
		activeEditor.removePropertyListener(this);
	}
	activeEditor = part;
	if (activeEditor != null) {
		activeEditor.addPropertyListener(this);
	}
	updateState();
}
/* (non-Javadoc)
 * Method declared on IPropertyListener
 */
public void propertyChanged(Object source, int propID) {
	if (source instanceof IEditorPart)
		updateState();
}
/**
 * Updates the state of the label.
 */
private void updateState() {
	if (label == null || label.isDisposed())
		return;
		
	boolean saveNeeded = false;
	if (activeEditor != null)
		saveNeeded = activeEditor.isDirty();
	if (saveNeeded)
		label.setText(MessageUtil.getString("Save_Needed")); //$NON-NLS-1$
	else
		label.setText(MessageUtil.getString("Clean")); //$NON-NLS-1$
}
}