Java tutorial
/******************************************************************************* * All rights reserved. This program and the accompanying materials * Copyright (c) 2000, 2010 IBM Corporation and others. * 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 *******************************************************************************/ package org.eclipse.wst.jsdt.internal.ui.preferences; import java.util.ArrayList; import java.util.Iterator; import java.util.List; import java.util.StringTokenizer; import org.eclipse.jface.dialogs.Dialog; import org.eclipse.jface.preference.IPreferenceStore; import org.eclipse.jface.preference.PreferencePage; import org.eclipse.jface.resource.ImageDescriptor; import org.eclipse.jface.viewers.LabelProvider; import org.eclipse.swt.SWT; import org.eclipse.swt.graphics.Image; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.ui.IWorkbench; import org.eclipse.ui.IWorkbenchPreferencePage; import org.eclipse.ui.PlatformUI; import org.eclipse.wst.jsdt.core.Flags; import org.eclipse.wst.jsdt.internal.ui.IJavaHelpContextIds; import org.eclipse.wst.jsdt.internal.ui.JavaScriptPlugin; import org.eclipse.wst.jsdt.internal.ui.viewsupport.ImageDescriptorRegistry; import org.eclipse.wst.jsdt.internal.ui.viewsupport.JavaElementImageProvider; import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.DialogField; import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.IDialogFieldListener; import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.ListDialogField; import org.eclipse.wst.jsdt.internal.ui.wizards.dialogfields.SelectionButtonDialogField; import org.eclipse.wst.jsdt.ui.JavaScriptElementImageDescriptor; import org.eclipse.wst.jsdt.ui.PreferenceConstants; public class MembersOrderPreferencePage extends PreferencePage implements IWorkbenchPreferencePage { public static final String PREF_ID = "org.eclipse.wst.jsdt.ui.preferences.MembersOrderPreferencePage"; //$NON-NLS-1$ // private static final String ALL_SORTMEMBER_ENTRIES= "T,SI,SF,SM,I,F,C,M"; //$NON-NLS-1$ private static final String ALL_SORTMEMBER_ENTRIES = "T,I,F,C,M"; //$NON-NLS-1$ private static final String ALL_VISIBILITY_ENTRIES = "B,V,R,D"; //$NON-NLS-1$ private static final String PREF_OUTLINE_SORT_OPTION = PreferenceConstants.APPEARANCE_MEMBER_SORT_ORDER; private static final String PREF_VISIBILITY_SORT_OPTION = PreferenceConstants.APPEARANCE_VISIBILITY_SORT_ORDER; private static final String PREF_USE_VISIBILITY_SORT_OPTION = PreferenceConstants.APPEARANCE_ENABLE_VISIBILITY_SORT_ORDER; public static final String CONSTRUCTORS = "C"; //$NON-NLS-1$ // public static final String FIELDS= "F"; //$NON-NLS-1$ public static final String VARS = "F"; //$NON-NLS-1$ public static final String METHODS = "M"; //$NON-NLS-1$ // public static final String STATIC_METHODS= "SM"; //$NON-NLS-1$ // public static final String STATIC_FIELDS= "SF"; //$NON-NLS-1$ public static final String INIT = "I"; //$NON-NLS-1$ // public static final String STATIC_INIT= "SI"; //$NON-NLS-1$ public static final String TYPES = "T"; //$NON-NLS-1$ public static final String PUBLIC = "B"; //$NON-NLS-1$ public static final String PRIVATE = "V"; //$NON-NLS-1$ public static final String PROTECTED = "R"; //$NON-NLS-1$ public static final String DEFAULT = "D"; //$NON-NLS-1$ private boolean fUseVisibilitySort; private ListDialogField fSortOrderList; private ListDialogField fVisibilityOrderList; private SelectionButtonDialogField fUseVisibilitySortField; private static boolean isValidEntries(List entries, String entryString) { StringTokenizer tokenizer = new StringTokenizer(entryString, ","); //$NON-NLS-1$ int i = 0; for (; tokenizer.hasMoreTokens(); i++) { String token = tokenizer.nextToken(); if (!entries.contains(token)) return false; } return i == entries.size(); } public MembersOrderPreferencePage() { //set the preference store setPreferenceStore(JavaScriptPlugin.getDefault().getPreferenceStore()); setDescription(PreferencesMessages.MembersOrderPreferencePage_label_description); // String memberSortString= getPreferenceStore().getString(PREF_OUTLINE_SORT_OPTION); String memberSortString = ALL_SORTMEMBER_ENTRIES; String upLabel = PreferencesMessages.MembersOrderPreferencePage_category_button_up; String downLabel = PreferencesMessages.MembersOrderPreferencePage_category_button_down; // category sort fSortOrderList = new ListDialogField(null, new String[] { upLabel, downLabel }, new MemberSortLabelProvider()); fSortOrderList.setDownButtonIndex(1); fSortOrderList.setUpButtonIndex(0); //validate entries stored in store, false get defaults List entries = parseList(memberSortString); if (!isValidEntries(entries, ALL_SORTMEMBER_ENTRIES)) { memberSortString = getPreferenceStore().getDefaultString(PREF_OUTLINE_SORT_OPTION); entries = parseList(memberSortString); } fSortOrderList.setElements(entries); // visibility sort fUseVisibilitySort = getPreferenceStore().getBoolean(PREF_USE_VISIBILITY_SORT_OPTION); String visibilitySortString = getPreferenceStore().getString(PREF_VISIBILITY_SORT_OPTION); upLabel = PreferencesMessages.MembersOrderPreferencePage_visibility_button_up; downLabel = PreferencesMessages.MembersOrderPreferencePage_visibility_button_down; fVisibilityOrderList = new ListDialogField(null, new String[] { upLabel, downLabel }, new VisibilitySortLabelProvider()); fVisibilityOrderList.setDownButtonIndex(1); fVisibilityOrderList.setUpButtonIndex(0); //validate entries stored in store, false get defaults entries = parseList(visibilitySortString); if (!isValidEntries(entries, ALL_VISIBILITY_ENTRIES)) { visibilitySortString = getPreferenceStore().getDefaultString(PREF_VISIBILITY_SORT_OPTION); entries = parseList(visibilitySortString); } fVisibilityOrderList.setElements(entries); } private static List parseList(String string) { StringTokenizer tokenizer = new StringTokenizer(string, ","); //$NON-NLS-1$ List entries = new ArrayList(); for (int i = 0; tokenizer.hasMoreTokens(); i++) { String token = tokenizer.nextToken(); entries.add(token); } return entries; } /* * @see PreferencePage#createControl(Composite) */ public void createControl(Composite parent) { super.createControl(parent); PlatformUI.getWorkbench().getHelpSystem().setHelp(getControl(), IJavaHelpContextIds.SORT_ORDER_PREFERENCE_PAGE); } /* * @see org.eclipse.jface.preference.PreferencePage#createContents(Composite) */ protected Control createContents(Composite parent) { // Create both the dialog lists Composite sortComposite = new Composite(parent, SWT.NONE); sortComposite.setFont(parent.getFont()); GridLayout layout = new GridLayout(); layout.numColumns = 2; layout.marginWidth = 0; layout.marginHeight = 0; sortComposite.setLayout(layout); GridData gd = new GridData(); gd.verticalAlignment = GridData.FILL; gd.horizontalAlignment = GridData.FILL_HORIZONTAL; sortComposite.setLayoutData(gd); createListDialogField(sortComposite, fSortOrderList); fUseVisibilitySortField = new SelectionButtonDialogField(SWT.CHECK); fUseVisibilitySortField.setDialogFieldListener(new IDialogFieldListener() { public void dialogFieldChanged(DialogField field) { fVisibilityOrderList.setEnabled(fUseVisibilitySortField.isSelected()); } }); fUseVisibilitySortField .setLabelText(PreferencesMessages.MembersOrderPreferencePage_usevisibilitysort_label); fUseVisibilitySortField.doFillIntoGrid(sortComposite, 2); fUseVisibilitySortField.setSelection(fUseVisibilitySort); createListDialogField(sortComposite, fVisibilityOrderList); fVisibilityOrderList.setEnabled(fUseVisibilitySortField.isSelected()); Dialog.applyDialogFont(sortComposite); // XXX: workaround until implemented fUseVisibilitySortField.setEnabled(false); fVisibilityOrderList.setEnabled(false); return sortComposite; } private void createListDialogField(Composite composite, ListDialogField dialogField) { Control list = dialogField.getListControl(composite); GridData gd = new GridData(); gd.horizontalAlignment = GridData.FILL; gd.grabExcessHorizontalSpace = true; gd.verticalAlignment = GridData.FILL; gd.grabExcessVerticalSpace = true; gd.widthHint = convertWidthInCharsToPixels(50); list.setLayoutData(gd); Composite buttons = dialogField.getButtonBox(composite); gd = new GridData(); gd.horizontalAlignment = GridData.FILL; gd.grabExcessHorizontalSpace = false; gd.verticalAlignment = GridData.FILL; gd.grabExcessVerticalSpace = true; buttons.setLayoutData(gd); } /* * @see org.eclipse.ui.IWorkbenchPreferencePage#init(IWorkbench) */ public void init(IWorkbench workbench) { } /* * @see org.eclipse.jface.preference.PreferencePage#performDefaults() */ protected void performDefaults() { IPreferenceStore prefs = JavaScriptPlugin.getDefault().getPreferenceStore(); String str = prefs.getDefaultString(PREF_OUTLINE_SORT_OPTION); if (str != null) fSortOrderList.setElements(parseList(str)); else fSortOrderList.setElements(parseList(ALL_SORTMEMBER_ENTRIES)); str = prefs.getDefaultString(PREF_VISIBILITY_SORT_OPTION); if (str != null) fVisibilityOrderList.setElements(parseList(str)); else fVisibilityOrderList.setElements(parseList(ALL_VISIBILITY_ENTRIES)); fUseVisibilitySortField.setSelection(prefs.getDefaultBoolean(PREF_USE_VISIBILITY_SORT_OPTION)); super.performDefaults(); } /* * @see org.eclipse.jface.preference.IPreferencePage#performOk() */ //reorders elements in the Outline based on selection public boolean performOk() { //save preferences for both dialog lists IPreferenceStore store = getPreferenceStore(); updateList(store, fSortOrderList, PREF_OUTLINE_SORT_OPTION); updateList(store, fVisibilityOrderList, PREF_VISIBILITY_SORT_OPTION); //update the button setting store.setValue(PREF_USE_VISIBILITY_SORT_OPTION, fUseVisibilitySortField.isSelected()); JavaScriptPlugin.getDefault().savePluginPreferences(); return true; } private void updateList(IPreferenceStore store, ListDialogField list, String str) { StringBuffer buf = new StringBuffer(); List curr = list.getElements(); for (Iterator iter = curr.iterator(); iter.hasNext();) { String s = (String) iter.next(); buf.append(s); buf.append(','); } store.setValue(str, buf.toString()); } private class MemberSortLabelProvider extends LabelProvider { public MemberSortLabelProvider() { } /* * @see org.eclipse.jface.viewers.ILabelProvider#getImage(Object) */ public Image getImage(Object element) { //access to image registry ImageDescriptorRegistry registry = JavaScriptPlugin.getImageDescriptorRegistry(); ImageDescriptor descriptor = null; if (element instanceof String) { int visibility = Flags.AccPublic; String s = (String) element; // if (s.equals(FIELDS)) { if (s.equals(VARS)) { //0 will give the default field image descriptor = JavaElementImageProvider.getFieldImageDescriptor(false, visibility); } else if (s.equals(CONSTRUCTORS)) { descriptor = JavaElementImageProvider.getMethodImageDescriptor(false, visibility); //add a constructor adornment to the image descriptor descriptor = new JavaScriptElementImageDescriptor(descriptor, JavaScriptElementImageDescriptor.CONSTRUCTOR, JavaElementImageProvider.SMALL_SIZE); } else if (s.equals(METHODS)) { descriptor = JavaElementImageProvider.getMethodImageDescriptor(false, visibility); // } else if (s.equals(STATIC_FIELDS)) { // descriptor= JavaElementImageProvider.getFieldImageDescriptor(false, visibility); //add a static fields adornment to the image descriptor // descriptor= new JavaScriptElementImageDescriptor(descriptor, JavaScriptElementImageDescriptor.STATIC, JavaElementImageProvider.SMALL_SIZE); // } else if (s.equals(STATIC_METHODS)) { // descriptor= JavaElementImageProvider.getMethodImageDescriptor(false, visibility); //add a static methods adornment to the image descriptor // descriptor= new JavaScriptElementImageDescriptor(descriptor, JavaScriptElementImageDescriptor.STATIC, JavaElementImageProvider.SMALL_SIZE); } else if (s.equals(INIT)) { descriptor = JavaElementImageProvider.getMethodImageDescriptor(false, visibility); // } else if (s.equals(STATIC_INIT)) { // descriptor= JavaElementImageProvider.getMethodImageDescriptor(false, visibility); // descriptor= new JavaScriptElementImageDescriptor(descriptor, JavaScriptElementImageDescriptor.STATIC, JavaElementImageProvider.SMALL_SIZE); } else if (s.equals(TYPES)) { descriptor = JavaElementImageProvider.getTypeImageDescriptor(true, false, Flags.AccPublic, false); } else { descriptor = JavaElementImageProvider.getMethodImageDescriptor(false, Flags.AccPublic); } return registry.get(descriptor); } return null; } /* * @see org.eclipse.jface.viewers.ILabelProvider#getText(Object) */ public String getText(Object element) { if (element instanceof String) { String s = (String) element; // if (s.equals(FIELDS)) { if (s.equals(VARS)) { // return PreferencesMessages.MembersOrderPreferencePage_fields_label; return PreferencesMessages.MembersOrderPreferencePage_vars_label; } else if (s.equals(METHODS)) { return PreferencesMessages.MembersOrderPreferencePage_methods_label; // } else if (s.equals(STATIC_FIELDS)) { // return PreferencesMessages.MembersOrderPreferencePage_staticfields_label; // } else if (s.equals(STATIC_METHODS)) { // return PreferencesMessages.MembersOrderPreferencePage_staticmethods_label; } else if (s.equals(CONSTRUCTORS)) { return PreferencesMessages.MembersOrderPreferencePage_constructors_label; } else if (s.equals(INIT)) { return PreferencesMessages.MembersOrderPreferencePage_initialisers_label; // } else if (s.equals(STATIC_INIT)) { // return PreferencesMessages.MembersOrderPreferencePage_staticinitialisers_label; } else if (s.equals(TYPES)) { return PreferencesMessages.MembersOrderPreferencePage_types_label; } } return ""; //$NON-NLS-1$ } } private class VisibilitySortLabelProvider extends LabelProvider { public VisibilitySortLabelProvider() { } /* * @see org.eclipse.jface.viewers.ILabelProvider#getImage(Object) */ public Image getImage(Object element) { //access to image registry ImageDescriptorRegistry registry = JavaScriptPlugin.getImageDescriptorRegistry(); ImageDescriptor descriptor = null; if (element instanceof String) { String s = (String) element; if (s.equals(PUBLIC)) { descriptor = JavaElementImageProvider.getMethodImageDescriptor(false, Flags.AccPublic); } else if (s.equals(PROTECTED)) { descriptor = JavaElementImageProvider.getMethodImageDescriptor(false, Flags.AccProtected); } else if (s.equals(PRIVATE)) { descriptor = JavaElementImageProvider.getMethodImageDescriptor(false, Flags.AccPrivate); } else if (s.equals(DEFAULT)) { descriptor = JavaElementImageProvider.getMethodImageDescriptor(false, Flags.AccDefault); } return registry.get(descriptor); } return null; } /* * @see org.eclipse.jface.viewers.ILabelProvider#getText(Object) */ public String getText(Object element) { if (element instanceof String) { String s = (String) element; if (s.equals(PUBLIC)) { return PreferencesMessages.MembersOrderPreferencePage_public_label; } else if (s.equals(PRIVATE)) { return PreferencesMessages.MembersOrderPreferencePage_private_label; } else if (s.equals(PROTECTED)) { return PreferencesMessages.MembersOrderPreferencePage_protected_label; } else if (s.equals(DEFAULT)) { return PreferencesMessages.MembersOrderPreferencePage_default_label; } } return ""; //$NON-NLS-1$ } } }