/*
* 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.ldifeditor.widgets;
import org.apache.directory.studio.ldapbrowser.common.widgets.BrowserWidget;
import org.apache.directory.studio.ldapbrowser.core.model.IBrowserConnection;
import org.apache.directory.studio.ldifeditor.editor.ILdifEditor;
import org.apache.directory.studio.ldifeditor.editor.LdifDocumentProvider;
import org.apache.directory.studio.ldifeditor.editor.LdifSourceViewerConfiguration;
import org.apache.directory.studio.ldifeditor.editor.NonExistingLdifEditorInput;
import org.apache.directory.studio.ldifparser.model.LdifFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextListener;
import org.eclipse.jface.text.TextEvent;
import org.eclipse.jface.text.source.SourceViewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
/**
* The LdifEditorWidget provides basic LDIF editor functionality like
* syntax highlighting and content assistent.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
*/
public class LdifEditorWidget extends BrowserWidget implements ILdifEditor, ITextListener
{
/** The connection. */
private IBrowserConnection connection;
/** The initial LDIF. */
private String initialLdif;
/** The content assist enabled. */
private boolean contentAssistEnabled;
/** The editor input. */
private NonExistingLdifEditorInput editorInput;
/** The document provider. */
private LdifDocumentProvider documentProvider;
/** The source viewer. */
private SourceViewer sourceViewer;
/** The source viewer configuration. */
private LdifSourceViewerConfiguration sourceViewerConfiguration;
/** The widget composite */
private Composite composite;
/**
* Creates a new instance of LdifEditorWidget.
*
* @param contentAssistEnabled the content assist enabled
* @param initialLdif the initial ldif
* @param connection the connection
*/
public LdifEditorWidget( IBrowserConnection connection, String initialLdif, boolean contentAssistEnabled )
{
this.connection = connection;
this.initialLdif = initialLdif;
this.contentAssistEnabled = contentAssistEnabled;
}
/**
* Disposes this widget.
*/
public void dispose()
{
if ( editorInput != null )
{
sourceViewer.removeTextListener( this );
documentProvider.disconnect( editorInput );
// documentProvider = null;
editorInput = null;
}
}
/**
* Creates the widget.
*
* @param parent the parent
*/
public void createWidget( Composite parent )
{
composite = new Composite( parent, SWT.NONE );
composite.setLayoutData( new GridData( GridData.FILL_BOTH ) );
GridLayout layout = new GridLayout( 1, false );
layout.marginWidth = 0;
layout.marginHeight = 0;
composite.setLayout( layout );
// create source viewer
// sourceViewer = new ProjectionViewer(parent, ruler,
// getOverviewRuler(), true, styles);
sourceViewer = new SourceViewer( composite, null, null, false, SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL );
sourceViewer.getControl().setLayoutData( new GridData( GridData.FILL_BOTH ) );
// configure
sourceViewerConfiguration = new LdifSourceViewerConfiguration( this, this.contentAssistEnabled );
sourceViewer.configure( sourceViewerConfiguration );
// set font
Font font = JFaceResources.getFont( JFaceResources.TEXT_FONT );
sourceViewer.getTextWidget().setFont( font );
// setup document
try
{
editorInput = new NonExistingLdifEditorInput();
documentProvider = new LdifDocumentProvider();
documentProvider.connect( editorInput );
IDocument document = documentProvider.getDocument( editorInput );
document.set( initialLdif );
sourceViewer.setDocument( document );
}
catch ( CoreException e )
{
e.printStackTrace();
}
// listener
sourceViewer.addTextListener( this );
// focus
sourceViewer.getControl().setFocus();
}
/**
* {@inheritDoc}
*/
public IBrowserConnection getConnection()
{
return connection;
}
/**
* {@inheritDoc}
*/
public LdifFile getLdifModel()
{
return documentProvider.getLdifModel();
}
/**
* {@inheritDoc}
*/
public Object getAdapter( Class adapter )
{
return null;
}
/**
* {@inheritDoc}
*/
public void textChanged( TextEvent event )
{
super.notifyListeners();
}
/**
* Gets the source viewer.
*
* @return the source viewer
*/
public SourceViewer getSourceViewer()
{
return sourceViewer;
}
/**
* Gets the source viewer configuration.
*
* @return the source viewer configuration
*/
public LdifSourceViewerConfiguration getSourceViewerConfiguration()
{
return sourceViewerConfiguration;
}
/**
* Returns the primary control associated with this view form.
*
* @return the SWT control which displays this view form's content
*/
public Control getControl()
{
return composite;
}
}