/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.directory.studio.ldapbrowser.ui.editors.entry;
import org.apache.directory.studio.connection.ui.actions.CollapseAllAction;
import org.apache.directory.studio.connection.ui.actions.ExpandAllAction;
import org.apache.directory.studio.ldapbrowser.common.BrowserCommonActivator;
import org.apache.directory.studio.ldapbrowser.common.BrowserCommonConstants;
import org.apache.directory.studio.ldapbrowser.common.actions.DeleteAllValuesAction;
import org.apache.directory.studio.ldapbrowser.common.actions.FetchOperationalAttributesAction;
import org.apache.directory.studio.ldapbrowser.common.actions.NewAttributeAction;
import org.apache.directory.studio.ldapbrowser.common.actions.RefreshAction;
import org.apache.directory.studio.ldapbrowser.common.actions.proxy.EntryEditorActionProxy;
import org.apache.directory.studio.ldapbrowser.common.widgets.entryeditor.EditAttributeDescriptionAction;
import org.apache.directory.studio.ldapbrowser.common.widgets.entryeditor.EntryEditorWidgetActionGroup;
import org.apache.directory.studio.ldapbrowser.common.widgets.entryeditor.OpenDefaultEditorAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.CopyAttributeDescriptionAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.CopyDnAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.CopySearchFilterAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.CopyUrlAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.CopyValueAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.LocateDnInDitAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.NewBatchOperationAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.NewSearchAction;
import org.apache.directory.studio.ldapbrowser.ui.actions.OpenSchemaBrowserAction;
import org.apache.directory.studio.utils.ActionUtils;
import org.apache.directory.studio.valueeditors.ValueEditorManager;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.Separator;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.ui.IWorkbenchActionConstants;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.actions.ActionFactory;
import org.eclipse.ui.actions.ContributionItemFactory;
/**
* The EntryEditorWidgetActionGroup manages all actions of the entry editor.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
*/
public class EntryEditorActionGroup extends EntryEditorWidgetActionGroup
{
/** The show operational attributes action. */
private ShowOperationalAttributesAction showOperationalAttributesAction;
/** The toggle auto save action */
private ToggleAutosaveAction toggleAutosaveAction;
/** The open entry value editor action. */
private EntryEditorActionProxy openEntryValueEditorActionProxy;
/** The open entry editor preference page. */
private OpenEntryEditorPreferencePageAction openEntryEditorPreferencePage;
/** The collapse all action. */
private CollapseAllAction collapseAllAction;
/** The expand all action. */
private ExpandAllAction expandAllAction;
/** The Constant editAttributeDescriptionAction. */
private static final String editAttributeDescriptionAction = "editAttributeDescriptionAction"; //$NON-NLS-1$
/** The Constant refreshAttributesAction. */
private static final String refreshAttributesAction = "refreshAttributesAction"; //$NON-NLS-1$
/** The Constant newAttributeAction. */
private static final String newAttributeAction = "newAttributeAction"; //$NON-NLS-1$
/** The Constant newSearchAction. */
private static final String newSearchAction = "newSearchDialogAction"; //$NON-NLS-1$
/** The Constant newBatchOperationAction. */
private static final String newBatchOperationAction = "newBatchOperationAction"; //$NON-NLS-1$
/** The Constant copyDnAction. */
private static final String copyDnAction = "copyDnAction"; //$NON-NLS-1$
/** The Constant copyUrlAction. */
private static final String copyUrlAction = "copyUrlAction"; //$NON-NLS-1$
/** The Constant copyAttriuteDescriptionAction. */
private static final String copyAttriuteDescriptionAction = "copyAttriuteDescriptionAction"; //$NON-NLS-1$
/** The Constant copyDisplayValueAction. */
private static final String copyDisplayValueAction = "copyDisplayValueAction"; //$NON-NLS-1$
/** The Constant copyValueUtf8Action. */
private static final String copyValueUtf8Action = "copyValueUtf8Action"; //$NON-NLS-1$
/** The Constant copyValueBase64Action. */
private static final String copyValueBase64Action = "copyValueBase64Action"; //$NON-NLS-1$
/** The Constant copyValueHexAction. */
private static final String copyValueHexAction = "copyValueHexAction"; //$NON-NLS-1$
/** The Constant copyValueAsLdifAction. */
private static final String copyValueAsLdifAction = "copyValueAsLdifAction"; //$NON-NLS-1$
/** The Constant copySearchFilterAction. */
private static final String copySearchFilterAction = "copySearchFilterAction"; //$NON-NLS-1$
/** The Constant copyNotSearchFilterAction. */
private static final String copyNotSearchFilterAction = "copyNotSearchFilterAction"; //$NON-NLS-1$
/** The Constant copyAndSearchFilterAction. */
private static final String copyAndSearchFilterAction = "copyAndSearchFilterAction"; //$NON-NLS-1$
/** The Constant copyOrSearchFilterAction. */
private static final String copyOrSearchFilterAction = "copyOrSearchFilterAction"; //$NON-NLS-1$
/** The Constant deleteAllValuesAction. */
private static final String deleteAllValuesAction = "deleteAllValuesAction"; //$NON-NLS-1$
/** The Constant locateDnInDitAction. */
private static final String locateDnInDitAction = "locateDnInDitAction"; //$NON-NLS-1$
/** The Constant showOcdAction. */
private static final String showOcdAction = "showOcdAction"; //$NON-NLS-1$
/** The Constant showAtdAction. */
private static final String showAtdAction = "showAtdAction"; //$NON-NLS-1$
/** The Constant showEqualityMrdAction. */
private static final String showEqualityMrdAction = "showEqualityMrdAction"; //$NON-NLS-1$
/** The Constant showSubstringMrdAction. */
private static final String showSubstringMrdAction = "showSubstringMrdAction"; //$NON-NLS-1$
/** The Constant showOrderingMrdAction. */
private static final String showOrderingMrdAction = "showOrderingMrdAction"; //$NON-NLS-1$
/** The Constant showLsdAction. */
private static final String showLsdAction = "showLsdAction"; //$NON-NLS-1$
/** The Constant fetchOperationalAttributesAction. */
private static final String fetchOperationalAttributesAction = "fetchOperationalAttributesAction"; //$NON-NLS-1$
/**
* Creates a new instance of EntryEditorActionGroup.
*
* @param entryEditor the entry editor
*/
public EntryEditorActionGroup( EntryEditor entryEditor )
{
super( entryEditor.getMainWidget(), entryEditor.getConfiguration() );
TreeViewer viewer = entryEditor.getMainWidget().getViewer();
ValueEditorManager valueEditorManager = entryEditor.getConfiguration().getValueEditorManager( viewer );
// create OpenDefaultEditorAction with enabled rename action flag
openDefaultValueEditorActionProxy.dispose();
openDefaultValueEditorActionProxy = new EntryEditorActionProxy( viewer, new OpenDefaultEditorAction( viewer,
openBestValueEditorActionProxy ) );
openEntryValueEditorActionProxy = new EntryEditorActionProxy( viewer, new OpenEntryEditorAction( viewer,
valueEditorManager, valueEditorManager.getEntryValueEditor(), this ) );
showOperationalAttributesAction = new ShowOperationalAttributesAction();
toggleAutosaveAction = new ToggleAutosaveAction( entryEditor );
openEntryEditorPreferencePage = new OpenEntryEditorPreferencePageAction();
collapseAllAction = new CollapseAllAction( viewer );
expandAllAction = new ExpandAllAction( viewer );
entryEditorActionMap.put( editAttributeDescriptionAction, new EntryEditorActionProxy( viewer,
new EditAttributeDescriptionAction( viewer ) ) );
entryEditorActionMap.put( refreshAttributesAction, new EntryEditorActionProxy( viewer, new RefreshAction() ) );
entryEditorActionMap.put( newAttributeAction, new EntryEditorActionProxy( viewer, new NewAttributeAction() ) );
entryEditorActionMap.put( newSearchAction, new EntryEditorActionProxy( viewer, new NewSearchAction() ) );
entryEditorActionMap.put( newBatchOperationAction, new EntryEditorActionProxy( viewer,
new NewBatchOperationAction() ) );
entryEditorActionMap.put( locateDnInDitAction, new EntryEditorActionProxy( viewer, new LocateDnInDitAction() ) );
entryEditorActionMap.put( showOcdAction, new EntryEditorActionProxy( viewer, new OpenSchemaBrowserAction(
OpenSchemaBrowserAction.MODE_OBJECTCLASS ) ) );
entryEditorActionMap.put( showAtdAction, new EntryEditorActionProxy( viewer, new OpenSchemaBrowserAction(
OpenSchemaBrowserAction.MODE_ATTRIBUTETYPE ) ) );
entryEditorActionMap.put( showEqualityMrdAction, new EntryEditorActionProxy( viewer,
new OpenSchemaBrowserAction( OpenSchemaBrowserAction.MODE_EQUALITYMATCHINGRULE ) ) );
entryEditorActionMap.put( showSubstringMrdAction, new EntryEditorActionProxy( viewer,
new OpenSchemaBrowserAction( OpenSchemaBrowserAction.MODE_SUBSTRINGMATCHINGRULE ) ) );
entryEditorActionMap.put( showOrderingMrdAction, new EntryEditorActionProxy( viewer,
new OpenSchemaBrowserAction( OpenSchemaBrowserAction.MODE_ORDERINGMATCHINGRULE ) ) );
entryEditorActionMap.put( showLsdAction, new EntryEditorActionProxy( viewer, new OpenSchemaBrowserAction(
OpenSchemaBrowserAction.MODE_SYNTAX ) ) );
entryEditorActionMap.put( copyDnAction, new EntryEditorActionProxy( viewer, new CopyDnAction() ) );
entryEditorActionMap.put( copyUrlAction, new EntryEditorActionProxy( viewer, new CopyUrlAction() ) );
entryEditorActionMap.put( copyAttriuteDescriptionAction, new EntryEditorActionProxy( viewer,
new CopyAttributeDescriptionAction() ) );
entryEditorActionMap.put( copyDisplayValueAction, new EntryEditorActionProxy( viewer, new CopyValueAction(
CopyValueAction.Mode.DISPLAY, valueEditorManager ) ) );
entryEditorActionMap.put( copyValueUtf8Action, new EntryEditorActionProxy( viewer, new CopyValueAction(
CopyValueAction.Mode.UTF8, valueEditorManager ) ) );
entryEditorActionMap.put( copyValueBase64Action, new EntryEditorActionProxy( viewer, new CopyValueAction(
CopyValueAction.Mode.BASE64, valueEditorManager ) ) );
entryEditorActionMap.put( copyValueHexAction, new EntryEditorActionProxy( viewer, new CopyValueAction(
CopyValueAction.Mode.HEX, valueEditorManager ) ) );
entryEditorActionMap.put( copyValueAsLdifAction, new EntryEditorActionProxy( viewer, new CopyValueAction(
CopyValueAction.Mode.LDIF, valueEditorManager ) ) );
entryEditorActionMap.put( copySearchFilterAction, new EntryEditorActionProxy( viewer,
new CopySearchFilterAction( CopySearchFilterAction.MODE_EQUALS ) ) );
entryEditorActionMap.put( copyNotSearchFilterAction, new EntryEditorActionProxy( viewer,
new CopySearchFilterAction( CopySearchFilterAction.MODE_NOT ) ) );
entryEditorActionMap.put( copyAndSearchFilterAction, new EntryEditorActionProxy( viewer,
new CopySearchFilterAction( CopySearchFilterAction.MODE_AND ) ) );
entryEditorActionMap.put( copyOrSearchFilterAction, new EntryEditorActionProxy( viewer,
new CopySearchFilterAction( CopySearchFilterAction.MODE_OR ) ) );
entryEditorActionMap.put( deleteAllValuesAction, new EntryEditorActionProxy( viewer,
new DeleteAllValuesAction() ) );
entryEditorActionMap.put( fetchOperationalAttributesAction, new EntryEditorActionProxy( viewer,
new FetchOperationalAttributesAction() ) );
}
/**
* {@inheritDoc}
*/
public void dispose()
{
if ( showOperationalAttributesAction != null )
{
deactivateGlobalActionHandlers();
openEntryValueEditorActionProxy.dispose();
openEntryValueEditorActionProxy = null;
openEntryEditorPreferencePage = null;
showOperationalAttributesAction = null;
toggleAutosaveAction = null;
expandAllAction.dispose();
expandAllAction = null;
collapseAllAction.dispose();
collapseAllAction = null;
}
super.dispose();
}
/**
* {@inheritDoc}
*/
public void fillToolBar( IToolBarManager toolBarManager )
{
toolBarManager.add( new Separator() );
toolBarManager.add( entryEditorActionMap.get( newValueAction ) );
toolBarManager.add( entryEditorActionMap.get( newAttributeAction ) );
toolBarManager.add( new Separator() );
toolBarManager.add( entryEditorActionMap.get( deleteAction ) );
toolBarManager.add( entryEditorActionMap.get( deleteAllValuesAction ) );
toolBarManager.add( new Separator() );
toolBarManager.add( entryEditorActionMap.get( refreshAttributesAction ) );
toolBarManager.add( new Separator() );
toolBarManager.add( expandAllAction );
toolBarManager.add( collapseAllAction );
toolBarManager.add( new Separator() );
toolBarManager.add( showQuickFilterAction );
toolBarManager.update( true );
}
/**
* {@inheritDoc}
*/
public void fillMenu( IMenuManager menuManager )
{
menuManager.add( openSortDialogAction );
menuManager.add( new Separator() );
menuManager.add( showOperationalAttributesAction );
menuManager.add( showDecoratedValuesAction );
menuManager.add( new Separator() );
menuManager.add( toggleAutosaveAction );
menuManager.add( new Separator() );
menuManager.add( openEntryEditorPreferencePage );
menuManager.addMenuListener( new IMenuListener()
{
public void menuAboutToShow( IMenuManager manager )
{
showDecoratedValuesAction.setChecked( !BrowserCommonActivator.getDefault().getPreferenceStore()
.getBoolean( BrowserCommonConstants.PREFERENCE_SHOW_RAW_VALUES ) );
showOperationalAttributesAction.setChecked( BrowserCommonActivator.getDefault().getPreferenceStore()
.getBoolean( BrowserCommonConstants.PREFERENCE_ENTRYEDITOR_SHOW_OPERATIONAL_ATTRIBUTES ) );
toggleAutosaveAction.updateSetChecked();
}
} );
menuManager.update( true );
}
/**
* {@inheritDoc}
*/
protected void contextMenuAboutToShow( IMenuManager menuManager )
{
// new
menuManager.add( entryEditorActionMap.get( newAttributeAction ) );
menuManager.add( entryEditorActionMap.get( newValueAction ) );
menuManager.add( entryEditorActionMap.get( newSearchAction ) );
menuManager.add( entryEditorActionMap.get( newBatchOperationAction ) );
menuManager.add( new Separator() );
// navigation
menuManager.add( entryEditorActionMap.get( locateDnInDitAction ) );
MenuManager schemaMenuManager = new MenuManager( Messages
.getString( "EntryEditorActionGroup.OpenSchemaBrowser" ) ); //$NON-NLS-1$
schemaMenuManager.add( entryEditorActionMap.get( showOcdAction ) );
schemaMenuManager.add( entryEditorActionMap.get( showAtdAction ) );
schemaMenuManager.add( entryEditorActionMap.get( showEqualityMrdAction ) );
schemaMenuManager.add( entryEditorActionMap.get( showSubstringMrdAction ) );
schemaMenuManager.add( entryEditorActionMap.get( showOrderingMrdAction ) );
schemaMenuManager.add( entryEditorActionMap.get( showLsdAction ) );
menuManager.add( schemaMenuManager );
MenuManager showInSubMenu = new MenuManager( Messages.getString( "EntryEditorActionGroup.ShowIn" ) ); //$NON-NLS-1$
showInSubMenu.add( ContributionItemFactory.VIEWS_SHOW_IN.create( PlatformUI.getWorkbench()
.getActiveWorkbenchWindow() ) );
menuManager.add( showInSubMenu );
menuManager.add( new Separator() );
// copy, paste, delete
menuManager.add( entryEditorActionMap.get( copyAction ) );
menuManager.add( entryEditorActionMap.get( pasteAction ) );
menuManager.add( entryEditorActionMap.get( deleteAction ) );
menuManager.add( entryEditorActionMap.get( selectAllAction ) );
MenuManager advancedMenuManager = new MenuManager( Messages.getString( "EntryEditorActionGroup.Advanced" ) ); //$NON-NLS-1$
advancedMenuManager.add( entryEditorActionMap.get( copyDnAction ) );
advancedMenuManager.add( entryEditorActionMap.get( copyUrlAction ) );
advancedMenuManager.add( new Separator() );
advancedMenuManager.add( entryEditorActionMap.get( copyAttriuteDescriptionAction ) );
advancedMenuManager.add( new Separator() );
advancedMenuManager.add( entryEditorActionMap.get( copyDisplayValueAction ) );
advancedMenuManager.add( entryEditorActionMap.get( copyValueUtf8Action ) );
advancedMenuManager.add( entryEditorActionMap.get( copyValueBase64Action ) );
advancedMenuManager.add( entryEditorActionMap.get( copyValueHexAction ) );
advancedMenuManager.add( new Separator() );
advancedMenuManager.add( entryEditorActionMap.get( copyValueAsLdifAction ) );
advancedMenuManager.add( new Separator() );
advancedMenuManager.add( entryEditorActionMap.get( copySearchFilterAction ) );
advancedMenuManager.add( entryEditorActionMap.get( copyNotSearchFilterAction ) );
advancedMenuManager.add( entryEditorActionMap.get( copyAndSearchFilterAction ) );
advancedMenuManager.add( entryEditorActionMap.get( copyOrSearchFilterAction ) );
advancedMenuManager.add( new Separator() );
advancedMenuManager.add( entryEditorActionMap.get( deleteAllValuesAction ) );
menuManager.add( advancedMenuManager );
menuManager.add( new Separator() );
// edit
menuManager.add( entryEditorActionMap.get( editAttributeDescriptionAction ) );
super.addEditMenu( menuManager );
menuManager.add( openEntryValueEditorActionProxy );
menuManager.add( new Separator() );
// refresh
menuManager.add( entryEditorActionMap.get( refreshAttributesAction ) );
if ( entryEditorActionMap.get( fetchOperationalAttributesAction ).isEnabled() )
{
menuManager.add( entryEditorActionMap.get( fetchOperationalAttributesAction ) );
}
menuManager.add( new Separator() );
// additions
menuManager.add( new Separator( IWorkbenchActionConstants.MB_ADDITIONS ) );
// properties
menuManager.add( entryEditorActionMap.get( propertyDialogAction ) );
}
/**
* {@inheritDoc}
*/
public void activateGlobalActionHandlers()
{
if ( actionBars != null )
{
actionBars.setGlobalActionHandler( ActionFactory.REFRESH.getId(), entryEditorActionMap
.get( refreshAttributesAction ) );
}
super.activateGlobalActionHandlers();
IAction naa = entryEditorActionMap.get( newAttributeAction );
ActionUtils.activateActionHandler( naa );
IAction lid = entryEditorActionMap.get( locateDnInDitAction );
ActionUtils.activateActionHandler( lid );
IAction eada = entryEditorActionMap.get( editAttributeDescriptionAction );
ActionUtils.activateActionHandler( eada );
ActionUtils.activateActionHandler( openEntryValueEditorActionProxy );
}
/**
* {@inheritDoc}
*/
public void deactivateGlobalActionHandlers()
{
if ( actionBars != null )
{
actionBars.setGlobalActionHandler( ActionFactory.REFRESH.getId(), null );
}
super.deactivateGlobalActionHandlers();
IAction naa = entryEditorActionMap.get( newAttributeAction );
ActionUtils.deactivateActionHandler( naa );
IAction lid = entryEditorActionMap.get( locateDnInDitAction );
ActionUtils.deactivateActionHandler( lid );
IAction eada = entryEditorActionMap.get( editAttributeDescriptionAction );
ActionUtils.deactivateActionHandler( eada );
ActionUtils.deactivateActionHandler( openEntryValueEditorActionProxy );
}
}