/*******************************************************************************
* Copyright (c) 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
* Zend Technologies
*******************************************************************************/
package org.eclipse.php.ui.folding;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
/**
* Contributors to the <code>org.eclipse.php.ui.foldingStructureProvider</code>
* extension point can specify an implementation of this interface to be
* displayed on the PHP > Editor > Folding preference page.
* <p>
* Clients may implement this interface.
* </p>
*
* @since 3.1
*/
public interface IPHPFoldingPreferenceBlock {
/**
* Creates the control that will be displayed on the PHP > Editor >
* Folding preference page.
*
* @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();
}