/*
* 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.common.widgets.entryeditor;
import java.util.HashMap;
import java.util.Map;
import org.apache.directory.studio.ldapbrowser.common.BrowserCommonActivator;
import org.apache.directory.studio.ldapbrowser.common.BrowserCommonConstants;
import org.apache.directory.studio.ldapbrowser.common.actions.CopyAction;
import org.apache.directory.studio.ldapbrowser.common.actions.DeleteAction;
import org.apache.directory.studio.ldapbrowser.common.actions.NewValueAction;
import org.apache.directory.studio.ldapbrowser.common.actions.PropertiesAction;
import org.apache.directory.studio.ldapbrowser.common.actions.SelectAllAction;
import org.apache.directory.studio.ldapbrowser.common.actions.ShowDecoratedValuesAction;
import org.apache.directory.studio.ldapbrowser.common.actions.ValueEditorPreferencesAction;
import org.apache.directory.studio.ldapbrowser.common.actions.proxy.ActionHandlerManager;
import org.apache.directory.studio.ldapbrowser.common.actions.proxy.BrowserActionProxy;
import org.apache.directory.studio.ldapbrowser.common.actions.proxy.EntryEditorActionProxy;
import org.apache.directory.studio.ldapbrowser.core.model.AttributeHierarchy;
import org.apache.directory.studio.ldapbrowser.core.model.IEntry;
import org.apache.directory.studio.utils.ActionUtils;
import org.apache.directory.studio.valueeditors.IValueEditor;
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.IActionBars;
import org.eclipse.ui.actions.ActionFactory;
/**
* The EntryEditorWidgetActionGroup manages all actions of the entry editor widget.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class EntryEditorWidgetActionGroup implements ActionHandlerManager
{
/** The open sort dialog action. */
protected OpenSortDialogAction openSortDialogAction;
/** The show decorated values action. */
protected ShowDecoratedValuesAction showDecoratedValuesAction;
/** The show quick filter action. */
protected ShowQuickFilterAction showQuickFilterAction;
/** The open default editor action. */
protected EntryEditorActionProxy openDefaultValueEditorActionProxy;
/** The open best editor action. */
protected EntryEditorActionProxy openBestValueEditorActionProxy;
/** The open editor actions. */
protected EntryEditorActionProxy[] openValueEditorActionProxies;
/** The open value editor preferences action. */
protected ValueEditorPreferencesAction openValueEditorPreferencesAction;
/** The Constant newValueAction. */
protected final static String NEW_VALUE_ACTION = "newValueAction"; //$NON-NLS-1$
/** The Constant copyAction. */
protected final static String COPY_ACTION = "copyAction"; //$NON-NLS-1$
/** The Constant pasteAction. */
protected final static String PASTE_ACTION = "pasteAction"; //$NON-NLS-1$
/** The Constant deleteAction. */
protected final static String DELETE_ACTION = "deleteAction"; //$NON-NLS-1$
/** The Constant selectAllAction. */
protected final static String SELECT_ALL_ACTION = "selectAllAction"; //$NON-NLS-1$
/** The Constant propertyDialogAction. */
protected final static String PROPERTY_DIALOG_ACTION = "propertyDialogAction"; //$NON-NLS-1$
/** The entry editor action map. */
protected Map<String, EntryEditorActionProxy> entryEditorActionMap;
/** The action bars. */
protected IActionBars actionBars;
/** The main widget. */
private EntryEditorWidget mainWidget;
/**
* Creates a new instance of EntryEditorWidgetActionGroup.
*
* @param mainWidget the main widget
* @param configuration the configuration
*/
public EntryEditorWidgetActionGroup( EntryEditorWidget mainWidget, EntryEditorWidgetConfiguration configuration )
{
this.mainWidget = mainWidget;
entryEditorActionMap = new HashMap<String, EntryEditorActionProxy>();
TreeViewer viewer = mainWidget.getViewer();
ValueEditorManager valueEditorManager = configuration.getValueEditorManager( viewer );
openSortDialogAction = new OpenSortDialogAction( configuration.getPreferences() );
showDecoratedValuesAction = new ShowDecoratedValuesAction();
showQuickFilterAction = new ShowQuickFilterAction( mainWidget.getQuickFilterWidget() );
openBestValueEditorActionProxy = new EntryEditorActionProxy( viewer, new OpenBestEditorAction( viewer,
valueEditorManager, this ) );
openDefaultValueEditorActionProxy = new EntryEditorActionProxy( viewer, new OpenDefaultEditorAction( viewer,
openBestValueEditorActionProxy ) );
IValueEditor[] valueEditors = valueEditorManager.getAllValueEditors();
openValueEditorActionProxies = new EntryEditorActionProxy[valueEditors.length];
for ( int i = 0; i < openValueEditorActionProxies.length; i++ )
{
openValueEditorActionProxies[i] = new EntryEditorActionProxy( viewer, new OpenEditorAction( viewer,
valueEditorManager, valueEditors[i], this ) );
}
openValueEditorPreferencesAction = new ValueEditorPreferencesAction();
entryEditorActionMap.put( NEW_VALUE_ACTION, new EntryEditorActionProxy( viewer, new NewValueAction() ) );
entryEditorActionMap.put( PASTE_ACTION, new EntryEditorActionProxy( viewer, new EntryEditorPasteAction() ) );
entryEditorActionMap.put( COPY_ACTION, new EntryEditorActionProxy( viewer, new CopyAction(
( BrowserActionProxy ) entryEditorActionMap.get( PASTE_ACTION ), valueEditorManager ) ) );
entryEditorActionMap.put( DELETE_ACTION, new EntryEditorActionProxy( viewer, new DeleteAction() ) );
entryEditorActionMap.put( SELECT_ALL_ACTION, new EntryEditorActionProxy( viewer, new SelectAllAction( viewer ) ) );
entryEditorActionMap.put( PROPERTY_DIALOG_ACTION, new EntryEditorActionProxy( viewer, new PropertiesAction() ) );
//viewer.addSelectionChangedListener( entryEditorListener );
}
/**
* Disposes this action group.
*/
public void dispose()
{
if ( mainWidget != null )
{
openSortDialogAction = null;
showQuickFilterAction.dispose();
showQuickFilterAction = null;
showDecoratedValuesAction = null;
openDefaultValueEditorActionProxy.dispose();
openDefaultValueEditorActionProxy = null;
openBestValueEditorActionProxy.dispose();
openBestValueEditorActionProxy = null;
for ( EntryEditorActionProxy action : openValueEditorActionProxies )
{
action.dispose();
}
openValueEditorPreferencesAction = null;
for ( EntryEditorActionProxy action : entryEditorActionMap.values() )
{
action.dispose();
}
entryEditorActionMap.clear();
entryEditorActionMap = null;
actionBars = null;
mainWidget = null;
}
}
/**
* Enables global action handlers.
*
* @param actionBars the action bars
*/
public void enableGlobalActionHandlers( IActionBars actionBars )
{
this.actionBars = actionBars;
// activateGlobalActionHandlers();
}
/**
* Fill the tool bar.
*
* @param toolBarManager the tool bar manager
*/
public void fillToolBar( IToolBarManager toolBarManager )
{
toolBarManager.add( entryEditorActionMap.get( NEW_VALUE_ACTION ) );
toolBarManager.add( new Separator() );
toolBarManager.add( entryEditorActionMap.get( DELETE_ACTION ) );
toolBarManager.add( new Separator() );
toolBarManager.add( showQuickFilterAction );
toolBarManager.update( true );
}
/**
* Fills the menu.
*
* @param menuManager the menu manager
*/
public void fillMenu( IMenuManager menuManager )
{
menuManager.add( openSortDialogAction );
menuManager.add( showDecoratedValuesAction );
menuManager.addMenuListener( new IMenuListener()
{
public void menuAboutToShow( IMenuManager manager )
{
showDecoratedValuesAction.setChecked( !BrowserCommonActivator.getDefault().getPreferenceStore()
.getBoolean( BrowserCommonConstants.PREFERENCE_SHOW_RAW_VALUES ) );
}
} );
}
/**
* Fills the context menu. Adds a menu listener to the given menu manager
* to fill the context menu whenever it pops up.
*
* @param menuManager the menu manager
*/
public void fillContextMenu( IMenuManager menuManager )
{
menuManager.setRemoveAllWhenShown( true );
menuManager.addMenuListener( new IMenuListener()
{
public void menuAboutToShow( IMenuManager manager )
{
contextMenuAboutToShow( manager );
}
} );
}
/**
* Fills the context menu.
*
* @param menuManager the menu manager
*/
protected void contextMenuAboutToShow( IMenuManager menuManager )
{
// new
menuManager.add( entryEditorActionMap.get( NEW_VALUE_ACTION ) );
menuManager.add( new Separator() );
// copy, paste, delete
menuManager.add( entryEditorActionMap.get( COPY_ACTION ) );
menuManager.add( entryEditorActionMap.get( PASTE_ACTION ) );
menuManager.add( entryEditorActionMap.get( DELETE_ACTION ) );
menuManager.add( entryEditorActionMap.get( SELECT_ALL_ACTION ) );
menuManager.add( new Separator() );
// edit
addEditMenu( menuManager );
menuManager.add( new Separator() );
// properties
menuManager.add( entryEditorActionMap.get( PROPERTY_DIALOG_ACTION ) );
}
/**
* Adds the value editors to the menu.
*
* @param menuManager the menu manager
*/
protected void addEditMenu( IMenuManager menuManager )
{
menuManager.add( openDefaultValueEditorActionProxy );
MenuManager editorMenuManager = new MenuManager( Messages
.getString( "EntryEditorWidgetActionGroup.EditValueWith" ) ); //$NON-NLS-1$
if ( openBestValueEditorActionProxy.isEnabled() )
{
editorMenuManager.add( openBestValueEditorActionProxy );
editorMenuManager.add( new Separator() );
}
for ( EntryEditorActionProxy action : openValueEditorActionProxies )
{
if ( action.isEnabled()
&& ( ( OpenEditorAction ) action.getAction() ).getValueEditor().getClass() != ( ( OpenBestEditorAction ) openBestValueEditorActionProxy
.getAction() ).getBestValueEditor().getClass() )
{
editorMenuManager.add( action );
}
}
editorMenuManager.add( new Separator() );
editorMenuManager.add( openValueEditorPreferencesAction );
menuManager.add( editorMenuManager );
}
/**
* Activates global action handlers.
*/
public void activateGlobalActionHandlers()
{
if ( actionBars != null )
{
actionBars.setGlobalActionHandler( ActionFactory.COPY.getId(), entryEditorActionMap.get( COPY_ACTION ) );
actionBars.setGlobalActionHandler( ActionFactory.PASTE.getId(), entryEditorActionMap.get( PASTE_ACTION ) );
actionBars.setGlobalActionHandler( ActionFactory.DELETE.getId(), entryEditorActionMap.get( DELETE_ACTION ) );
actionBars.setGlobalActionHandler( ActionFactory.SELECT_ALL.getId(), entryEditorActionMap
.get( SELECT_ALL_ACTION ) );
actionBars.setGlobalActionHandler( ActionFactory.PROPERTIES.getId(), entryEditorActionMap
.get( PROPERTY_DIALOG_ACTION ) );
actionBars.setGlobalActionHandler( ActionFactory.FIND.getId(), showQuickFilterAction ); // IWorkbenchActionDefinitionIds.FIND_REPLACE
actionBars.updateActionBars();
}
else
{
IAction da = entryEditorActionMap.get( DELETE_ACTION );
da.setActionDefinitionId( BrowserCommonConstants.CMD_DELETE );
ActionUtils.activateActionHandler( da );
IAction ca = entryEditorActionMap.get( COPY_ACTION );
ca.setActionDefinitionId( BrowserCommonConstants.CMD_COPY );
ActionUtils.activateActionHandler( ca );
IAction pa = entryEditorActionMap.get( PASTE_ACTION );
pa.setActionDefinitionId( BrowserCommonConstants.CMD_PASTE );
ActionUtils.activateActionHandler( pa );
showQuickFilterAction.setActionDefinitionId( BrowserCommonConstants.CMD_FIND );
ActionUtils.activateActionHandler( showQuickFilterAction );
IAction pda = entryEditorActionMap.get( PROPERTY_DIALOG_ACTION );
pda.setActionDefinitionId( BrowserCommonConstants.CMD_PROPERTIES );
ActionUtils.activateActionHandler( pda );
}
IAction nva = entryEditorActionMap.get( NEW_VALUE_ACTION );
ActionUtils.activateActionHandler( nva );
ActionUtils.activateActionHandler( openDefaultValueEditorActionProxy );
}
/**
* Deactivates global action handlers.
*/
public void deactivateGlobalActionHandlers()
{
if ( actionBars != null )
{
actionBars.setGlobalActionHandler( ActionFactory.COPY.getId(), null );
actionBars.setGlobalActionHandler( ActionFactory.PASTE.getId(), null );
actionBars.setGlobalActionHandler( ActionFactory.DELETE.getId(), null );
actionBars.setGlobalActionHandler( ActionFactory.SELECT_ALL.getId(), null );
actionBars.setGlobalActionHandler( ActionFactory.FIND.getId(), null );
actionBars.setGlobalActionHandler( ActionFactory.PROPERTIES.getId(), null );
actionBars.updateActionBars();
}
else
{
IAction ca = entryEditorActionMap.get( COPY_ACTION );
ActionUtils.deactivateActionHandler( ca );
IAction pa = entryEditorActionMap.get( PASTE_ACTION );
ActionUtils.deactivateActionHandler( pa );
IAction da = entryEditorActionMap.get( DELETE_ACTION );
ActionUtils.deactivateActionHandler( da );
ActionUtils.deactivateActionHandler( showQuickFilterAction );
IAction pda = entryEditorActionMap.get( PROPERTY_DIALOG_ACTION );
ActionUtils.deactivateActionHandler( pda );
}
IAction nva = entryEditorActionMap.get( NEW_VALUE_ACTION );
ActionUtils.deactivateActionHandler( nva );
ActionUtils.deactivateActionHandler( openDefaultValueEditorActionProxy );
}
/**
* Gets the open default editor action.
*
* @return the open default editor action
*/
public OpenDefaultEditorAction getOpenDefaultEditorAction()
{
return ( OpenDefaultEditorAction ) openDefaultValueEditorActionProxy.getAction();
}
/**
* Sets the input.
*
* @param entry the input
*/
public void setInput( IEntry entry )
{
for ( EntryEditorActionProxy action : entryEditorActionMap.values() )
{
action.inputChanged( entry );
}
}
/**
* Sets the input.
*
* @param attributeHierarchy the attribute hierarchy
*/
public void setInput( AttributeHierarchy attributeHierarchy )
{
for ( EntryEditorActionProxy action : entryEditorActionMap.values() )
{
action.inputChanged( attributeHierarchy );
}
}
}