org.eclipse.jdt.ui/ui/org/eclipse/jdt/ui/wizards/NewClassWizardPage.java - jdt/eclipse.jdt.ui - Gitiles

 /*******************************************************************************
  * Copyright (c) 2000, 2021 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
  *     IBM Corporation - initial API and implementation
  *     Philippe Marschall <philippe.marschall@netcetera.ch> -  [type wizards] generate main method stub ignores generate comments setting - https://bugs.eclipse.org/387536
  *******************************************************************************/
 package org.eclipse.jdt.ui.wizards;

 import org.eclipse.swt.SWT;
 import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Control;

 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.SubProgressMonitor;

 import org.eclipse.jface.dialogs.Dialog;
 import org.eclipse.jface.dialogs.IDialogSettings;
 import org.eclipse.jface.viewers.IStructuredSelection;

 import org.eclipse.ui.PlatformUI;

 import org.eclipse.jdt.core.IJavaElement;
 import org.eclipse.jdt.core.IType;

 import org.eclipse.jdt.internal.ui.IJavaHelpContextIds;
 import org.eclipse.jdt.internal.ui.wizards.NewWizardMessages;
 import org.eclipse.jdt.internal.ui.wizards.dialogfields.DialogField;
 import org.eclipse.jdt.internal.ui.wizards.dialogfields.LayoutUtil;
 import org.eclipse.jdt.internal.ui.wizards.dialogfields.SelectionButtonDialogFieldGroup;

 /**
  * Wizard page to  create a new class.
  * <p>
  * Note: This class is not intended to be subclassed, but clients can instantiate.
  * To implement a different kind of a new class wizard page, extend <code>NewTypeWizardPage</code>.
  * </p>
  *
  * @since 2.0
  *
  * @noextend This class is not intended to be subclassed by clients.
  */
 public class NewClassWizardPage extends NewTypeWizardPage {

 	private final static String PAGE_NAME= "NewClassWizardPage"; //$NON-NLS-1$

 //	private final static String SETTINGS_CREATEMAIN= "create_main"; // not stored any more, see https://bugs.eclipse.org/388342
 	private final static String SETTINGS_CREATECONSTR= "create_constructor"; //$NON-NLS-1$
 	private final static String SETTINGS_CREATEUNIMPLEMENTED= "create_unimplemented"; //$NON-NLS-1$

 	private SelectionButtonDialogFieldGroup fMethodStubsButtons;

 	/**
 	 * Creates a new <code>NewClassWizardPage</code>
 	 */
 	public NewClassWizardPage() {
 		super(true, PAGE_NAME);

 		setTitle(NewWizardMessages.NewClassWizardPage_title);
 		setDescription(NewWizardMessages.NewClassWizardPage_description);

 		String[] buttonNames3= new String[] {
 			NewWizardMessages.NewClassWizardPage_methods_main, NewWizardMessages.NewClassWizardPage_methods_constructors,
 			NewWizardMessages.NewClassWizardPage_methods_inherited
 		};
 		fMethodStubsButtons= new SelectionButtonDialogFieldGroup(SWT.CHECK, buttonNames3, 1);
 		fMethodStubsButtons.setLabelText(NewWizardMessages.NewClassWizardPage_methods_label);
 	}

 	// -------- Initialization ---------

 	/**
 	 * The wizard owning this page is responsible for calling this method with the
 	 * current selection. The selection is used to initialize the fields of the wizard
 	 * page.
 	 *
 	 * @param selection used to initialize the fields
 	 */
 	public void init(IStructuredSelection selection) {
 		IJavaElement jelem= getInitialJavaElement(selection);
 		initContainerPage(jelem);
 		initTypePage(jelem);
 		doStatusUpdate();

 		boolean createMain= false;
 		boolean createConstructors= false;
 		boolean createUnimplemented= true;
 		IDialogSettings dialogSettings= getDialogSettings();
 		if (dialogSettings != null) {
 			IDialogSettings section= dialogSettings.getSection(PAGE_NAME);
 			if (section != null) {
 				createConstructors= section.getBoolean(SETTINGS_CREATECONSTR);
 				createUnimplemented= section.getBoolean(SETTINGS_CREATEUNIMPLEMENTED);
 			}
 		}

 		setMethodStubSelection(createMain, createConstructors, createUnimplemented, true);
 	}

 	// ------ validation --------
 	private void doStatusUpdate() {
 		// status of all used components
 		IStatus[] status= new IStatus[] {
 			fContainerStatus,
 			isEnclosingTypeSelected() ? fEnclosingTypeStatus : fPackageStatus,
 			fTypeNameStatus,
 			fModifierStatus,
 			fSuperClassStatus,
 			fSuperInterfacesStatus,
 			fSealedSuperClassStatus,
 			fSealedSuperInterfacesStatus,
 			fSealedModifierStatus
 		};

 		// the mode severe status will be displayed and the OK button enabled/disabled.
 		updateStatus(status);
 	}


 	/*
 	 * @see NewContainerWizardPage#handleFieldChanged
 	 */
 	@Override
 	protected void handleFieldChanged(String fieldName) {
 		super.handleFieldChanged(fieldName);

 		// disable creation of main if enclosing type is selected but not static modifier, otherwise this creates compilation error
 		if (isEnclosingTypeSelected() && !((getModifiers() & F_STATIC) > 0)) {
 			fMethodStubsButtons.setSelection(0, false);
 			fMethodStubsButtons.enableSelectionButton(0, false);
 		} else {
 			fMethodStubsButtons.enableSelectionButton(0, true);
 		}
 		doStatusUpdate();
 	}


 	// ------ UI --------

 	/*
 	 * @see WizardPage#createControl
 	 */
 	@Override
 	public void createControl(Composite parent) {
 		initializeDialogUnits(parent);

 		Composite composite= new Composite(parent, SWT.NONE);
 		composite.setFont(parent.getFont());

 		int nColumns= 4;

 		GridLayout layout= new GridLayout();
 		layout.numColumns= nColumns;
 		composite.setLayout(layout);

 		// pick & choose the wanted UI components

 		createContainerControls(composite, nColumns);
 		createPackageControls(composite, nColumns);
 		createEnclosingTypeControls(composite, nColumns);

 		createSeparator(composite, nColumns);

 		createTypeNameControls(composite, nColumns);
 		createModifierControls(composite, nColumns);

 		createSuperClassControls(composite, nColumns);
 		createSuperInterfacesControls(composite, nColumns);

 		createMethodStubSelectionControls(composite, nColumns);

 		createCommentControls(composite, nColumns);
 		enableCommentControl(true);

 		setControl(composite);

 		Dialog.applyDialogFont(composite);
 		PlatformUI.getWorkbench().getHelpSystem().setHelp(composite, IJavaHelpContextIds.NEW_CLASS_WIZARD_PAGE);
 	}

 	/*
 	 * @see WizardPage#becomesVisible
 	 */
 	@Override
 	public void setVisible(boolean visible) {
 		super.setVisible(visible);
 		if (visible) {
 			setFocus();
 			if (isSuperTypeSealed()) {
 				doStatusUpdate();
 			}
 		}
 	}

 	private void createMethodStubSelectionControls(Composite composite, int nColumns) {
 		Control labelControl= fMethodStubsButtons.getLabelControl(composite);
 		LayoutUtil.setHorizontalSpan(labelControl, nColumns);

 		DialogField.createEmptySpace(composite);

 		Control buttonGroup= fMethodStubsButtons.getSelectionButtonsGroup(composite);
 		LayoutUtil.setHorizontalSpan(buttonGroup, nColumns - 1);
 	}

 	/**
 	 * Returns the current selection state of the 'Create Main' checkbox.
 	 *
 	 * @return the selection state of the 'Create Main' checkbox
 	 */
 	public boolean isCreateMain() {
 		return fMethodStubsButtons.isSelected(0);
 	}

 	/**
 	 * Returns the current selection state of the 'Create Constructors' checkbox.
 	 *
 	 * @return the selection state of the 'Create Constructors' checkbox
 	 */
 	public boolean isCreateConstructors() {
 		return fMethodStubsButtons.isSelected(1);
 	}

 	/**
 	 * Returns the current selection state of the 'Create inherited abstract methods'
 	 * checkbox.
 	 *
 	 * @return the selection state of the 'Create inherited abstract methods' checkbox
 	 */
 	public boolean isCreateInherited() {
 		return fMethodStubsButtons.isSelected(2);
 	}

 	/**
 	 * Sets the selection state of the method stub checkboxes.
 	 *
 	 * @param createMain initial selection state of the 'Create Main' checkbox.
 	 * @param createConstructors initial selection state of the 'Create Constructors' checkbox.
 	 * @param createInherited initial selection state of the 'Create inherited abstract methods' checkbox.
 	 * @param canBeModified if <code>true</code> the method stub checkboxes can be changed by
 	 * the user. If <code>false</code> the buttons are "read-only"
 	 */
 	public void setMethodStubSelection(boolean createMain, boolean createConstructors, boolean createInherited, boolean canBeModified) {
 		fMethodStubsButtons.setSelection(0, createMain);
 		fMethodStubsButtons.setSelection(1, createConstructors);
 		fMethodStubsButtons.setSelection(2, createInherited);

 		fMethodStubsButtons.setEnabled(canBeModified);
 	}

 	// ---- creation ----------------

 	/*
 	 * @see NewTypeWizardPage#createTypeMembers
 	 */
 	@Override
 	protected void createTypeMembers(IType type, ImportsManager imports, IProgressMonitor monitor) throws CoreException {
 		boolean doMain= isCreateMain();
 		boolean doConstr= isCreateConstructors();
 		boolean doInherited= isCreateInherited();
 		createInheritedMethods(type, doConstr, doInherited, imports, new SubProgressMonitor(monitor, 1));

 		if (doMain) {
 			createMainMethod(type, imports);
 		}

 		IDialogSettings dialogSettings= getDialogSettings();
 		if (dialogSettings != null) {
 			IDialogSettings section= dialogSettings.getSection(PAGE_NAME);
 			if (section == null) {
 				section= dialogSettings.addNewSection(PAGE_NAME);
 			}
 			section.put(SETTINGS_CREATECONSTR, isCreateConstructors());
 			section.put(SETTINGS_CREATEUNIMPLEMENTED, isCreateInherited());
 		}

 		if (monitor != null) {
 			monitor.done();
 		}
 	}

 }
	/*******************************************************************************
	* Copyright (c) 2000, 2021 IBM Corporation and others.
	*
	* This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License 2.0
	* which accompanies this distribution, and is available at
	* https://www.eclipse.org/legal/epl-2.0/
	*
	* SPDX-License-Identifier: EPL-2.0
	*
	* Contributors:
	* IBM Corporation - initial API and implementation
	* Philippe Marschall <philippe.marschall@netcetera.ch> - [type wizards] generate main method stub ignores generate comments setting - https://bugs.eclipse.org/387536
	*******************************************************************************/
	package org.eclipse.jdt.ui.wizards;

	import org.eclipse.swt.SWT;
	import org.eclipse.swt.layout.GridLayout;
	import org.eclipse.swt.widgets.Composite;
	import org.eclipse.swt.widgets.Control;

	import org.eclipse.core.runtime.CoreException;
	import org.eclipse.core.runtime.IProgressMonitor;
	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.SubProgressMonitor;

	import org.eclipse.jface.dialogs.Dialog;
	import org.eclipse.jface.dialogs.IDialogSettings;
	import org.eclipse.jface.viewers.IStructuredSelection;

	import org.eclipse.ui.PlatformUI;

	import org.eclipse.jdt.core.IJavaElement;
	import org.eclipse.jdt.core.IType;

	import org.eclipse.jdt.internal.ui.IJavaHelpContextIds;
	import org.eclipse.jdt.internal.ui.wizards.NewWizardMessages;
	import org.eclipse.jdt.internal.ui.wizards.dialogfields.DialogField;
	import org.eclipse.jdt.internal.ui.wizards.dialogfields.LayoutUtil;
	import org.eclipse.jdt.internal.ui.wizards.dialogfields.SelectionButtonDialogFieldGroup;

	/**
	* Wizard page to create a new class.
	* <p>
	* Note: This class is not intended to be subclassed, but clients can instantiate.
	* To implement a different kind of a new class wizard page, extend <code>NewTypeWizardPage</code>.
	* </p>
	*
	* @since 2.0
	*
	* @noextend This class is not intended to be subclassed by clients.
	*/
	public class NewClassWizardPage extends NewTypeWizardPage {

	private final static String PAGE_NAME= "NewClassWizardPage"; //$NON-NLS-1$

	// private final static String SETTINGS_CREATEMAIN= "create_main"; // not stored any more, see https://bugs.eclipse.org/388342
	private final static String SETTINGS_CREATECONSTR= "create_constructor"; //$NON-NLS-1$
	private final static String SETTINGS_CREATEUNIMPLEMENTED= "create_unimplemented"; //$NON-NLS-1$

	private SelectionButtonDialogFieldGroup fMethodStubsButtons;

	/**
	* Creates a new <code>NewClassWizardPage</code>
	*/
	public NewClassWizardPage() {
	super(true, PAGE_NAME);

	setTitle(NewWizardMessages.NewClassWizardPage_title);
	setDescription(NewWizardMessages.NewClassWizardPage_description);

	String[] buttonNames3= new String[] {
	NewWizardMessages.NewClassWizardPage_methods_main, NewWizardMessages.NewClassWizardPage_methods_constructors,
	NewWizardMessages.NewClassWizardPage_methods_inherited
	};
	fMethodStubsButtons= new SelectionButtonDialogFieldGroup(SWT.CHECK, buttonNames3, 1);
	fMethodStubsButtons.setLabelText(NewWizardMessages.NewClassWizardPage_methods_label);
	}

	// -------- Initialization ---------

	/**
	* The wizard owning this page is responsible for calling this method with the
	* current selection. The selection is used to initialize the fields of the wizard
	* page.
	*
	* @param selection used to initialize the fields
	*/
	public void init(IStructuredSelection selection) {
	IJavaElement jelem= getInitialJavaElement(selection);
	initContainerPage(jelem);
	initTypePage(jelem);
	doStatusUpdate();

	boolean createMain= false;
	boolean createConstructors= false;
	boolean createUnimplemented= true;
	IDialogSettings dialogSettings= getDialogSettings();
	if (dialogSettings != null) {
	IDialogSettings section= dialogSettings.getSection(PAGE_NAME);
	if (section != null) {
	createConstructors= section.getBoolean(SETTINGS_CREATECONSTR);
	createUnimplemented= section.getBoolean(SETTINGS_CREATEUNIMPLEMENTED);
	}
	}

	setMethodStubSelection(createMain, createConstructors, createUnimplemented, true);
	}

	// ------ validation --------
	private void doStatusUpdate() {
	// status of all used components
	IStatus[] status= new IStatus[] {
	fContainerStatus,
	isEnclosingTypeSelected() ? fEnclosingTypeStatus : fPackageStatus,
	fTypeNameStatus,
	fModifierStatus,
	fSuperClassStatus,
	fSuperInterfacesStatus,
	fSealedSuperClassStatus,
	fSealedSuperInterfacesStatus,
	fSealedModifierStatus
	};

	// the mode severe status will be displayed and the OK button enabled/disabled.
	updateStatus(status);
	}


	/*
	* @see NewContainerWizardPage#handleFieldChanged
	*/
	@Override
	protected void handleFieldChanged(String fieldName) {
	super.handleFieldChanged(fieldName);

	// disable creation of main if enclosing type is selected but not static modifier, otherwise this creates compilation error
	if (isEnclosingTypeSelected() && !((getModifiers() & F_STATIC) > 0)) {
	fMethodStubsButtons.setSelection(0, false);
	fMethodStubsButtons.enableSelectionButton(0, false);
	} else {
	fMethodStubsButtons.enableSelectionButton(0, true);
	}
	doStatusUpdate();
	}


	// ------ UI --------

	/*
	* @see WizardPage#createControl
	*/
	@Override
	public void createControl(Composite parent) {
	initializeDialogUnits(parent);

	Composite composite= new Composite(parent, SWT.NONE);
	composite.setFont(parent.getFont());

	int nColumns= 4;

	GridLayout layout= new GridLayout();
	layout.numColumns= nColumns;
	composite.setLayout(layout);

	// pick & choose the wanted UI components

	createContainerControls(composite, nColumns);
	createPackageControls(composite, nColumns);
	createEnclosingTypeControls(composite, nColumns);

	createSeparator(composite, nColumns);

	createTypeNameControls(composite, nColumns);
	createModifierControls(composite, nColumns);

	createSuperClassControls(composite, nColumns);
	createSuperInterfacesControls(composite, nColumns);

	createMethodStubSelectionControls(composite, nColumns);

	createCommentControls(composite, nColumns);
	enableCommentControl(true);

	setControl(composite);

	Dialog.applyDialogFont(composite);
	PlatformUI.getWorkbench().getHelpSystem().setHelp(composite, IJavaHelpContextIds.NEW_CLASS_WIZARD_PAGE);
	}

	/*
	* @see WizardPage#becomesVisible
	*/
	@Override
	public void setVisible(boolean visible) {
	super.setVisible(visible);
	if (visible) {
	setFocus();
	if (isSuperTypeSealed()) {
	doStatusUpdate();
	}
	}
	}

	private void createMethodStubSelectionControls(Composite composite, int nColumns) {
	Control labelControl= fMethodStubsButtons.getLabelControl(composite);
	LayoutUtil.setHorizontalSpan(labelControl, nColumns);

	DialogField.createEmptySpace(composite);

	Control buttonGroup= fMethodStubsButtons.getSelectionButtonsGroup(composite);
	LayoutUtil.setHorizontalSpan(buttonGroup, nColumns - 1);
	}

	/**
	* Returns the current selection state of the 'Create Main' checkbox.
	*
	* @return the selection state of the 'Create Main' checkbox
	*/
	public boolean isCreateMain() {
	return fMethodStubsButtons.isSelected(0);
	}

	/**
	* Returns the current selection state of the 'Create Constructors' checkbox.
	*
	* @return the selection state of the 'Create Constructors' checkbox
	*/
	public boolean isCreateConstructors() {
	return fMethodStubsButtons.isSelected(1);
	}

	/**
	* Returns the current selection state of the 'Create inherited abstract methods'
	* checkbox.
	*
	* @return the selection state of the 'Create inherited abstract methods' checkbox
	*/
	public boolean isCreateInherited() {
	return fMethodStubsButtons.isSelected(2);
	}

	/**
	* Sets the selection state of the method stub checkboxes.
	*
	* @param createMain initial selection state of the 'Create Main' checkbox.
	* @param createConstructors initial selection state of the 'Create Constructors' checkbox.
	* @param createInherited initial selection state of the 'Create inherited abstract methods' checkbox.
	* @param canBeModified if <code>true</code> the method stub checkboxes can be changed by
	* the user. If <code>false</code> the buttons are "read-only"
	*/
	public void setMethodStubSelection(boolean createMain, boolean createConstructors, boolean createInherited, boolean canBeModified) {
	fMethodStubsButtons.setSelection(0, createMain);
	fMethodStubsButtons.setSelection(1, createConstructors);
	fMethodStubsButtons.setSelection(2, createInherited);

	fMethodStubsButtons.setEnabled(canBeModified);
	}

	// ---- creation ----------------

	/*
	* @see NewTypeWizardPage#createTypeMembers
	*/
	@Override
	protected void createTypeMembers(IType type, ImportsManager imports, IProgressMonitor monitor) throws CoreException {
	boolean doMain= isCreateMain();
	boolean doConstr= isCreateConstructors();
	boolean doInherited= isCreateInherited();
	createInheritedMethods(type, doConstr, doInherited, imports, new SubProgressMonitor(monitor, 1));

	if (doMain) {
	createMainMethod(type, imports);
	}

	IDialogSettings dialogSettings= getDialogSettings();
	if (dialogSettings != null) {
	IDialogSettings section= dialogSettings.getSection(PAGE_NAME);
	if (section == null) {
	section= dialogSettings.addNewSection(PAGE_NAME);
	}
	section.put(SETTINGS_CREATECONSTR, isCreateConstructors());
	section.put(SETTINGS_CREATEUNIMPLEMENTED, isCreateInherited());
	}

	if (monitor != null) {
	monitor.done();
	}
	}

	}