org.eclipse.xtext.builder.preferences
Class BuilderPreferencePage

java.lang.Object
  org.eclipse.jface.dialogs.DialogPage
      org.eclipse.jface.preference.PreferencePage
          org.eclipse.xtext.builder.preferences.PropertyAndPreferencePage
              org.eclipse.xtext.builder.preferences.BuilderPreferencePage

All Implemented Interfaces:

org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.preference.IPreferencePage, org.eclipse.ui.IWorkbenchPreferencePage, org.eclipse.ui.IWorkbenchPropertyPage

public class BuilderPreferencePage
extends PropertyAndPreferencePage

Since:

2.1

Author:

Michael Clay - Initial contribution and API

Field Summary

Fields inherited from class org.eclipse.xtext.builder.preferences.PropertyAndPreferencePage

DATA_NO_LINK

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

BuilderPreferencePage()

Method Summary

void	createControl(org.eclipse.swt.widgets.Composite parent) The PreferencePage implementation of this IDialogPage method creates a description label and button bar for the page.
protected org.eclipse.swt.widgets.Control	createPreferenceContent(org.eclipse.swt.widgets.Composite composite, org.eclipse.jface.preference.IPreferencePageContainer preferencePageContainer)
void	dispose() The DialogPage implementation of this IDialogPage method disposes of the page image if it has one.
protected void	enableProjectSpecificSettings(boolean useProjectSpecificSettings)
protected java.lang.String	getPreferencePageID()
protected java.lang.String	getPropertyPageID()
protected boolean	hasProjectSpecificOptions(org.eclipse.core.resources.IProject project)
void	performApply() Performs special processing when this page's Apply button has been pressed.
protected void	performDefaults() Performs special processing when this page's Defaults button has been pressed.
boolean	performOk() Notifies that the OK button of this page's container has been pressed.
void	setCleanerProvider(com.google.inject.Provider<DerivedResourceCleanerJob> cleanerProvider)
void	setConfigurationProvider(EclipseOutputConfigurationProvider configurationProvider)
void	setElement(org.eclipse.core.runtime.IAdaptable element) Sets the object that owns the properties shown in this page.
void	setLanguageName(java.lang.String languageName)
void	setPreferenceStoreAccessImpl(PreferenceStoreAccessImpl preferenceStoreAccessImpl)

Methods inherited from class org.eclipse.xtext.builder.preferences.PropertyAndPreferencePage

applyData, createContents, createDescriptionLabel, doStatusChanged, enablePreferenceContent, getData, getElement, getNewStatusChangedListener, getPreferenceContentStatus, getProject, getWorkingCopyManager, init, isProjectPreferencePage, offerLink, openProjectProperties, openWorkspacePreferences, setPreferenceContentStatus, supportsProjectSpecificOptions, useProjectSettings

Methods inherited from class org.eclipse.jface.preference.PreferencePage

applyDialogFont, computeSize, contributeButtons, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, okToLeave, performCancel, performHelp, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton

Methods inherited from class org.eclipse.jface.dialogs.DialogPage

convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setMessage, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jface.preference.IPreferencePage

computeSize, isValid, okToLeave, performCancel, setContainer, setSize

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible

Constructor Detail

BuilderPreferencePage

public BuilderPreferencePage()

Method Detail

setCleanerProvider

@Inject
public void setCleanerProvider(com.google.inject.Provider<DerivedResourceCleanerJob> cleanerProvider)

setLanguageName

@Inject
public void setLanguageName(java.lang.String languageName)

setConfigurationProvider

@Inject
public void setConfigurationProvider(EclipseOutputConfigurationProvider configurationProvider)

setPreferenceStoreAccessImpl

@Inject
public void setPreferenceStoreAccessImpl(PreferenceStoreAccessImpl preferenceStoreAccessImpl)

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)

Description copied from class: org.eclipse.jface.preference.PreferencePage

The PreferencePage implementation of this IDialogPage method creates a description label and button bar for the page. It calls createContents to create the custom contents of the page.

If a subclass that overrides this method creates a Composite that has a layout with default margins (for example, a GridLayout) it is expected to set the margins of this Layout to 0 pixels.

Specified by:

createControl in interface org.eclipse.jface.dialogs.IDialogPage

Overrides:

createControl in class org.eclipse.jface.preference.PreferencePage

Parameters:

parent - the parent composite

See Also:

IDialogPage.createControl(Composite)

createPreferenceContent

protected org.eclipse.swt.widgets.Control createPreferenceContent(org.eclipse.swt.widgets.Composite composite,
                                                                  org.eclipse.jface.preference.IPreferencePageContainer preferencePageContainer)

Specified by:

createPreferenceContent in class PropertyAndPreferencePage

hasProjectSpecificOptions

protected boolean hasProjectSpecificOptions(org.eclipse.core.resources.IProject project)

Specified by:

hasProjectSpecificOptions in class PropertyAndPreferencePage

getPreferencePageID

protected java.lang.String getPreferencePageID()

Specified by:

getPreferencePageID in class PropertyAndPreferencePage

getPropertyPageID

protected java.lang.String getPropertyPageID()

Specified by:

getPropertyPageID in class PropertyAndPreferencePage

dispose

public void dispose()

Description copied from class: org.eclipse.jface.dialogs.DialogPage

The DialogPage implementation of this IDialogPage method disposes of the page image if it has one. Subclasses may extend.

Specified by:

dispose in interface org.eclipse.jface.dialogs.IDialogPage

Overrides:

dispose in class org.eclipse.jface.dialogs.DialogPage

enableProjectSpecificSettings

protected void enableProjectSpecificSettings(boolean useProjectSpecificSettings)

Overrides:

enableProjectSpecificSettings in class PropertyAndPreferencePage

performDefaults

protected void performDefaults()

Description copied from class: org.eclipse.jface.preference.PreferencePage

Performs special processing when this page's Defaults button has been pressed.

This is a framework hook method for subclasses to do special things when the Defaults button has been pressed. Subclasses may override, but should call super.performDefaults.

Overrides:

performDefaults in class PropertyAndPreferencePage

performOk

public boolean performOk()

Description copied from interface: org.eclipse.jface.preference.IPreferencePage

Notifies that the OK button of this page's container has been pressed.

Specified by:

performOk in interface org.eclipse.jface.preference.IPreferencePage

Overrides:

performOk in class org.eclipse.jface.preference.PreferencePage

Returns:

false to abort the container's OK processing and true to allow the OK to happen

performApply

public void performApply()

Description copied from class: org.eclipse.jface.preference.PreferencePage

Performs special processing when this page's Apply button has been pressed.

This is a framework hook method for sublcasses to do special things when the Apply button has been pressed. The default implementation of this framework method simply calls performOk to simulate the pressing of the page's OK button.

Overrides:

performApply in class org.eclipse.jface.preference.PreferencePage

See Also:

PreferencePage.performOk()

setElement

public void setElement(org.eclipse.core.runtime.IAdaptable element)

Description copied from interface: org.eclipse.ui.IWorkbenchPropertyPage

Sets the object that owns the properties shown in this page. The page is expected to store this object and provide it if getElement is called.

As of Eclipse 3.2 the org.eclipse.ui.propertyPages extension point now supports non IAdaptable inputs. An input that is not an IAdaptable will be wrapped in an IAdaptable by the workbench before it is forwarded to this method.

Specified by:

setElement in interface org.eclipse.ui.IWorkbenchPropertyPage

Overrides:

setElement in class PropertyAndPreferencePage

Parameters:

element - the object that owns the properties shown in this page

See Also:

PropertyDialogAction