directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pamarce...@apache.org
Subject svn commit: r493073 - /directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/
Date Fri, 05 Jan 2007 16:39:19 GMT
Author: pamarcelot
Date: Fri Jan  5 08:39:19 2007
New Revision: 493073

URL: http://svn.apache.org/viewvc?view=rev&rev=493073
Log:
Adding Javadoc (DIRSTUDIO-19).

Modified:
    directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/ILdifEditor.java
    directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifDocumentProvider.java
    directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditor.java
    directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditorContributor.java
    directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifSourceViewerConfiguration.java

Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/ILdifEditor.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/ILdifEditor.java?view=diff&rev=493073&r1=493072&r2=493073
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/ILdifEditor.java
(original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/ILdifEditor.java
Fri Jan  5 08:39:19 2007
@@ -27,12 +27,28 @@
 import org.eclipse.core.runtime.IAdaptable;
 
 
+/**
+ * This interface represents the LDIF Editor.
+ * 
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public interface ILdifEditor extends IAdaptable
 {
-
+    /**
+     * Gets the LDIF Model
+     *
+     * @return
+     *      the LDIF Model
+     */
     public LdifFile getLdifModel();
 
 
+    /**
+     * Gets the Connection
+     * 
+     * @return
+     *      the Connection
+     */
     public IConnection getConnection();
-
 }

Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifDocumentProvider.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifDocumentProvider.java?view=diff&rev=493073&r1=493072&r2=493073
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifDocumentProvider.java
(original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifDocumentProvider.java
Fri Jan  5 08:39:19 2007
@@ -58,6 +58,13 @@
 import org.eclipse.ui.texteditor.AbstractDocumentProvider;
 
 
+/**
+ * This class implements the LDIF Document Provider.
+ * This class is used to share a LDIF Document and listen on document modifications.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public class LdifDocumentProvider extends AbstractDocumentProvider implements IDocumentListener
 {
 
@@ -68,6 +75,9 @@
     private LdifFile ldifModel;
 
 
+    /**
+     * Creates a new instance of LdifDocumentProvider.
+     */
     public LdifDocumentProvider()
     {
         super();
@@ -76,6 +86,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public IDocument getDocument( Object element )
     {
         IDocument document = super.getDocument( element );
@@ -83,12 +96,21 @@
     }
 
 
+    /**
+     * Gets the LDIF Model
+     *
+     * @return
+     *      the LDIF Model
+     */
     public LdifFile getLdifModel()
     {
         return ldifModel;
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void documentAboutToBeChanged( DocumentEvent event )
     {
     }
@@ -444,5 +466,4 @@
     {
         return true;
     }
-
 }

Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditor.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditor.java?view=diff&rev=493073&r1=493072&r2=493073
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditor.java
(original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditor.java
Fri Jan  5 08:39:19 2007
@@ -108,9 +108,14 @@
 import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
 
 
+/**
+ * This class implements the LDIF editor
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public class LdifEditor extends TextEditor implements ILdifEditor, ConnectionUpdateListener,
IPartListener2
 {
-
     protected ViewForm control;
 
     protected Combo connectionCombo;
@@ -134,6 +139,9 @@
     private ValueEditorPreferencesAction valueEditorPreferencesAction;
 
 
+    /**
+     * Creates a new instance of LdifEditor.
+     */
     public LdifEditor()
     {
         super();
@@ -151,6 +159,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     protected void handlePreferenceStoreChanged( PropertyChangeEvent event )
     {
         try
@@ -174,6 +185,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     protected String[] collectContextMenuPreferencePages()
     {
         String[] ids = super.collectContextMenuPreferencePages();
@@ -187,12 +201,21 @@
     }
 
 
+    /**
+     * Gets the ID of the LDIF Editor
+     *
+     * @return
+     *      the ID of the LDIF Editor
+     */
     public static String getId()
     {
         return LdifEditor.class.getName();
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void init( IEditorSite site, IEditorInput input ) throws PartInitException
     {
         if ( input instanceof IPathEditorInput )
@@ -219,6 +242,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void dispose()
     {
 
@@ -233,6 +259,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public Object getAdapter( Class required )
     {
         if ( IShowInTargetList.class.equals( required ) )
@@ -284,6 +313,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     protected void editorContextMenuAboutToShow( IMenuManager menu )
     {
         super.editorContextMenuAboutToShow( menu );
@@ -341,6 +373,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     protected void createActions()
     {
         super.createActions();
@@ -408,6 +443,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void createPartControl( Composite parent )
     {
 
@@ -477,6 +515,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     protected ISourceViewer createSourceViewer( Composite parent, IVerticalRuler ruler, int
styles )
     {
         getAnnotationAccess();
@@ -488,12 +529,18 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     protected void configureSourceViewerDecorationSupport( SourceViewerDecorationSupport
support )
     {
         super.configureSourceViewerDecorationSupport( support );
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public LdifFile getLdifModel()
     {
         IDocumentProvider provider = getDocumentProvider();
@@ -508,6 +555,9 @@
     }
 
 
+    /**
+     * This method is used to notify the LDIF Editor that the Outline Page has been closed.
+     */
     public void outlinePageClosed()
     {
         projectionSupport.dispose();
@@ -515,12 +565,21 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public IConnection getConnection()
     {
         return this.connection;
     }
 
 
+    /**
+     * Sets the Connection
+     *
+     * @param connection
+     *      the Connection to set
+     */
     private void setConnection( IConnection connection )
     {
         this.connection = connection;
@@ -530,6 +589,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void connectionUpdated( ConnectionUpdateEvent connectionUpdateEvent )
     {
         IConnection[] connections = BrowserCorePlugin.getDefault().getConnectionManager().getConnections();
@@ -669,6 +731,9 @@
     private IContextActivation contextActivation;
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void partDeactivated( IWorkbenchPartReference partRef )
     {
         if ( partRef.getPart( false ) == this && contextActivation != null )
@@ -684,6 +749,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void partActivated( IWorkbenchPartReference partRef )
     {
         if ( partRef.getPart( false ) == this )
@@ -699,39 +767,59 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void partBroughtToTop( IWorkbenchPartReference partRef )
     {
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void partClosed( IWorkbenchPartReference partRef )
     {
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void partHidden( IWorkbenchPartReference partRef )
     {
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void partInputChanged( IWorkbenchPartReference partRef )
     {
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void partOpened( IWorkbenchPartReference partRef )
     {
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void partVisible( IWorkbenchPartReference partRef )
     {
     }
 
 
+    /**
+     * Activates global action handlers
+     */
     public void activateGlobalActionHandlers()
     {
-
         ICommandService commandService = ( ICommandService ) PlatformUI.getWorkbench().getAdapter(
             ICommandService.class );
         if ( commandService != null )
@@ -746,9 +834,11 @@
     }
 
 
+    /**
+     * Deactivates global action handlers
+     */
     public void deactivateGlobalActionHandlers()
     {
-
         ICommandService commandService = ( ICommandService ) PlatformUI.getWorkbench().getAdapter(
             ICommandService.class );
         if ( commandService != null )
@@ -763,9 +853,14 @@
     }
 
 
+    /**
+     * Gets the Value Editor Manager
+     *
+     * @return
+     *      the Value Editor Manager
+     */
     public ValueEditorManager getValueEditorManager()
     {
         return valueEditorManager;
     }
-
 }

Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditorContributor.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditorContributor.java?view=diff&rev=493073&r1=493072&r2=493073
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditorContributor.java
(original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifEditorContributor.java
Fri Jan  5 08:39:19 2007
@@ -31,6 +31,12 @@
 import org.eclipse.ui.texteditor.RetargetTextEditorAction;
 
 
+/**
+ * This class manages the installation and removal of global actions for the LDIF Editor.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public class LdifEditorContributor extends BasicTextEditorActionContributor
 {
 
@@ -39,6 +45,9 @@
     private RetargetTextEditorAction contentAssist;
 
 
+    /**
+     * Creates a new instance of LdifEditorContributor.
+     */
     public LdifEditorContributor()
     {
         super();
@@ -49,6 +58,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void setActiveEditor( IEditorPart part )
     {
         super.setActiveEditor( part );
@@ -57,6 +69,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void init( IActionBars bars, IWorkbenchPage page )
     {
         super.init( bars, page );
@@ -64,10 +79,12 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void dispose()
     {
         setActiveEditor( null );
         super.dispose();
     }
-
 }

Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifSourceViewerConfiguration.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifSourceViewerConfiguration.java?view=diff&rev=493073&r1=493072&r2=493073
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifSourceViewerConfiguration.java
(original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/ldif/LdifSourceViewerConfiguration.java
Fri Jan  5 08:39:19 2007
@@ -51,10 +51,14 @@
 import org.eclipse.jface.text.source.SourceViewerConfiguration;
 import org.eclipse.swt.graphics.RGB;
 
-
+/**
+ * This class enables the features of the editor (Syntax coloring, code completion, etc.)
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public class LdifSourceViewerConfiguration extends SourceViewerConfiguration
 {
-
     private ILdifEditor editor;
 
     // Error hover and annotations
@@ -84,28 +88,49 @@
     private IAutoEditStrategy[] autoEditStrategies;
 
 
+    /**
+     * Creates a new instance of LdifSourceViewerConfiguration.
+     *
+     * @param editor
+     * @param contentAssistEnabled
+     */
     public LdifSourceViewerConfiguration( ILdifEditor editor, boolean contentAssistEnabled
)
     {
         super();
         this.editor = editor;
 
         this.contentAssistEnabled = contentAssistEnabled;
-
     }
 
 
+    /**
+     * Overwrites the style set in preference store
+     *
+     * @param key
+     *      the key
+     * @param rgb
+     *      the color
+     * @param style
+     *      the stule
+     */
     public void setTextAttribute( String key, RGB rgb, int style )
     {
         damagerRepairer.setTextAttribute( key, rgb, style );
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public String getConfiguredDocumentPartitioning( ISourceViewer sourceViewer )
     {
         return LdifDocumentSetupParticipant.LDIF_PARTITIONING;
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public String[] getConfiguredContentTypes( ISourceViewer sourceViewer )
     {
         return new String[]
@@ -113,6 +138,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public ITextDoubleClickStrategy getDoubleClickStrategy( ISourceViewer sourceViewer, String
contentType )
     {
         if ( this.doubleClickStrategy == null )
@@ -123,6 +151,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public IPresentationReconciler getPresentationReconciler( ISourceViewer sourceViewer
)
     {
 
@@ -144,6 +175,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public IReconciler getReconciler( ISourceViewer sourceViewer )
     {
         if ( this.reconciler == null )
@@ -169,6 +203,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public IContentAssistant getContentAssistant( ISourceViewer sourceViewer )
     {
         if ( this.contentAssistEnabled )
@@ -208,6 +245,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public IAnnotationHover getAnnotationHover( ISourceViewer sourceViewer )
     {
         if ( this.annotationHover == null )
@@ -218,6 +258,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public ITextHover getTextHover( ISourceViewer sourceViewer, String contentType )
     {
         if ( this.textHover == null )
@@ -228,6 +271,9 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public IAutoEditStrategy[] getAutoEditStrategies( ISourceViewer sourceViewer, String
contentType )
     {
         if ( autoEditStrategies == null )
@@ -239,5 +285,4 @@
 
         return autoEditStrategies;
     }
-
 }



Mime
View raw message