diff options
Diffstat (limited to 'plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.preferences/src/org/eclipse/papyrus/infra/gmfdiag/preferences/ui/AbstractGroup.java')
| -rw-r--r-- | plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.preferences/src/org/eclipse/papyrus/infra/gmfdiag/preferences/ui/AbstractGroup.java | 242 |
1 files changed, 69 insertions, 173 deletions
diff --git a/plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.preferences/src/org/eclipse/papyrus/infra/gmfdiag/preferences/ui/AbstractGroup.java b/plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.preferences/src/org/eclipse/papyrus/infra/gmfdiag/preferences/ui/AbstractGroup.java index 2704c6c91d1..b541cfaa027 100644 --- a/plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.preferences/src/org/eclipse/papyrus/infra/gmfdiag/preferences/ui/AbstractGroup.java +++ b/plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.preferences/src/org/eclipse/papyrus/infra/gmfdiag/preferences/ui/AbstractGroup.java @@ -1,173 +1,69 @@ -/*****************************************************************************
- * Copyright (c) 2009 CEA LIST.
- *
- *
- * 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:
- * Patrick Tessier (CEA LIST) Patrick.tessier@cea.fr
- * Thibault Landre (Atos Origin)
- *****************************************************************************/
-package org.eclipse.papyrus.infra.gmfdiag.preferences.ui;
-
-import java.util.HashSet;
-import java.util.Set;
-
-import org.eclipse.jface.dialogs.DialogPage;
-import org.eclipse.jface.preference.FieldEditor;
-import org.eclipse.jface.preference.IPreferenceStore;
-import org.eclipse.papyrus.infra.gmfdiag.common.preferences.PreferencesConstantsHelper;
-import org.eclipse.swt.SWT;
-import org.eclipse.swt.layout.GridLayout;
-import org.eclipse.swt.widgets.Composite;
-
-/**
- * The Class AbstractGroupComposite.
- */
-public abstract class AbstractGroup extends Composite {
-
- /** The key to find preference */
- private String key;
-
- /**
- * The fieldsEditor : a set that will contain all editor in the composite. It is in charge of
- * loading / storing / setting the preference store / loading default of all its contained field
- * editor
- */
- private Set<FieldEditor> fieldsEditor;
-
- /**
- * Gets the dialog page.
- *
- * @return the dialogPage
- */
- protected DialogPage getDialogPage() {
- return dialogPage;
- }
-
- /** The dialog page. */
- protected DialogPage dialogPage;
-
- /**
- * Gets the title.
- *
- * @return the title
- */
- public String getKey() {
- return key;
- }
-
- /**
- * Sets the title.
- *
- * @param title
- * the title to set
- */
- protected void setKey(String title) {
- this.key = title;
- }
-
- /**
- * Instantiates a new abstract group.
- *
- * @param parent
- * the parent of the composite
- * @param String
- * the title of the page
- * @param dialogPage
- * to set the page in field editor
- */
- public AbstractGroup(Composite parent, String key, DialogPage dialogPage) {
- super(parent, SWT.None);
- this.key = key;
- this.dialogPage = dialogPage;
- this.setLayout(new GridLayout());
- fieldsEditor = new HashSet<FieldEditor>();
- }
-
- /**
- * Get the specified preference type associated with this preference page.
- *
- * @param preferenceType
- * an int representing the preference type to retrieve. It must be a value defined in {@link PreferencesConstantsHelper}
- *
- * @return the preference constant used to store the given preference type.
- */
- protected String getPreferenceConstant(int preferenceType) {
- return PreferencesConstantsHelper.getElementConstant(key, preferenceType);
- }
-
- /**
- * Gets an encapsulated compo. This composite is used to contain a FieldEditor and to allow
- * developers to work with a FieldEditor like Composite element.
- *
- * @param parent
- * the parent
- *
- * @return the encapsulated compo
- */
- protected final Composite getEncapsulatedCompo(Composite parent) {
- Composite compo = new Composite(parent, SWT.NONE);
- compo.setLayout(new GridLayout());
- return compo;
- }
-
- /**
- * Register field editor. It will add the fieldEditor to a map that will be used to
- * store/load/loadDefault/set the PreferenceStore of contained fieldEditor
- *
- * @param fieldEditor
- * the fieldEditor to add.
- */
- protected void addFieldEditor(FieldEditor fieldEditor) {
- fieldsEditor.add(fieldEditor);
- }
-
- /**
- * Load preferences of all registered fieldEditors.
- *
- * @see org.eclipse.papyrus.infra.gmfdiag.preferences.ui.AbstractGroup#addFieldEditor(FieldEditor)
- */
- public void load() {
- for (FieldEditor fe : fieldsEditor) {
- fe.load();
- }
- }
-
- /**
- * Set the preference store of all registered fieldEditors.
- *
- * @see org.eclipse.papyrus.infra.gmfdiag.preferences.ui.AbstractGroup#addFieldEditor(FieldEditor)
- */
- public final void setPreferenceStore(IPreferenceStore store) {
- for (FieldEditor fe : fieldsEditor) {
- fe.setPreferenceStore(store);
- }
- }
-
- /**
- * Load default preferences of all registered fieldEditors.
- *
- * @see org.eclipse.papyrus.infra.gmfdiag.preferences.ui.AbstractGroup#addFieldEditor(FieldEditor)
- */
- public final void loadDefault() {
- for (FieldEditor fe : fieldsEditor) {
- fe.loadDefault();
- }
- }
-
- /**
- * Store preferences of the registered fieldEditors.
- *
- * @see org.eclipse.papyrus.infra.gmfdiag.preferences.ui.AbstractGroup#addFieldEditor(FieldEditor)
- */
- public final void storePreferences() {
- for (FieldEditor fe : fieldsEditor) {
- fe.store();
- }
- }
-
-}
+/***************************************************************************** + * Copyright (c) 2009, 2016 CEA LIST, Christian W. Damus, 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: + * Patrick Tessier (CEA LIST) Patrick.tessier@cea.fr + * Thibault Landre (Atos Origin) + * Christian W. Damus - bug 485220 + * + *****************************************************************************/ +package org.eclipse.papyrus.infra.gmfdiag.preferences.ui; + +import org.eclipse.jface.dialogs.DialogPage; +import org.eclipse.papyrus.infra.gmfdiag.common.preferences.PreferencesConstantsHelper; +import org.eclipse.papyrus.infra.ui.preferences.AbstractPreferenceGroup; +import org.eclipse.swt.widgets.Composite; + +/** + * The Class AbstractGroupComposite. + */ +public abstract class AbstractGroup extends AbstractPreferenceGroup { + + /** + * Instantiates a new abstract group. + * + * @param parent + * the parent of the composite + * @param String + * the title of the page + * @param dialogPage + * to set the page in field editor + */ + public AbstractGroup(Composite parent, String key, DialogPage dialogPage) { + super(parent, key, dialogPage); + } + + /** + * Get the specified preference type associated with this preference page. + * + * @param preferenceType + * an int representing the preference type to retrieve. It must be a value defined in {@link PreferencesConstantsHelper} + * + * @return the preference constant used to store the given preference type. + */ + protected String getPreferenceConstant(int preferenceType) { + return PreferencesConstantsHelper.getElementConstant(getKey(), preferenceType); + } + + /** + * Gets an encapsulated compo. This composite is used to contain a FieldEditor and to allow + * developers to work with a FieldEditor like Composite element. + * + * @param parent + * the parent + * + * @return the encapsulated compo + * + * @deprecated Use the {@link AbstractPreferenceGroup#getEncapsulatedComposite(Composite)} API, instead + */ + @Deprecated + protected final Composite getEncapsulatedCompo(Composite parent) { + return getEncapsulatedComposite(parent); + } + +} |