org.eclipse.xtext.ui.editor.preferences.fields
Class CheckBoxGroupFieldEditor

java.lang.Object
  extended by org.eclipse.jface.preference.FieldEditor
      extended by org.eclipse.xtext.ui.editor.preferences.fields.CheckBoxGroupFieldEditor

public abstract class CheckBoxGroupFieldEditor
extends org.eclipse.jface.preference.FieldEditor

Author:
Dennis Hübner - Initial contribution and API

Field Summary
protected  java.lang.String result
           
 
Fields inherited from class org.eclipse.jface.preference.FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
 
Constructor Summary
CheckBoxGroupFieldEditor(java.lang.String name, java.lang.String labeltext, int numColumns, java.lang.String[][] labelsAndValues, org.eclipse.swt.widgets.Composite fieldEditorParent, boolean useGroup)
           
 
Method Summary
protected  void adjustForNumColumns(int numColumns)
          Adjusts the horizontal span of this field editor's basic controls.
protected abstract  java.lang.String calculateResult(java.lang.String[][] settings)
           
protected  void doFillIntoGrid(org.eclipse.swt.widgets.Composite parent, int numColumns)
          Fills this field editor's basic controls into the given parent.
protected  void doLoad()
          Initializes this field editor with the preference value from the preference store.
protected  void doLoadDefault()
          Initializes this field editor with the default preference value from the preference store.
protected  void doStore()
          Stores the preference value from this field editor into the preference store.
 int getNumberOfControls()
          Returns the number of basic controls this field editor consists of.
protected abstract  boolean isSelected(java.lang.String fieldName, java.lang.String valueToSet)
           
 void setEnabled(boolean enabled, org.eclipse.swt.widgets.Composite parent)
          Set whether or not the controls in the field editor are enabled.
 
Methods inherited from class org.eclipse.jface.preference.FieldEditor
applyFont, checkParent, clearErrorMessage, clearMessage, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, createControl, dispose, fillIntoGrid, fireStateChanged, fireValueChanged, getFieldEditorFontName, getLabelControl, getLabelControl, getLabelText, getPage, getPreferenceName, getPreferencePage, getPreferenceStore, init, isValid, load, loadDefault, presentsDefaultValue, refreshValidState, setButtonLayoutData, setFocus, setLabelText, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

result

protected java.lang.String result
Constructor Detail

CheckBoxGroupFieldEditor

public CheckBoxGroupFieldEditor(java.lang.String name,
                                java.lang.String labeltext,
                                int numColumns,
                                java.lang.String[][] labelsAndValues,
                                org.eclipse.swt.widgets.Composite fieldEditorParent,
                                boolean useGroup)
Method Detail

calculateResult

protected abstract java.lang.String calculateResult(java.lang.String[][] settings)
Parameters:
settings - String[][fieldName,fieldValue,isChecked]
Returns:
value as String

adjustForNumColumns

protected void adjustForNumColumns(int numColumns)
Description copied from class: org.eclipse.jface.preference.FieldEditor
Adjusts the horizontal span of this field editor's basic controls.

Subclasses must implement this method to adjust the horizontal span of controls so they appear correct in the given number of columns.

The number of columns will always be equal to or greater than the value returned by this editor's getNumberOfControls method.

Specified by:
adjustForNumColumns in class org.eclipse.jface.preference.FieldEditor
Parameters:
numColumns - the number of columns

doFillIntoGrid

protected void doFillIntoGrid(org.eclipse.swt.widgets.Composite parent,
                              int numColumns)
Description copied from class: org.eclipse.jface.preference.FieldEditor
Fills this field editor's basic controls into the given parent.

Subclasses must implement this method to create the controls for this field editor.

Note this method may be called by the constructor, so it must not access fields on the receiver object because they will not be fully initialized.

Specified by:
doFillIntoGrid in class org.eclipse.jface.preference.FieldEditor
Parameters:
parent - the composite used as a parent for the basic controls; the parent's layout must be a GridLayout
numColumns - the number of columns

doLoad

protected void doLoad()
Description copied from class: org.eclipse.jface.preference.FieldEditor
Initializes this field editor with the preference value from the preference store.

Subclasses must implement this method to properly initialize the field editor.

Specified by:
doLoad in class org.eclipse.jface.preference.FieldEditor

doLoadDefault

protected void doLoadDefault()
Description copied from class: org.eclipse.jface.preference.FieldEditor
Initializes this field editor with the default preference value from the preference store.

Subclasses must implement this method to properly initialize the field editor.

Specified by:
doLoadDefault in class org.eclipse.jface.preference.FieldEditor

doStore

protected void doStore()
Description copied from class: org.eclipse.jface.preference.FieldEditor
Stores the preference value from this field editor into the preference store.

Subclasses must implement this method to save the entered value into the preference store.

Specified by:
doStore in class org.eclipse.jface.preference.FieldEditor

getNumberOfControls

public int getNumberOfControls()
Description copied from class: org.eclipse.jface.preference.FieldEditor
Returns the number of basic controls this field editor consists of.

Specified by:
getNumberOfControls in class org.eclipse.jface.preference.FieldEditor
Returns:
the number of controls

setEnabled

public void setEnabled(boolean enabled,
                       org.eclipse.swt.widgets.Composite parent)
Description copied from class: org.eclipse.jface.preference.FieldEditor
Set whether or not the controls in the field editor are enabled.

Overrides:
setEnabled in class org.eclipse.jface.preference.FieldEditor
Parameters:
enabled - The enabled state.
parent - The parent of the controls in the group. Used to create the controls if required.

isSelected

protected abstract boolean isSelected(java.lang.String fieldName,
                                      java.lang.String valueToSet)