Java Doc and API clean up of TMF UML Sequence diagram framework

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / uml2sd / dialogs / SDPrintDialog.java

/********************************************************************** 
 * Copyright (c) 2005, 2008 IBM Corporation and others.
 * Copyright (c) 2011, 2012 Ericsson.
 *  
 * 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: 
 * IBM - Initial API and implementation
 * Bernd Hufmann - Updated for TMF 
 **********************************************************************/

package org.eclipse.linuxtools.tmf.ui.views.uml2sd.dialogs;

import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDWidget;
import org.eclipse.linuxtools.tmf.ui.views.uml2sd.util.SDMessages;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;

/**
 * This class implements a dialog box for collecting printing information.
 * 
 * @version 1.0
 * @author sveyrier
 */
public class SDPrintDialog extends Dialog {

    // ------------------------------------------------------------------------
    // Attributes
    // ------------------------------------------------------------------------
    /**
     * The sequence dialog widget reference.
     */
    protected SDWidget view;
    /**
     * Sequence dialog print dialog UI
     */
    protected SDPrintDialogUI dialogUI;
    /**
     * Error message to display.
     */
    protected String errorMessage = null;
    /**
     * A message label.
     */
    protected Label messageLabel = null;
    /**
     * Flag whether the page is complete or not
     */
    protected boolean isPageComplete = true;

    // ------------------------------------------------------------------------
    // Constructors
    // ------------------------------------------------------------------------
    /**
     * Standard constructor
     * 
     * @param shell Shell reference
     * @param viewer Sequence diagram widget reference
     */
    public SDPrintDialog(Shell shell, SDWidget viewer) {
        super(shell);
        view = viewer;

        dialogUI = new SDPrintDialogUI(shell, view);
        dialogUI.setParentDialog(this);
    }

    // ------------------------------------------------------------------------
    // Methods
    // ------------------------------------------------------------------------
    /*
     * (non-Javadoc)
     * @see org.eclipse.jface.dialogs.Dialog#createDialogArea(org.eclipse.swt.widgets.Composite)
     */
    @Override
    protected Control createDialogArea(Composite p) {
        p.getShell().setText(SDMessages._114);
        Composite parent = (Composite) super.createDialogArea(p);

        dialogUI.createDialogArea(parent);

        messageLabel = new Label(parent, SWT.NONE);
        GridData gridData = new GridData(SWT.FILL, SWT.FILL, true, true);
        gridData.horizontalSpan = 6;
        messageLabel.setLayoutData(gridData);
        setErrorMessage(errorMessage);

        return parent;
    }
    
    /*
     * (non-Javadoc)
     * @see org.eclipse.jface.dialogs.Dialog#okPressed()
     */
    @Override
    protected void okPressed() {

        if (dialogUI.okPressed())
            super.okPressed();
    }

    /*
     * (non-Javadoc)
     * @see org.eclipse.jface.dialogs.Dialog#createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)
     */
    @Override
    protected void createButtonsForButtonBar(Composite parent) {

        super.createButtonsForButtonBar(parent);
        createButton(parent, IDialogConstants.CLIENT_ID, SDMessages._115, false);

        getButton(IDialogConstants.CLIENT_ID).addSelectionListener(new SelectionListener() {
            /*
             * (non-Javadoc)
             * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)
             */
            @Override
            public void widgetSelected(SelectionEvent e) {

                dialogUI.printButtonSelected();
            }
            /*
             * (non-Javadoc)
             * @see org.eclipse.swt.events.SelectionListener#widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent)
             */
            @Override
            public void widgetDefaultSelected(SelectionEvent e) {
            }
        });

        updateButtons();
    }

    /**
     * @return the dialog UI
     */
    public SDPrintDialogUI getDialogUI() {
        return dialogUI;
    }

    /**
     * Sets the error message.
     * 
     * @param message error message to set
     */
    public void setErrorMessage(String message) {
        errorMessage = message;
        if (messageLabel != null) {
            if (errorMessage == null) {
                messageLabel.setText(""); //$NON-NLS-1$
            } else {
                messageLabel.setText(errorMessage);
            }
        }
    }

    /**
     * Sets the page complete flag.
     * @param complete whether page is complete or not
     */
    public void setPageComplete(boolean complete) {
        isPageComplete = complete;
        updateButtons();
    }

    /**
     * Udates the button enable state.
     */
    public void updateButtons() {
        Button okButton = getButton(IDialogConstants.OK_ID);
        if (isPageComplete) {
            if (okButton != null) {
                okButton.setEnabled(true);
            }
        } else {
            if (okButton != null) {
                okButton.setEnabled(false);
            }
        }
    }

}