You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by pa...@apache.org on 2007/01/08 17:28:27 UTC
svn commit: r494113 [1/2] - in
/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui:
./ actions/ editors/searchresult/ widgets/entryeditor/
Author: pamarcelot
Date: Mon Jan 8 08:28:22 2007
New Revision: 494113
URL: http://svn.apache.org/viewvc?view=rev&rev=494113
Log:
Adding Javadoc to Browser UI classes (DIRSTUDIO-19). Code Cleaning.
Modified:
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIConstants.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPlugin.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferences.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferencesInitializer.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/ExceptionHandler.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/BrowserAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CloseConnectionAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CollapseAllAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAttributeDescriptionAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyDnAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsCsvAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsLdifAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopySearchFilterAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyUrlAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyValueAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAllValuesAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExecuteLdifAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExpandAllAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/FilterSubtreeAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ImportExportAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/MoveAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/NewAttributeAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/NewBatchOperationAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/NewBookmarkAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/NewConnectionAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/NewEntryAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/NewLdifFileAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/NewSearchAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/NewValueAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/OpenConnectionAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/OpenEncoderDecoderDialogAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/OpenSchemaBrowserAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/OpenSearchAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/OpenSearchResultAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/PasteAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/PropertiesAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/RefreshAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/RenameAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/SelectAllAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/SelectionUtils.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ShowRawValuesAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/UnfilterSubtreeAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/UpAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ValueEditorPreferencesAction.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/editors/searchresult/SearchResultEditorActionGroup.java
directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/widgets/entryeditor/EntryEditorWidgetActionGroup.java
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIConstants.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIConstants.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIConstants.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIConstants.java Mon Jan 8 08:28:22 2007
@@ -21,6 +21,12 @@
package org.apache.directory.ldapstudio.browser.ui;
+/**
+ * This class contains all the constants used by the Browser UI Plugin
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public interface BrowserUIConstants
{
@@ -509,5 +515,4 @@
public static final int SHOW_RDN = 1;
public static final int SHOW_RDN_VALUE = 2;
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPlugin.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPlugin.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPlugin.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPlugin.java Mon Jan 8 08:28:22 2007
@@ -56,38 +56,38 @@
public class BrowserUIPlugin extends AbstractUIPlugin
{
- // The plugin ID
+ /** The plugin ID */
public static final String PLUGIN_ID = "org.apache.directory.ldapstudio.browser.ui";
- // The shared instance.
+ /** The shared instance */
private static BrowserUIPlugin plugin;
- // Resource bundle.
+ /** Resource bundle */
private ResourceBundle resourceBundle;
- // The event dispatcher
+ /** The event dispatcher */
private ExceptionHandler exceptionHandler;
- // The font registry
+ /** The font registry */
private FontRegistry fontRegistry;
- // The color registry
+ /** The color registry */
private ColorRegistry colorRegistry;
- // The template store
+ /** The template store */
private ContributionTemplateStore ldifTemplateStore;
private ContributionTemplateStore filterTemplateStore;
- // The context type registry
+ /** The context type registry */
private ContributionContextTypeRegistry ldifTemplateContextTypeRegistry;
private ContributionContextTypeRegistry filterTemplateContextTypeRegistry;
- // The event dispatcher
+ /** The event dispatcher */
private EventDispatcherSync eventDispatcher;
- // The preferences
+ /** The preferences */
private BrowserUIPreferences uiPreferences;
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferences.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferences.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferences.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferences.java Mon Jan 8 08:28:22 2007
@@ -31,12 +31,26 @@
import org.eclipse.jface.preference.IPreferenceStore;
+/**
+ * This class is used to manage and access the preferences of the Browser UI Plugin.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class BrowserUIPreferences
{
private Map attributeValueProviderRelationCache;
+ private Map syntaxValueProviderCache;
+
+ /**
+ * Gets a Map containing all the Attribute Value Editors.
+ *
+ * @return
+ * a Map containing all the Attribute Value Editors
+ */
public Map getAttributeValueEditorMap()
{
if ( this.attributeValueProviderRelationCache == null )
@@ -56,6 +70,12 @@
}
+ /**
+ * Gets an array containing all the Attribute Value Provider Relations.
+ *
+ * @return
+ * an array containing all the Attribute Value Provider Relations
+ */
public AttributeValueProviderRelation[] getAttributeValueProviderRelations()
{
AttributeValueProviderRelation[] avpr = ( AttributeValueProviderRelation[] ) load( BrowserUIConstants.PREFERENCE_ATTRIBUTE_VALUEPROVIDER_RELATIONS );
@@ -63,6 +83,12 @@
}
+ /**
+ * Sets the Attribute Value Provider Relations.
+ *
+ * @param attributeValueProviderRelations
+ * an array containing all the Attribute Value Provider Relations
+ */
public void setAttributeValueProviderRelations( AttributeValueProviderRelation[] attributeValueProviderRelations )
{
store( BrowserUIConstants.PREFERENCE_ATTRIBUTE_VALUEPROVIDER_RELATIONS, attributeValueProviderRelations );
@@ -70,6 +96,12 @@
}
+ /**
+ * Gets the default Attribute Value Provider Relations.
+ *
+ * @return
+ * an array containing all the default Attribute Value Provider Relations
+ */
public AttributeValueProviderRelation[] getDefaultAttributeValueProviderRelations()
{
AttributeValueProviderRelation[] avpr = ( AttributeValueProviderRelation[] ) loadDefault( BrowserUIConstants.PREFERENCE_ATTRIBUTE_VALUEPROVIDER_RELATIONS );
@@ -77,15 +109,26 @@
}
+ /**
+ * Sets the default Attribute Value Provider Relations.
+ *
+ * @param attributeValueProviderRelations
+ * an array containing all the default Attribute Value Provider Relations
+ */
public void setDefaultAttributeValueProviderRelations(
AttributeValueProviderRelation[] attributeValueProviderRelations )
{
storeDefault( BrowserUIConstants.PREFERENCE_ATTRIBUTE_VALUEPROVIDER_RELATIONS, attributeValueProviderRelations );
}
- private Map syntaxValueProviderCache;
+ /**
+ * Gets a Map containing all the Syntax Value Editors.
+ *
+ * @return
+ * a Map containing all the Syntax Value Editors
+ */
public Map getSyntaxValueEditorMap()
{
if ( this.syntaxValueProviderCache == null )
@@ -105,6 +148,12 @@
}
+ /**
+ * Sets the Syntax Value Provider Relations.
+ *
+ * @param syntaxValueProviderRelations
+ * an array containing the Syntax Value Provider Relations to set
+ */
public void setSyntaxValueProviderRelations( SyntaxValueProviderRelation[] syntaxValueProviderRelations )
{
store( BrowserUIConstants.PREFERENCE_SYNTAX_VALUEPROVIDER_RELATIONS, syntaxValueProviderRelations );
@@ -112,6 +161,12 @@
}
+ /**
+ * Gets an array containing all the Syntax Value Provider Relations
+ *
+ * @return
+ * an array containing all the Syntax Value Provider Relations
+ */
public SyntaxValueProviderRelation[] getSyntaxValueProviderRelations()
{
SyntaxValueProviderRelation[] svpr = ( SyntaxValueProviderRelation[] ) load( BrowserUIConstants.PREFERENCE_SYNTAX_VALUEPROVIDER_RELATIONS );
@@ -119,6 +174,12 @@
}
+ /**
+ * Gets an array containing all the default Syntax Value Provider Relations
+ *
+ * @return
+ * an array containing all the default Syntax Value Provider Relations
+ */
public SyntaxValueProviderRelation[] getDefaultSyntaxValueProviderRelations()
{
SyntaxValueProviderRelation[] svpr = ( SyntaxValueProviderRelation[] ) loadDefault( BrowserUIConstants.PREFERENCE_SYNTAX_VALUEPROVIDER_RELATIONS );
@@ -126,12 +187,26 @@
}
+ /**
+ * Sets the default Syntax Value Provider Relations.
+ *
+ * @param syntaxValueProviderRelations
+ * an array containing the default Syntax Value Provider Relations to set
+ */
public void setDefaultSyntaxValueProviderRelations( SyntaxValueProviderRelation[] syntaxValueProviderRelations )
{
storeDefault( BrowserUIConstants.PREFERENCE_SYNTAX_VALUEPROVIDER_RELATIONS, syntaxValueProviderRelations );
}
+ /**
+ * Loads the current value of the string-valued property with the given name.
+ *
+ * @param key
+ * the name of the property
+ * @return
+ * the corresponding object
+ */
private static Object load( String key )
{
IPreferenceStore store = BrowserUIPlugin.getDefault().getPreferenceStore();
@@ -140,6 +215,14 @@
}
+ /**
+ * Stores the current value of the string-valued property with the given name.
+ *
+ * @param key
+ * the name of the property
+ * @param o
+ * the new current value of the property
+ */
private static void store( String key, Object o )
{
IPreferenceStore store = BrowserUIPlugin.getDefault().getPreferenceStore();
@@ -148,6 +231,14 @@
}
+ /**
+ * Loads the default value for the string-valued property with the given name.
+ *
+ * @param key
+ * the name of the property
+ * @return
+ * the default value of the named property
+ */
private static Object loadDefault( String key )
{
IPreferenceStore store = BrowserUIPlugin.getDefault().getPreferenceStore();
@@ -156,11 +247,18 @@
}
+ /**
+ * Stores the default value for the string-valued property with the given name.
+ *
+ * @param key
+ * the name of the property
+ * @param o
+ * the new default value for the property
+ */
private static void storeDefault( String key, Object o )
{
IPreferenceStore store = BrowserUIPlugin.getDefault().getPreferenceStore();
String s = Utils.serialize( o );
store.setDefault( key, s );
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferencesInitializer.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferencesInitializer.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferencesInitializer.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/BrowserUIPreferencesInitializer.java Mon Jan 8 08:28:22 2007
@@ -38,15 +38,17 @@
import org.eclipse.swt.widgets.Display;
+/**
+ * This class is used to set default preference values.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class BrowserUIPreferencesInitializer extends AbstractPreferenceInitializer
{
-
- public BrowserUIPreferencesInitializer()
- {
- super();
- }
-
-
+ /**
+ * {@inheritDoc}
+ */
public void initializeDefaultPreferences()
{
@@ -210,7 +212,6 @@
// blue
store.setDefault( BrowserUIConstants.PREFERENCE_LDIFEDITOR_SYNTAX_CHANGETYPEMODDN
+ BrowserUIConstants.PREFERENCE_LDIFEDITOR_SYNTAX_STYLE_SUFFIX, SWT.BOLD );
-
}
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/ExceptionHandler.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/ExceptionHandler.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/ExceptionHandler.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/ExceptionHandler.java Mon Jan 8 08:28:22 2007
@@ -28,21 +28,34 @@
import org.eclipse.swt.widgets.Display;
+/**
+ * This class is used to handle exceptions thrown at runtime.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class ExceptionHandler
{
-
- public ExceptionHandler()
- {
- super();
- }
-
-
+ /**
+ * Opens an error dialog to display the given error.
+ *
+ * @param status
+ * the error to show to the user
+ */
public void handleException( IStatus status )
{
display( null, status );
}
+ /**
+ * Opens an error dialog to display the given error.
+ *
+ * @param message
+ * the message to show in this dialog, or null to indicate that the error's message should be shown as the primary message
+ * @param status
+ * the error to show to the user
+ */
private void display( final String message, final IStatus status )
{
Runnable runnable = new Runnable()
@@ -55,5 +68,4 @@
Display.getDefault().asyncExec( runnable );
BrowserCorePlugin.getDefault().getLog().log( status );
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/BrowserAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/BrowserAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/BrowserAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/BrowserAction.java Mon Jan 8 08:28:22 2007
@@ -49,58 +49,90 @@
import org.eclipse.ui.PlatformUI;
+/**
+ * This abstract class must be extended by each Action related to the Browser.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public abstract class BrowserAction implements IWorkbenchWindowActionDelegate
{
-
+ /** The selected Connections */
private IConnection[] selectedConnections;
+ /** The selected Browser View Categories */
private BrowserCategory[] selectedBrowserViewCategories;
+ /** The selected Entries */
private IEntry[] selectedEntries;
+ /** The selected Browser Entry Pages */
private BrowserEntryPage[] selectedBrowserEntryPages;
+ /** The selected Searches */
private ISearch[] selectedSearches;
+ /** The selected Search Results */
private ISearchResult[] selectedSearchResults;
+ /** The selected Browser Search Result Pages */
private BrowserSearchResultPage[] selectedBrowserSearchResultPages;
+ /** The selected Bookmarks */
private IBookmark[] selectedBookmarks;
+ /** The selected Attributes */
private IAttribute[] selectedAttributes;
+ /** The selected Attribute Hierarchies */
private AttributeHierarchy[] selectedAttributeHierarchies;
+ /** The selected Values */
private IValue[] selectedValues;
+ /** The selectec LDIF Model */
private LdifFile selectedLdifModel;
+ /** The selected LDIF Containers */
private LdifContainer[] selectedLdifContainers;
+ /** The selected LDIF Parts */
private LdifPart[] selectedLdifParts;
+ /** The input */
private Object input;
+ /**
+ * Creates a new instance of BrowserAction.
+ */
protected BrowserAction()
{
this.init();
}
+ /**
+ * {@inheritDoc}
+ */
public void init( IWorkbenchWindow window )
{
this.init();
}
+ /**
+ * {@inheritDoc}
+ */
public void run( IAction action )
{
this.run();
}
+ /**
+ * {@inheritDoc}
+ */
public void selectionChanged( IAction action, ISelection selection )
{
setSelectedConnections( SelectionUtils.getConnections( selection ) );
@@ -124,21 +156,67 @@
}
+ /**
+ * Returns the text for this action.
+ * <p>
+ * This method is associated with the <code>TEXT</code> property;
+ * property change events are reported when its value changes.
+ * </p>
+ *
+ * @return the text, or <code>null</code> if none
+ * @see #TEXT
+ */
public abstract String getText();
+ /**
+ * Returns the image for this action as an image descriptor.
+ * <p>
+ * This method is associated with the <code>IMAGE</code> property;
+ * property change events are reported when its value changes.
+ * </p>
+ *
+ * @return the image, or <code>null</code> if this action has no image
+ * @see #IMAGE
+ */
public abstract ImageDescriptor getImageDescriptor();
+ /**
+ * Returns the command identifier.
+ *
+ * @return
+ * the command identifier
+ */
public abstract String getCommandId();
+ /**
+ * Returns whether this action is enabled.
+ * <p>
+ * This method is associated with the <code>ENABLED</code> property;
+ * property change events are reported when its value changes.
+ * </p>
+ *
+ * @return <code>true</code> if enabled, and
+ * <code>false</code> if disabled
+ * @see #ENABLED
+ */
public abstract boolean isEnabled();
+ /**
+ * Runs this action.
+ * Each action implementation must define the steps needed to carry out this action.
+ * The default implementation of this method in <code>Action</code>
+ * does nothing.
+ */
public abstract void run();
+ /**
+ * Initializes this action
+ */
private void init()
{
this.selectedConnections = new IConnection[0];
@@ -161,6 +239,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public void dispose()
{
this.selectedConnections = new IConnection[0];
@@ -183,209 +264,417 @@
}
+ /**
+ * Returns the current active shell
+ *
+ * @return
+ * the current active shell
+ */
protected Shell getShell()
{
return PlatformUI.getWorkbench().getDisplay().getActiveShell();
}
+ /**
+ * This method is fired when an Entry is updated.
+ *
+ * @param event
+ * the associated event
+ */
public final void entryUpdated( EntryModificationEvent event )
{
}
+ /**
+ * This method is fired when a Search is updated.
+ *
+ * @param searchUpdateEvent
+ * the associated event
+ */
public void searchUpdated( SearchUpdateEvent searchUpdateEvent )
{
}
+ /**
+ * This method is fired when a Bookmark is updated.
+ *
+ * @param bookmarkUpdateEvent
+ * the associated event
+ */
public void bookmarkUpdated( BookmarkUpdateEvent bookmarkUpdateEvent )
{
}
+ /**
+ * This method is fired when a Connection is updated.
+ *
+ * @param connectionUpdateEvent
+ * the associated event
+ */
public final void connectionUpdated( ConnectionUpdateEvent connectionUpdateEvent )
{
}
+ /**
+ * Gets the selected Attributes.
+ *
+ * @return
+ * the selected attributes
+ */
public IAttribute[] getSelectedAttributes()
{
return selectedAttributes;
}
+ /**
+ * Sets the selected Attributes.
+ *
+ * @param selectedAttributes
+ * the selected attributes to set
+ */
public void setSelectedAttributes( IAttribute[] selectedAttributes )
{
this.selectedAttributes = selectedAttributes;
}
+ /**
+ * Gets the selected Bookmarks.
+ *
+ * @return
+ * the selected Bookmarks
+ */
public IBookmark[] getSelectedBookmarks()
{
return selectedBookmarks;
}
+ /**
+ * Sets the selected Bookmarks.
+ *
+ * @param selectedBookmarks
+ * the selected Bookmarks to set
+ */
public void setSelectedBookmarks( IBookmark[] selectedBookmarks )
{
this.selectedBookmarks = selectedBookmarks;
}
+ /**
+ * Gets the selected Browser View categories.
+ *
+ * @return
+ * the selected Browser View categories
+ */
public BrowserCategory[] getSelectedBrowserViewCategories()
{
return selectedBrowserViewCategories;
}
+ /**
+ * Sets the selected Browser View categories.
+ *
+ * @param selectedBrowserViewCategories
+ * the selected Browser View categories to set
+ */
public void setSelectedBrowserViewCategories( BrowserCategory[] selectedBrowserViewCategories )
{
this.selectedBrowserViewCategories = selectedBrowserViewCategories;
}
+ /**
+ * Gets the selected Connections.
+ *
+ * @return
+ * the selected Connections
+ */
public IConnection[] getSelectedConnections()
{
return selectedConnections;
}
+ /**
+ * Sets the selected Connections.
+ *
+ * @param selectedConnections
+ * the selected Connections to set
+ */
public void setSelectedConnections( IConnection[] selectedConnections )
{
this.selectedConnections = selectedConnections;
}
+ /**
+ * Get the selected Entries.
+ *
+ * @return
+ */
public IEntry[] getSelectedEntries()
{
return selectedEntries;
}
+ /**
+ * Sets the selected Entries.
+ *
+ * @param selectedEntries
+ * the selected Entries to set
+ */
public void setSelectedEntries( IEntry[] selectedEntries )
{
this.selectedEntries = selectedEntries;
}
+ /**
+ * Gets the selected Searches.
+ *
+ * @return
+ * the selected Searches
+ */
public ISearch[] getSelectedSearches()
{
return selectedSearches;
}
+ /**
+ * Sets the selected Searches.
+ *
+ * @param selectedSearches
+ * the selected Searches to set
+ */
public void setSelectedSearches( ISearch[] selectedSearches )
{
this.selectedSearches = selectedSearches;
}
+ /**
+ * Gets the selected Search Results.
+ *
+ * @return
+ * the selected Search Results
+ */
public ISearchResult[] getSelectedSearchResults()
{
return selectedSearchResults;
}
+ /**
+ * Sets the selected Search Results.
+ *
+ * @param selectedSearchResults
+ * the selected Search Results to set
+ */
public void setSelectedSearchResults( ISearchResult[] selectedSearchResults )
{
this.selectedSearchResults = selectedSearchResults;
}
+ /**
+ * Gets the selected Values.
+ *
+ * @return
+ * the selected Values
+ */
public IValue[] getSelectedValues()
{
return selectedValues;
}
+ /**
+ * Sets the selected Values.
+ *
+ * @param selectedValues
+ * the selected values to set
+ */
public void setSelectedValues( IValue[] selectedValues )
{
this.selectedValues = selectedValues;
}
+ /**
+ * Gets the input.
+ *
+ * @return
+ * the input
+ */
public Object getInput()
{
return input;
}
+ /**
+ * Sets the input.
+ *
+ * @param input
+ * the input to set
+ */
public void setInput( Object input )
{
this.input = input;
}
+ /**
+ * Gets the selected LDIF Containers.
+ *
+ * @return
+ * the selected LDIF Containers
+ */
public LdifContainer[] getSelectedLdifContainers()
{
return selectedLdifContainers;
}
+ /**
+ * Sets the selected LDIF Containers.
+ *
+ * @param selectedLdifContainers
+ * the selected LDIF Containers to set
+ */
public void setSelectedLdifContainers( LdifContainer[] selectedLdifContainers )
{
this.selectedLdifContainers = selectedLdifContainers;
}
+ /**
+ * Gets the selected LDIF Model.
+ *
+ * @return
+ * the selected LDIF Model
+ */
public LdifFile getSelectedLdifModel()
{
return selectedLdifModel;
}
+ /**
+ * Sets the selected LDIF Model.
+ *
+ * @param selectedLdifModel
+ * the selected LDIF Model to set
+ */
public void setSelectedLdifModel( LdifFile selectedLdifModel )
{
this.selectedLdifModel = selectedLdifModel;
}
+ /**
+ * Gets the selected LDIF Parts.
+ *
+ * @return
+ * the selected LDIF Parts
+ */
public LdifPart[] getSelectedLdifParts()
{
return selectedLdifParts;
}
+ /**
+ * Sets the selected LDIF Parts.
+ *
+ * @param selectedLdifParts
+ * the selected LDIF Parts to set
+ */
public void setSelectedLdifParts( LdifPart[] selectedLdifParts )
{
this.selectedLdifParts = selectedLdifParts;
}
+ /**
+ * Gets the selected Browser Entry Pages.
+ *
+ * @return
+ * the selected Browser Entru Pages
+ */
public BrowserEntryPage[] getSelectedBrowserEntryPages()
{
return selectedBrowserEntryPages;
}
+ /**
+ * Sets the selected Browser Entry Pages.
+ *
+ * @param selectedBrowserEntryPages
+ * the selected Browser Entry Pages to set
+ */
public void setSelectedBrowserEntryPages( BrowserEntryPage[] selectedBrowserEntryPages )
{
this.selectedBrowserEntryPages = selectedBrowserEntryPages;
}
+ /**
+ * Gets the selected Browser Search Result Pages.
+ *
+ * @return
+ * the selected Browser Search Result Pages
+ */
public BrowserSearchResultPage[] getSelectedBrowserSearchResultPages()
{
return selectedBrowserSearchResultPages;
}
+ /**
+ * Sets the selected Browser Search Result Pages.
+ *
+ * @param selectedBrowserSearchResultPages
+ * the selected Browser Search result Pages to set
+ */
public void setSelectedBrowserSearchResultPages( BrowserSearchResultPage[] selectedBrowserSearchResultPages )
{
this.selectedBrowserSearchResultPages = selectedBrowserSearchResultPages;
}
+ /**
+ * Gets the selected Attribute Hierarchies.
+ *
+ * @return
+ * the selected Attribute Hierarchies
+ */
public AttributeHierarchy[] getSelectedAttributeHierarchies()
{
return selectedAttributeHierarchies;
}
+ /**
+ * Sets the selected Attribute Hierarchies.
+ *
+ * @param ahs
+ * the selected Attribute Hierarchies to set
+ */
public void setSelectedAttributeHierarchies( AttributeHierarchy[] ahs )
{
this.selectedAttributeHierarchies = ahs;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CloseConnectionAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CloseConnectionAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CloseConnectionAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CloseConnectionAction.java Mon Jan 8 08:28:22 2007
@@ -26,15 +26,17 @@
import org.eclipse.jface.resource.ImageDescriptor;
+/**
+ * This action closes the selected Connection(s).
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CloseConnectionAction extends BrowserAction
{
-
- public CloseConnectionAction()
- {
- super();
- }
-
-
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
for ( int i = 0; i < getSelectedConnections().length; i++ )
@@ -47,18 +49,27 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
return getSelectedConnections().length > 1 ? "Close Connections" : "Close Connection";
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_CONNECTION_DISCONNECT );
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
@@ -78,5 +89,4 @@
}
return getSelectedConnections().length > 0 && canClose;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CollapseAllAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CollapseAllAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CollapseAllAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CollapseAllAction.java Mon Jan 8 08:28:22 2007
@@ -27,12 +27,23 @@
import org.eclipse.jface.viewers.TreeViewer;
+/**
+ * This action collapses all nodes of the viewer's tree, starting with the root.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CollapseAllAction extends Action
{
-
protected TreeViewer viewer;
+ /**
+ * Creates a new instance of CollapseAllAction.
+ *
+ * @param viewer
+ * the attached Viewer
+ */
public CollapseAllAction( TreeViewer viewer )
{
super( "Collapse All", BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_COLLAPSEALL ) );
@@ -43,15 +54,20 @@
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
this.viewer.collapseAll();
}
+ /**
+ * Disposes the action delegate.
+ */
public void dispose()
{
this.viewer = null;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAction.java Mon Jan 8 08:28:22 2007
@@ -45,12 +45,23 @@
import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;
+/**
+ * This class implements the Copy Action
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CopyAction extends BrowserAction
{
-
protected BrowserActionProxy pasteActionProxy;
+ /**
+ * Creates a new instance of CopyAction.
+ *
+ * @param pasteActionProxy
+ * the associated Paste Action
+ */
public CopyAction( BrowserActionProxy pasteActionProxy )
{
super();
@@ -58,6 +69,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
@@ -86,21 +100,29 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return PlatformUI.getWorkbench().getSharedImages().getImageDescriptor( ISharedImages.IMG_TOOL_COPY );
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return IWorkbenchActionDefinitionIds.COPY;
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
-
IConnection[] connections = getConnections();
IEntry[] entries = getEntries();
IValue[] values = getValues();
@@ -169,6 +191,15 @@
}
+ /**
+ * Copies data to Clipboard
+ *
+ * @param data
+ * the data to be set in the clipboard
+ * @param dataTypes
+ * the transfer agents that will convert the data to its platform specific format;
+ * each entry in the data array must have a corresponding dataType
+ */
protected static void copyToClipboard( Object[] data, Transfer[] dataTypes )
{
Clipboard clipboard = null;
@@ -185,6 +216,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
@@ -213,6 +247,12 @@
}
+ /**
+ * Get the Connections
+ *
+ * @return
+ * the Connections
+ */
private IConnection[] getConnections()
{
@@ -230,6 +270,12 @@
}
+ /**
+ * Get the Entries
+ *
+ * @return
+ * the Entries
+ */
private IEntry[] getEntries()
{
if ( getSelectedConnections().length + getSelectedSearches().length + getSelectedAttributeHierarchies().length
@@ -259,6 +305,12 @@
}
+ /**
+ * Get the Values
+ *
+ * @return
+ * the Values
+ */
private IValue[] getValues()
{
if ( getSelectedConnections().length + getSelectedBookmarks().length + getSelectedEntries().length
@@ -290,5 +342,4 @@
return null;
}
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAttributeDescriptionAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAttributeDescriptionAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAttributeDescriptionAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyAttributeDescriptionAction.java Mon Jan 8 08:28:22 2007
@@ -35,14 +35,26 @@
import org.eclipse.swt.dnd.Transfer;
+/**
+ * This class implements the Copy Attribute Description Action.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CopyAttributeDescriptionAction extends BrowserAction
{
+ /**
+ * Creates a new instance of CopyAttributeDescriptionAction.
+ */
public CopyAttributeDescriptionAction()
{
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
StringBuffer text = new StringBuffer();
@@ -62,9 +74,15 @@
}
+ /**
+ * Gets a Set containing all the Attribute Names.
+ *
+ * @return
+ * a Set containing all the Attribute Names
+ */
private Set getAttributeNameSet()
{
- Set attributeNameSet = new LinkedHashSet();
+ Set<String> attributeNameSet = new LinkedHashSet<String>();
for ( int i = 0; i < getSelectedAttributeHierarchies().length; i++ )
{
for ( Iterator it = getSelectedAttributeHierarchies()[i].iterator(); it.hasNext(); )
@@ -85,6 +103,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
if ( getAttributeNameSet().size() > 1 )
@@ -98,21 +119,29 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_COPY_ATT );
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
return getAttributeNameSet().size() > 0;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyDnAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyDnAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyDnAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyDnAction.java Mon Jan 8 08:28:22 2007
@@ -28,14 +28,26 @@
import org.eclipse.swt.dnd.Transfer;
+/**
+ * This class implements the Copy Drag'n'Drop Action.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CopyDnAction extends BrowserAction
{
+ /**
+ * Creates a new instance of CopyDnAction.
+ */
public CopyDnAction()
{
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
String dn = null;
@@ -73,28 +85,39 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
return "Copy DN";
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_COPY_DN );
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
return getSelectedEntries().length + getSelectedSearchResults().length + getSelectedBookmarks().length == 1
|| getSelectedAttributes().length + getSelectedValues().length > 0;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsAction.java Mon Jan 8 08:28:22 2007
@@ -38,15 +38,32 @@
import org.eclipse.swt.widgets.Display;
+/**
+ * This abstract class must be extended by each Action that <em>"Copies an Entry as..."</em>.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public abstract class CopyEntryAsAction extends BrowserAction
{
-
+ /**
+ * Returns DN only Mode.
+ */
public static final int MODE_DN_ONLY = 1;
+ /**
+ * Returns Attributes only Mode.
+ */
public static final int MODE_RETURNING_ATTRIBUTES_ONLY = 2;
+ /**
+ * Normal Mode
+ */
public static final int MODE_NORMAL = 3;
+ /**
+ * Includes Operational Attributes Mode.
+ */
public static final int MODE_INCLUDE_OPERATIONAL_ATTRIBUTES = 4;
protected int mode;
@@ -56,6 +73,14 @@
protected String appendix;
+ /**
+ * Creates a new instance of CopyEntryAsAction.
+ *
+ * @param type
+ * the type of the target
+ * @param mode
+ * the copy Mode
+ */
public CopyEntryAsAction( String type, int mode )
{
super();
@@ -84,6 +109,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
if ( getSelectedEntries().length + getSelectedSearchResults().length + getSelectedBookmarks().length > 0
@@ -108,17 +136,22 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
-
// entries to copy
- List entryList = new ArrayList();
+ List<IEntry> entryList = new ArrayList<IEntry>();
for ( int i = 0; i < getSelectedEntries().length; i++ )
{
entryList.add( getSelectedEntries()[i] );
@@ -151,7 +184,7 @@
IEntry[] entries = ( IEntry[] ) entryList.toArray( new IEntry[entryList.size()] );
// check uninitialized entries
- List uninitializedEntryList = new ArrayList();
+ List<IEntry> uninitializedEntryList = new ArrayList<IEntry>();
for ( int i = 0; entries != null && i < entries.length; i++ )
{
if ( !entries[i].isAttributesInitialized() )
@@ -181,9 +214,20 @@
}
+ /**
+ * Serializes Entries.
+ *
+ * @param entries
+ * the Entries to serialize
+ * @param text
+ * the StringBuffer to serialize to
+ */
protected abstract void serialializeEntries( IEntry[] entries, StringBuffer text );
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
boolean showOperational = BrowserUIPlugin.getDefault().getPreferenceStore().getBoolean(
@@ -210,6 +254,12 @@
}
+ /**
+ * Copies text to Clipboard
+ *
+ * @param text
+ * the Text to copy
+ */
protected void copyToClipboard( String text )
{
Clipboard clipboard = null;
@@ -226,5 +276,4 @@
clipboard.dispose();
}
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsCsvAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsCsvAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsCsvAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsCsvAction.java Mon Jan 8 08:28:22 2007
@@ -42,18 +42,35 @@
import org.eclipse.jface.resource.ImageDescriptor;
+/**
+ * This Action copies entry(ies) as CSV.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CopyEntryAsCsvAction extends CopyEntryAsAction
{
-
+ /**
+ * Table Mode.
+ */
public static final int MODE_TABLE = 5;
+ /**
+ * Creates a new instance of CopyEntryAsCsvAction.
+ *
+ * @param mode
+ * the copy Mode
+ */
public CopyEntryAsCsvAction( int mode )
{
super( "CSV", mode );
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
if ( this.mode == MODE_DN_ONLY )
@@ -83,6 +100,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
if ( this.mode == MODE_TABLE )
@@ -94,6 +114,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
if ( this.mode == MODE_TABLE )
@@ -107,6 +130,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
@@ -116,7 +142,7 @@
&& ( ( ISearch ) getInput() ).getSearchResults() != null
&& ( ( ISearch ) getInput() ).getSearchResults().length > 0 )
{
- List entryList = new ArrayList();
+ List<IEntry> entryList = new ArrayList<IEntry>();
ISearchResult[] results = ( ( ISearch ) getInput() ).getSearchResults();
for ( int k = 0; k < results.length; k++ )
{
@@ -137,6 +163,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public void serialializeEntries( IEntry[] entries, StringBuffer text )
{
@@ -173,7 +202,7 @@
}
else
{
- Map attributeMap = new HashMap();
+ Map<String, IAttribute> attributeMap = new HashMap<String, IAttribute>();
for ( int e = 0; entries != null && e < entries.length; e++ )
{
IAttribute[] attributes = entries[e].getAttributes();
@@ -321,5 +350,4 @@
}
}
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsLdifAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsLdifAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsLdifAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyEntryAsLdifAction.java Mon Jan 8 08:28:22 2007
@@ -41,15 +41,30 @@
import org.eclipse.jface.resource.ImageDescriptor;
+/**
+ * This Action copies entry(ies) as LDIF.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CopyEntryAsLdifAction extends CopyEntryAsAction
{
+ /**
+ * Creates a new instance of CopyEntryAsLdifAction.
+ *
+ * @param mode
+ * the copy Mode
+ */
public CopyEntryAsLdifAction( int mode )
{
super( "LDIF", mode );
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
if ( this.mode == MODE_DN_ONLY )
@@ -71,6 +86,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public void serialializeEntries( IEntry[] entries, StringBuffer text )
{
@@ -136,15 +154,30 @@
}
+ /**
+ * Serializes a Value.
+ *
+ * @param value
+ * the Value to serialize
+ * @param text
+ * the StringBuffer to serialize to
+ */
protected void serializeValue( IValue value, StringBuffer text )
{
text.append( ModelConverter.valueToLdifAttrValLine( value ).toFormattedString() );
}
+ /**
+ * Serialize a DN.
+ *
+ * @param dn
+ * the DN to serialize
+ * @param text
+ * the StringBuffer to serialize to
+ */
protected void serializeDn( DN dn, StringBuffer text )
{
text.append( ModelConverter.dnToLdifDnLine( dn ).toFormattedString() );
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopySearchFilterAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopySearchFilterAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopySearchFilterAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopySearchFilterAction.java Mon Jan 8 08:28:22 2007
@@ -36,26 +36,53 @@
import org.eclipse.swt.dnd.Transfer;
+/**
+ * This Action copies the Search Filter
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CopySearchFilterAction extends BrowserAction
{
+ /**
+ * Equals Mode.
+ */
public static final int MODE_EQUALS = 0;
+ /**
+ * Not Mode.
+ */
public static final int MODE_NOT = 1;
+ /**
+ * And Mode.
+ */
public static final int MODE_AND = 2;
+ /**
+ * Or Mode.
+ */
public static final int MODE_OR = 3;
private int mode;
+ /**
+ * Creates a new instance of CopySearchFilterAction.
+ *
+ * @param mode
+ * the copy Mode
+ */
public CopySearchFilterAction( int mode )
{
this.mode = mode;
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
if ( mode == MODE_EQUALS )
@@ -81,6 +108,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
if ( mode == MODE_EQUALS )
@@ -106,12 +136,18 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
if ( mode == MODE_EQUALS || mode == MODE_NOT )
@@ -135,6 +171,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
@@ -167,6 +206,14 @@
}
+ /**
+ * Gets the filter
+ *
+ * @param filterType
+ * the filter type
+ * @return
+ * the filter
+ */
private String getFilter( String filterType )
{
Set filterSet = new LinkedHashSet();
@@ -213,5 +260,4 @@
return filter.toString();
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyUrlAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyUrlAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyUrlAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyUrlAction.java Mon Jan 8 08:28:22 2007
@@ -30,14 +30,26 @@
import org.eclipse.swt.dnd.Transfer;
+/**
+ * This Action copies the URL of the selected Entry to the Clipboard.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CopyUrlAction extends BrowserAction
{
+ /**
+ * Creates a new instance of CopyUrlAction.
+ */
public CopyUrlAction()
{
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
URL url = null;
@@ -79,29 +91,40 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
return "Copy URL";
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_COPY_URL );
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
return getSelectedSearches().length + getSelectedEntries().length + getSelectedSearchResults().length
+ getSelectedBookmarks().length == 1
|| getSelectedAttributes().length + getSelectedValues().length > 0;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyValueAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyValueAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyValueAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/CopyValueAction.java Mon Jan 8 08:28:22 2007
@@ -40,26 +40,52 @@
import org.eclipse.swt.dnd.Transfer;
+/**
+ * This Action copies the value of the selecte Entry to the Clipboard.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class CopyValueAction extends BrowserAction
{
-
+ /**
+ * UTF8 Mode.
+ */
public static final int MODE_UTF8 = 1;
+ /**
+ * Base64 Mode.
+ */
public static final int MODE_BASE64 = 2;
+ /**
+ * Hexadecimal Mode.
+ */
public static final int MODE_HEX = 3;
+ /**
+ * LDIF Mode.
+ */
public static final int MODE_LDIF = 4;
private int mode;
+ /**
+ * Creates a new instance of CopyValueAction.
+ *
+ * @param mode
+ * the copy Mode
+ */
public CopyValueAction( int mode )
{
this.mode = mode;
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
if ( mode == MODE_UTF8 )
@@ -85,6 +111,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
if ( mode == MODE_UTF8 )
@@ -110,18 +139,27 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
return getValueSet().size() > 0 || getSelectedSearchResults().length > 0;
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
@@ -186,10 +224,15 @@
{ text.toString() }, new Transfer[]
{ TextTransfer.getInstance() } );
}
-
}
+ /**
+ * Gets a Set containing all the Values
+ *
+ * @return
+ * a Set containing all the Values
+ */
protected Set getValueSet()
{
Set valueSet = new LinkedHashSet();
@@ -208,5 +251,4 @@
valueSet.addAll( Arrays.asList( getSelectedValues() ) );
return valueSet;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAction.java Mon Jan 8 08:28:22 2007
@@ -55,15 +55,17 @@
import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;
+/**
+ * This Action implements the Delete Action. It deletes Connections, Entries, Searches, Bookmarks, Attributes or Values.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class DeleteAction extends BrowserAction implements ModelModifier
{
-
- public DeleteAction()
- {
- super();
- }
-
-
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
try
@@ -114,21 +116,29 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return PlatformUI.getWorkbench().getSharedImages().getImageDescriptor( ISharedImages.IMG_TOOL_DELETE );
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return IWorkbenchActionDefinitionIds.DELETE;
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
-
try
{
IConnection[] connections = getConnections();
@@ -351,9 +361,11 @@
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
-
try
{
IConnection[] connections = getConnections();
@@ -372,10 +384,17 @@
// e.printStackTrace();
return false;
}
-
}
+ /**
+ * Gets the Connections
+ *
+ * @return
+ * the Connections
+ * @throws Exception
+ * when a is opened
+ */
protected IConnection[] getConnections() throws Exception
{
for ( int i = 0; i < getSelectedConnections().length; i++ )
@@ -390,6 +409,12 @@
}
+ /**
+ * Deletes Connections
+ *
+ * @param connections
+ * the Connections to delete
+ */
protected void deleteConnections( IConnection[] connections )
{
for ( int i = 0; i < connections.length; i++ )
@@ -399,6 +424,14 @@
}
+ /**
+ * Gets the Entries.
+ *
+ * @return
+ * the Entries
+ * @throws Exception
+ * when an Entry has parent Entries
+ */
protected IEntry[] getEntries() throws Exception
{
LinkedHashSet entriesSet = new LinkedHashSet();
@@ -433,18 +466,37 @@
}
+ /**
+ * Deletes Entries
+ *
+ * @param entries
+ * the Entries to delete
+ */
protected void deleteEntries( IEntry[] entries )
{
new DeleteEntriesJob( entries ).execute();
}
+ /**
+ * Gets the Searches
+ *
+ * @return
+ * the Searches
+ * @throws Exception
+ */
protected ISearch[] getSearches() throws Exception
{
return getSelectedSearches();
}
+ /**
+ * Delete Searches
+ *
+ * @param searches
+ * the Searches to delete
+ */
protected void deleteSearches( ISearch[] searches )
{
for ( int i = 0; i < searches.length; i++ )
@@ -455,12 +507,24 @@
}
+ /**
+ * Get the Bookmarks
+ *
+ * @return
+ * @throws Exception
+ */
protected IBookmark[] getBookmarks() throws Exception
{
return getSelectedBookmarks();
}
+ /**
+ * Delete Bookmarks
+ *
+ * @param bookmarks
+ * the Bookmarks to delete
+ */
protected void deleteBookmarks( IBookmark[] bookmarks )
{
for ( int i = 0; i < bookmarks.length; i++ )
@@ -471,6 +535,13 @@
}
+ /**
+ * Gets the Attributes
+ *
+ * @return
+ * the Attributes
+ * @throws Exception
+ */
protected IAttribute[] getAttributes() throws Exception
{
@@ -559,6 +630,13 @@
}
+ /**
+ * Gets the Values
+ *
+ * @return
+ * the Values
+ * @throws Exception
+ */
protected IValue[] getValues() throws Exception
{
@@ -662,9 +740,16 @@
}
+ /**
+ * Deletes Attributes and Values
+ *
+ * @param attributes
+ * the Attributes to delete
+ * @param values
+ * the Values to delete
+ */
protected void deleteAttributesAndValues( IAttribute[] attributes, IValue[] values )
{
new DeleteAttributesValueJob( attributes, values ).execute();
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAllValuesAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAllValuesAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAllValuesAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/DeleteAllValuesAction.java Mon Jan 8 08:28:22 2007
@@ -30,20 +30,34 @@
import org.eclipse.jface.resource.ImageDescriptor;
+/**
+ * This Action deletes all the values of an Attribute (a whole Attribute).
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class DeleteAllValuesAction extends DeleteAction
{
-
+ /**
+ * Creates a new instance of DeleteAllValuesAction.
+ */
public DeleteAllValuesAction()
{
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
super.run();
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
if ( getSelectedValues().length == 1 )
@@ -57,18 +71,27 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_DELETE_ALL );
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
return super.isEnabled();
@@ -81,6 +104,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
protected IAttribute[] getAttributes() throws Exception
{
if ( getSelectedAttributes().length == 0 && getSelectedValues().length == 1
@@ -101,9 +127,11 @@
}
+ /**
+ * {@inheritDoc}
+ */
protected IValue[] getValues() throws Exception
{
return new IValue[0];
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExecuteLdifAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExecuteLdifAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExecuteLdifAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExecuteLdifAction.java Mon Jan 8 08:28:22 2007
@@ -30,12 +30,23 @@
import org.eclipse.jface.action.Action;
+/**
+ * This Action executes LDIF code.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class ExecuteLdifAction extends Action
{
-
private LdifEditor editor;
+ /**
+ * Creates a new instance of ExecuteLdifAction.
+ *
+ * @param editor
+ * the attached editor
+ */
public ExecuteLdifAction( LdifEditor editor )
{
super( "Execute LDIF", BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_EXECUTE ) );
@@ -43,7 +54,9 @@
this.editor = editor;
}
-
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
@@ -54,10 +67,11 @@
}
-
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
return editor != null && editor.getConnection() != null;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExpandAllAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExpandAllAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExpandAllAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ExpandAllAction.java Mon Jan 8 08:28:22 2007
@@ -27,12 +27,23 @@
import org.eclipse.jface.viewers.TreeViewer;
+/**
+ * This action expands all nodes of the viewer's tree, starting with the root.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class ExpandAllAction extends Action
{
-
protected TreeViewer viewer;
+ /**
+ * Creates a new instance of ExpandAllAction.
+ *
+ * @param viewer
+ * the attached Viewer
+ */
public ExpandAllAction( TreeViewer viewer )
{
super( "Expand All", BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_EXPANDALL ) );
@@ -43,15 +54,20 @@
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
this.viewer.expandAll();
}
+ /**
+ * {@inheritDoc}
+ */
public void dispose()
{
this.viewer = null;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/FilterSubtreeAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/FilterSubtreeAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/FilterSubtreeAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/FilterSubtreeAction.java Mon Jan 8 08:28:22 2007
@@ -31,15 +31,27 @@
import org.eclipse.jface.resource.ImageDescriptor;
+/**
+ * TODO DOCUMENT ME! FilterSubtreeAction.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class FilterSubtreeAction extends BrowserAction
{
+ /**
+ * Creates a new instance of FilterSubtreeAction.
+ */
public FilterSubtreeAction()
{
super();
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
if ( getSelectedEntries().length == 1 )
@@ -69,29 +81,40 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
return "Filter Subtree...";
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_FILTER_DIT );
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
return getSelectedSearches().length + getSelectedSearchResults().length + getSelectedBookmarks().length == 0
&& getSelectedEntries().length == 1
&& ( getSelectedEntries()[0].hasChildren() || getSelectedEntries()[0].getChildrenFilter() != null );
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ImportExportAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ImportExportAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ImportExportAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/ImportExportAction.java Mon Jan 8 08:28:22 2007
@@ -38,24 +38,53 @@
import org.eclipse.jface.wizard.WizardDialog;
+/**
+ * This class implements Import/Export Actions for LDIF, CSV, EXCEL and DSML.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class ImportExportAction extends BrowserAction
{
-
+ /**
+ * LDIF Import Type
+ */
public static final int TYPE_IMPORT_LDIF = 0;
+ /**
+ * LDIF Export Type
+ */
public static final int TYPE_EXPORT_LDIF = 1;
+ /**
+ * CSV Export Type
+ */
public static final int TYPE_EXPORT_CSV = 2;
+ /**
+ * EXCEL Export Type
+ */
public static final int TYPE_EXPORT_EXCEL = 3;
-
+
+ /**
+ * DSML Import Type
+ */
public static final int TYPE_IMPORT_DSML = 4;
-
+
+ /**
+ * DSML Export Type
+ */
public static final int TYPE_EXPORT_DSML = 5;
private int type;
+ /**
+ * Creates a new instance of ImportExportAction.
+ *
+ * @param type
+ * the type of Import/Export
+ */
public ImportExportAction( int type )
{
super();
@@ -63,6 +92,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
if ( this.type == TYPE_IMPORT_LDIF )
@@ -96,6 +128,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
if ( this.type == TYPE_IMPORT_LDIF )
@@ -129,12 +164,18 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
return getEntry() != null || getConnection() != null || getSearch() != null || getConnectionInput() != null;
@@ -142,6 +183,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
IWizard wizard = null;
@@ -212,6 +256,12 @@
}
+ /**
+ * Gets the selected Entry.
+ *
+ * @return
+ * the selected Entry
+ */
protected IEntry getEntry()
{
IEntry entry = null;
@@ -232,6 +282,12 @@
}
+ /**
+ * Gets the Connection.
+ *
+ * @return
+ * the Connection
+ */
protected IConnection getConnection()
{
return getSelectedConnections().length > 0 && getSelectedConnections()[0].isOpened() ? getSelectedConnections()[0]
@@ -239,6 +295,12 @@
}
+ /**
+ * Gets the Search.
+ *
+ * @return
+ * the Search
+ */
protected ISearch getSearch()
{
return getSelectedSearches().length > 0 && getSelectedSearches()[0].getConnection().isOpened() ? getSelectedSearches()[0]
@@ -246,6 +308,12 @@
}
+ /**
+ * Gets the Connection Input.
+ *
+ * @return
+ * the Connection Input
+ */
protected IConnection getConnectionInput()
{
@@ -258,5 +326,4 @@
return null;
}
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java Mon Jan 8 08:28:22 2007
@@ -31,26 +31,43 @@
import org.eclipse.jface.resource.ImageDescriptor;
+/**
+ * TODO DOCUMENT ME! LocateDnInDitAction.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class LocateDnInDitAction extends LocateInDitAction
{
-
+ /**
+ * Creates a new instance of LocateDnInDitAction.
+ */
public LocateDnInDitAction()
{
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
return "Locate DN in DIT";
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return BrowserUIPlugin.getDefault().getImageDescriptor( BrowserUIConstants.IMG_LOCATE_DN_IN_DIT );
}
+ /**
+ * {@inheritDoc}
+ */
protected Object[] getConnectionAndDn()
{
@@ -99,5 +116,4 @@
return null;
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java Mon Jan 8 08:28:22 2007
@@ -26,14 +26,26 @@
import org.eclipse.jface.resource.ImageDescriptor;
+/**
+ * TODO DOCUMENT ME! LocateEntryInDitAction.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class LocateEntryInDitAction extends LocateInDitAction
{
+ /**
+ * Creates a new instance of LocateEntryInDitAction.
+ */
public LocateEntryInDitAction()
{
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
if ( getSelectedSearchResults().length == 1
@@ -54,6 +66,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
if ( getSelectedSearchResults().length == 1
@@ -74,6 +89,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
protected Object[] getConnectionAndDn()
{
if ( getSelectedSearchResults().length == 1
@@ -95,5 +113,4 @@
return null;
}
}
-
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java Mon Jan 8 08:28:22 2007
@@ -34,9 +34,17 @@
import org.eclipse.ui.PlatformUI;
+/**
+ * TODO DOCUMENT ME! LocateInDitAction.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public abstract class LocateInDitAction extends BrowserAction
{
-
+ /**
+ * {@inheritDoc}
+ */
public final void run()
{
Object[] connectionAndDn = getConnectionAndDn();
@@ -79,18 +87,29 @@
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return "org.apache.directory.ldapstudio.browser.action.locateInDit";
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isEnabled()
{
return getConnectionAndDn() != null;
}
+ /**
+ * TODO DOCUMENT ME! getConnectionAndDn.
+ *
+ * @return
+ */
protected abstract Object[] getConnectionAndDn();
}
Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/MoveAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/MoveAction.java?view=diff&rev=494113&r1=494112&r2=494113
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/MoveAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/MoveAction.java Mon Jan 8 08:28:22 2007
@@ -39,15 +39,26 @@
import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;
+/**
+ * This Action moves Entries from on node of the Tree to another.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
public class MoveAction extends BrowserAction implements ModelModifier
{
-
+ /**
+ * Creates a new instance of MoveAction.
+ */
public MoveAction()
{
super();
}
+ /**
+ * {@inheritDoc}
+ */
public String getText()
{
@@ -75,18 +86,27 @@
}
+ /**
+ * {@inheritDoc}
+ */
public ImageDescriptor getImageDescriptor()
{
return null;
}
+ /**
+ * {@inheritDoc}
+ */
public String getCommandId()
{
return IWorkbenchActionDefinitionIds.MOVE;
}
+ /**
+ * {@inheritDoc}
+ */
public void run()
{
@@ -109,6 +129,9 @@
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isEnabled()
{
@@ -128,15 +151,19 @@
}
+ /**
+ * Gets the Entries.
+ *
+ * @return
+ * the Entries
+ */
protected IEntry[] getEntries()
{
-
if ( getSelectedConnections().length + getSelectedBookmarks().length + getSelectedSearches().length
+ getSelectedAttributes().length + getSelectedValues().length == 0
&& getSelectedEntries().length + getSelectedSearchResults().length > 0 )
{
-
- LinkedHashSet entriesSet = new LinkedHashSet();
+ LinkedHashSet<IEntry> entriesSet = new LinkedHashSet<IEntry>();
for ( int i = 0; i < getSelectedEntries().length; i++ )
{
entriesSet.add( getSelectedEntries()[i] );
@@ -160,10 +187,15 @@
{
return new IEntry[0];
}
-
}
+ /**
+ * Opens a Move Entries Dialog and lauches the Move Entries Jobs.
+ *
+ * @param entries
+ * the entries to move
+ */
protected void moveEntries( final IEntry[] entries )
{
MoveEntriesDialog moveDialog = new MoveEntriesDialog( getShell(), entries );
@@ -182,6 +214,12 @@
}
+ /**
+ * Gets the searches.
+ *
+ * @return
+ * the searches
+ */
protected ISearch[] getSearches()
{
if ( getSelectedSearches().length == 1 )
@@ -195,6 +233,12 @@
}
+ /**
+ * Gets the Bookmarks
+ *
+ * @return
+ * the Bookmarks
+ */
protected IBookmark[] getBookmarks()
{
if ( getSelectedBookmarks().length == 1 )
@@ -206,5 +250,4 @@
return new IBookmark[0];
}
}
-
}