org.apache.directory.studio.valueeditors.objectclass.ObjectClassDialog.java Source code

Introduction

Here is the source code for org.apache.directory.studio.valueeditors.objectclass.ObjectClassDialog.java

Source

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */

package org.apache.directory.studio.valueeditors.objectclass;

import java.util.Arrays;

import org.apache.directory.studio.common.ui.widgets.BaseWidgetUtils;
import org.apache.directory.studio.connection.ui.widgets.ExtendedContentAssistCommandAdapter;
import org.apache.directory.studio.ldapbrowser.common.widgets.ListContentProposalProvider;
import org.apache.directory.studio.ldapbrowser.core.model.schema.Schema;
import org.apache.directory.studio.ldapbrowser.core.model.schema.SchemaUtils;
import org.apache.directory.studio.valueeditors.ValueEditorsActivator;
import org.apache.directory.studio.valueeditors.ValueEditorsConstants;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.fieldassist.ComboContentAdapter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Shell;

/**
 * This class provides a dialog to enter or select an object class.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class ObjectClassDialog extends Dialog {

    /** The schema. */
    private Schema schema;

    /** The initial value. */
    private String initialValue;

    /** The object class combo. */
    private Combo objectClassCombo;

    /** The return value. */
    private String returnValue;

    /**
     * Creates a new instance of ObjectClassDialog.
     * 
     * @param parentShell the parent shell
     * @param schema the schema
     * @param initialValue the initial value
     */
    public ObjectClassDialog(Shell parentShell, Schema schema, String initialValue) {
        super(parentShell);
        super.setShellStyle(super.getShellStyle() | SWT.RESIZE);
        this.initialValue = initialValue;
        this.schema = schema;
        this.returnValue = null;
    }

    /**
     * {@inheritDoc}
     */
    protected void configureShell(Shell shell) {
        super.configureShell(shell);
        shell.setText(Messages.getString("ObjectClassDialog.ObjectClassEditor")); //$NON-NLS-1$
        shell.setImage(ValueEditorsActivator.getDefault().getImage(ValueEditorsConstants.IMG_OCDEDITOR));
    }

    /**
     * {@inheritDoc}
     */
    protected void createButtonsForButtonBar(Composite parent) {
        super.createButtonsForButtonBar(parent);
    }

    /**
     * {@inheritDoc}
     */
    protected void okPressed() {
        returnValue = objectClassCombo.getText();
        super.okPressed();
    }

    /**
     * {@inheritDoc}
     */
    protected Control createDialogArea(Composite parent) {
        // create composite
        Composite composite = (Composite) super.createDialogArea(parent);
        GridData gd = new GridData(GridData.FILL_BOTH);
        gd.widthHint = convertHorizontalDLUsToPixels(IDialogConstants.MINIMUM_MESSAGE_AREA_WIDTH);
        composite.setLayoutData(gd);

        // combo widget
        String[] allOcNames = SchemaUtils.getNamesAsArray(schema.getObjectClassDescriptions());
        Arrays.sort(allOcNames);

        // attribute combo with field decoration and content proposal
        objectClassCombo = BaseWidgetUtils.createCombo(composite, new String[0], -1, 1);
        objectClassCombo.setVisibleItemCount(20);
        objectClassCombo.setItems(allOcNames);
        objectClassCombo.setText(initialValue);
        new ExtendedContentAssistCommandAdapter(objectClassCombo, new ComboContentAdapter(),
                new ListContentProposalProvider(objectClassCombo.getItems()), null, null, true);

        applyDialogFont(composite);
        return composite;
    }

    /**
     * Gets the object class.
     * 
     * @return the object class, null if canceled
     */
    public String getObjectClass() {
        return returnValue;
    }
}