Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.preference
Class RadioGroupFieldEditor

java.lang.Object
  extended by 

org.eclipse.jface.preference.FieldEditor
      extended by 
org.eclipse.jface.preference.RadioGroupFieldEditor

public class RadioGroupFieldEditor
extends FieldEditor

A field editor for an enumeration type preference. The choices are presented as a list of radio buttons.


Field Summary
 
Fields inherited from class org.eclipse.jface.preference. FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
 
Constructor Summary
protected RadioGroupFieldEditor ()
          Creates a new radio group field editor
  RadioGroupFieldEditor ( String name, String labelText, int numColumns, String[][] labelAndValues, Composite parent)
          Creates a radio group field editor.
  RadioGroupFieldEditor ( String name, String labelText, int numColumns, String[][] labelAndValues, Composite parent, boolean useGroup)
          Creates a radio group field editor.
 
Method Summary
protected  void adjustForNumColumns (int numColumns)
          Adjusts the horizontal span of this field editor's basic controls.
protected  void doFillIntoGrid ( 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.
  Composite getRadioBoxControl ( Composite parent)
          Returns this field editor's radio group control.
 void setEnabled (boolean enabled, Composite parent)
          Set whether or not the controls in the field editor are enabled.
 void setIndent (int indent)
          Sets the indent used for the first column of the radion button matrix.
 
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
 

Constructor Detail

RadioGroupFieldEditor

protected RadioGroupFieldEditor()
Creates a new radio group field editor


RadioGroupFieldEditor

public RadioGroupFieldEditor(
String name,
                             
String labelText,
                             int numColumns,
                             
String[][] labelAndValues,
                             
Composite parent)
Creates a radio group field editor. This constructor does not use a Group to contain the radio buttons. It is equivalent to using the following constructor with false for the useGroup argument.

Example usage:

                RadioGroupFieldEditor editor= new RadioGroupFieldEditor(
                        "GeneralPage.DoubleClick", resName, 1,
                        new String[][] {
                                {"Open Browser", "open"},
                                {"Expand Tree", "expand"}
                        },
          parent);      
 

Parameters:
name - the name of the preference this field editor works on
labelText - the label text of the field editor
numColumns - the number of columns for the radio button presentation
labelAndValues - list of radio button [label, value] entries; the value is returned when the radio button is selected
parent - the parent of the field editor's control

RadioGroupFieldEditor

public RadioGroupFieldEditor(
String name,
                             
String labelText,
                             int numColumns,
                             
String[][] labelAndValues,
                             
Composite parent,
                             boolean useGroup)
Creates a radio group field editor.

Example usage:

                RadioGroupFieldEditor editor= new RadioGroupFieldEditor(
                        "GeneralPage.DoubleClick", resName, 1,
                        new String[][] {
                                {"Open Browser", "open"},
                                {"Expand Tree", "expand"}
                        },
          parent,
          true);        
 

Parameters:
name - the name of the preference this field editor works on
labelText - the label text of the field editor
numColumns - the number of columns for the radio button presentation
labelAndValues - list of radio button [label, value] entries; the value is returned when the radio button is selected
parent - the parent of the field editor's control
useGroup - whether to use a Group control to contain the radio buttons
Method Detail

adjustForNumColumns

protected void adjustForNumColumns(int numColumns)
Description copied from class: 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 FieldEditor
Parameters:
numColumns - the number of columns

doFillIntoGrid

protected void doFillIntoGrid(
Composite parent,
                              int numColumns)
Description copied from class: 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 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: 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 FieldEditor

doLoadDefault

protected void doLoadDefault()
Description copied from class: 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 FieldEditor

doStore

protected void doStore()
Description copied from class: 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 FieldEditor

getNumberOfControls

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

Specified by:
getNumberOfControls in class FieldEditor
Returns:
the number of controls

getRadioBoxControl

public 
Composite getRadioBoxControl(
Composite parent)
Returns this field editor's radio group control.

Parameters:
parent - The parent to create the radioBox in
Returns:
the radio group control

setIndent

public void setIndent(int indent)
Sets the indent used for the first column of the radion button matrix.

Parameters:
indent - the indent (in pixels)

setEnabled

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

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

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire