/*******************************************************************************
* Copyright (c) 2000, 2015 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.debug.internal.ui.preferences;
import org.eclipse.debug.internal.ui.DebugUIPlugin;
import org.eclipse.debug.internal.ui.IDebugHelpContextIds;
import org.eclipse.jface.preference.BooleanFieldEditor;
import org.eclipse.jface.preference.ColorFieldEditor;
import org.eclipse.jface.preference.FieldEditor;
import org.eclipse.jface.preference.FieldEditorPreferencePage;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.preference.IntegerFieldEditor;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
import org.eclipse.ui.PlatformUI;
import com.ibm.icu.text.MessageFormat;
/**
* A page to set the preferences for the console
*/
public class ConsolePreferencePage extends FieldEditorPreferencePage implements IWorkbenchPreferencePage {
/**
* This class exists to provide visibility to the
* <code>refreshValidState</code> method and to perform more intelligent
* clearing of the error message.
*/
protected class ConsoleIntegerFieldEditor extends IntegerFieldEditor {
public ConsoleIntegerFieldEditor(String name, String labelText, Composite parent) {
super(name, labelText, parent);
}
/**
* @see org.eclipse.jface.preference.FieldEditor#refreshValidState()
*/
@Override
protected void refreshValidState() {
super.refreshValidState();
}
/**
* Clears the error message from the message line if the error
* message is the error message from this field editor.
*/
@Override
protected void clearErrorMessage() {
if (canClearErrorMessage()) {
super.clearErrorMessage();
}
}
}
private BooleanFieldEditor2 fWrapEditor = null;
private ConsoleIntegerFieldEditor fWidthEditor = null;
private BooleanFieldEditor2 fUseBufferSize = null;
private ConsoleIntegerFieldEditor fBufferSizeEditor = null;
private ConsoleIntegerFieldEditor fTabSizeEditor = null;
/**
* Create the console page.
*/
public ConsolePreferencePage() {
super(GRID);
setDescription(DebugPreferencesMessages.ConsolePreferencePage_Console_settings);
setPreferenceStore(DebugUIPlugin.getDefault().getPreferenceStore());
}
/* (non-Javadoc)
* @see org.eclipse.jface.preference.PreferencePage#createControl(Composite)
*/
@Override
public void createControl(Composite parent) {
super.createControl(parent);
PlatformUI.getWorkbench().getHelpSystem().setHelp(
getControl(),
IDebugHelpContextIds.CONSOLE_PREFERENCE_PAGE );
}
/**
* Create all field editors for this page
*/
@Override
public void createFieldEditors() {
fWrapEditor = new BooleanFieldEditor2(IDebugPreferenceConstants.CONSOLE_WRAP, DebugPreferencesMessages.ConsolePreferencePage_Wrap_text_1, SWT.NONE, getFieldEditorParent());
addField(fWrapEditor);
fWidthEditor = new ConsoleIntegerFieldEditor(IDebugPreferenceConstants.CONSOLE_WIDTH, DebugPreferencesMessages.ConsolePreferencePage_Console_width, getFieldEditorParent());
addField(fWidthEditor);
fWidthEditor.setValidRange(80, 1000);
fWidthEditor.setErrorMessage(DebugPreferencesMessages.ConsolePreferencePage_console_width);
fWrapEditor.getChangeControl(getFieldEditorParent()).addSelectionListener(
new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
updateWidthEditor();
}
}
);
fUseBufferSize = new BooleanFieldEditor2(IDebugPreferenceConstants.CONSOLE_LIMIT_CONSOLE_OUTPUT, DebugPreferencesMessages.ConsolePreferencePage_Limit_console_output_1, SWT.NONE, getFieldEditorParent());
addField(fUseBufferSize);
fBufferSizeEditor = new ConsoleIntegerFieldEditor(IDebugPreferenceConstants.CONSOLE_LOW_WATER_MARK, DebugPreferencesMessages.ConsolePreferencePage_Console_buffer_size__characters___2, getFieldEditorParent());
addField(fBufferSizeEditor);
fBufferSizeEditor.setValidRange(1000, Integer.MAX_VALUE - 100000);
fBufferSizeEditor.setErrorMessage(MessageFormat.format(DebugPreferencesMessages.ConsolePreferencePage_The_console_buffer_size_must_be_at_least_1000_characters__1, Integer.valueOf(Integer.MAX_VALUE - 100000)));
fUseBufferSize.getChangeControl(getFieldEditorParent()).addSelectionListener(
new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
updateBufferSizeEditor();
}
}
);
fTabSizeEditor = new ConsoleIntegerFieldEditor(IDebugPreferenceConstants.CONSOLE_TAB_WIDTH, DebugPreferencesMessages.ConsolePreferencePage_12, getFieldEditorParent());
addField(fTabSizeEditor);
fTabSizeEditor.setValidRange(1,100);
fTabSizeEditor.setErrorMessage(DebugPreferencesMessages.ConsolePreferencePage_13);
addField(new BooleanFieldEditor(IDebugPreferenceConstants.CONSOLE_OPEN_ON_OUT, DebugPreferencesMessages.ConsolePreferencePage_Show__Console_View_when_there_is_program_output_3, SWT.NONE, getFieldEditorParent()));
addField(new BooleanFieldEditor(IDebugPreferenceConstants.CONSOLE_OPEN_ON_ERR, DebugPreferencesMessages.ConsolePreferencePage_Show__Console_View_when_there_is_program_error_3, SWT.NONE, getFieldEditorParent()));
ColorFieldEditor sysout= new ColorFieldEditor(IDebugPreferenceConstants.CONSOLE_SYS_OUT_COLOR, DebugPreferencesMessages.ConsolePreferencePage_Standard_Out__2, getFieldEditorParent());
ColorFieldEditor syserr= new ColorFieldEditor(IDebugPreferenceConstants.CONSOLE_SYS_ERR_COLOR, DebugPreferencesMessages.ConsolePreferencePage_Standard_Error__3, getFieldEditorParent());
ColorFieldEditor sysin= new ColorFieldEditor(IDebugPreferenceConstants.CONSOLE_SYS_IN_COLOR, DebugPreferencesMessages.ConsolePreferencePage_Standard_In__4, getFieldEditorParent());
ColorFieldEditor background= new ColorFieldEditor(IDebugPreferenceConstants.CONSOLE_BAKGROUND_COLOR, DebugPreferencesMessages.ConsolePreferencePage_11, getFieldEditorParent());
addField(sysout);
addField(syserr);
addField(sysin);
addField(background);
}
/**
* @see IWorkbenchPreferencePage#init(IWorkbench)
*/
@Override
public void init(IWorkbench workbench) {
}
/* (non-Javadoc)
* @see org.eclipse.jface.preference.IPreferencePage#performOk()
*/
@Override
public boolean performOk() {
boolean ok= super.performOk();
// update high water mark to be (about) 100 lines (100 * 80 chars) greater than low water mark
IPreferenceStore store = DebugUIPlugin.getDefault().getPreferenceStore();
int low = store.getInt(IDebugPreferenceConstants.CONSOLE_LOW_WATER_MARK);
int high = low + 8000;
store.setValue(IDebugPreferenceConstants.CONSOLE_HIGH_WATER_MARK, high);
return ok;
}
/**
* @see org.eclipse.jface.preference.FieldEditorPreferencePage#initialize()
*/
@Override
protected void initialize() {
super.initialize();
updateWidthEditor();
updateBufferSizeEditor();
}
/**
* Update enablement of width editor based on enablement of 'fixed width' editor.
*/
protected void updateWidthEditor() {
Button b = fWrapEditor.getChangeControl(getFieldEditorParent());
fWidthEditor.getTextControl(getFieldEditorParent()).setEnabled(b.getSelection());
fWidthEditor.getLabelControl(getFieldEditorParent()).setEnabled(b.getSelection());
}
/**
* Update enablement of buffer size editor based on enablement of 'limit
* console output' editor.
*/
protected void updateBufferSizeEditor() {
Button b = fUseBufferSize.getChangeControl(getFieldEditorParent());
fBufferSizeEditor.getTextControl(getFieldEditorParent()).setEnabled(b.getSelection());
fBufferSizeEditor.getLabelControl(getFieldEditorParent()).setEnabled(b.getSelection());
}
/**
* @see org.eclipse.jface.preference.PreferencePage#performDefaults()
*/
@Override
protected void performDefaults() {
super.performDefaults();
updateWidthEditor();
updateBufferSizeEditor();
}
protected boolean canClearErrorMessage() {
if (fWidthEditor.isValid() && fBufferSizeEditor.isValid()) {
return true;
}
return false;
}
/**
* @see org.eclipse.jface.util.IPropertyChangeListener#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)
*/
@Override
public void propertyChange(PropertyChangeEvent event) {
if (event.getProperty().equals(FieldEditor.IS_VALID)) {
boolean newValue = ((Boolean) event.getNewValue()).booleanValue();
// If the new value is true then we must check all field editors.
// If it is false, then the page is invalid in any case.
if (newValue) {
if (fWidthEditor != null && event.getSource() != fWidthEditor) {
fWidthEditor.refreshValidState();
}
if (fBufferSizeEditor != null && event.getSource() != fBufferSizeEditor) {
fBufferSizeEditor.refreshValidState();
}
checkState();
} else {
super.propertyChange(event);
}
} else {
super.propertyChange(event);
}
}
}