/*******************************************************************************
* Copyright (c) 2006 Business Objects Software Limited and others.
* All rights reserved.
* This file is 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:
* Business Objects Software Limited - initial API and implementation based on Eclipse 3.1.2 code for
* /org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/preferences/IPreferenceConfigurationBlock.java
* Eclipse source is available at: http://www.eclipse.org/downloads/
*******************************************************************************/
/*
* IPreferenceConfigurationBlock.java
* Creation date: Feb 14, 2006.
* By: Edward Lam
*/
package org.openquark.cal.eclipse.ui.preferences;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
/**
* Interface for preference configuration blocks which can either be wrapped by a
* {@link org.openquark.cal.eclipse.ui.preferences.AbstractConfigurationBlockPreferencePage}
* or be included some preference page.
* <p>
* Clients may implement this interface.
* </p>
*
* @author Edward Lam
*/
public interface IPreferenceConfigurationBlock {
/**
* Creates the preference control.
*
* @param parent the parent composite to which to add the preferences control
* @return the control that was added to <code>parent</code>
*/
Control createControl(Composite parent);
/**
* Called after creating the control. Implementations should load the
* preferences values and update the controls accordingly.
*/
void initialize();
/**
* Called when the <code>OK</code> button is pressed on the preference
* page. Implementations should commit the configured preference settings
* into their form of preference storage.
*/
void performOk();
/**
* Called when the <code>Defaults</code> button is pressed on the
* preference page. Implementation should reset any preference settings to
* their default values and adjust the controls accordingly.
*/
void performDefaults();
/**
* Called when the preference page is being disposed. Implementations should
* free any resources they are holding on to.
*/
void dispose();
}