/*
* 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.aciitemeditor.widgets;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import org.apache.directory.api.ldap.aci.ProtectedItem;
import org.apache.directory.api.ldap.aci.UserClass;
import org.apache.directory.studio.aciitemeditor.ACIItemValueWithContext;
import org.apache.directory.studio.aciitemeditor.Activator;
import org.apache.directory.studio.aciitemeditor.dialogs.MultiValuedDialog;
import org.apache.directory.studio.aciitemeditor.model.UserClassWrapper;
import org.apache.directory.studio.aciitemeditor.model.UserClassWrapperFactory;
import org.apache.directory.studio.valueeditors.AbstractDialogStringValueEditor;
import org.eclipse.jface.viewers.ArrayContentProvider;
import org.eclipse.jface.viewers.CheckStateChangedEvent;
import org.eclipse.jface.viewers.CheckboxTableViewer;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.ICheckStateListener;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Table;
/**
* This composite contains GUI elements to edit ACI item user classes.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ACIItemUserClassesComposite extends Composite
{
/** The context. */
private ACIItemValueWithContext context;
/** The inner composite for all the content */
private Composite composite = null;
/** The table viewer containing all user classes */
private CheckboxTableViewer tableViewer = null;
/** The edit button */
private Button editButton = null;
/** The possible user classes, used as input for the table viewer */
private UserClassWrapper[] userClassWrappers = UserClassWrapperFactory.createUserClassWrappers();
/**
* Creates a new instance of ACIItemUserClassesComposite.
*
* @param parent
* @param style
*/
public ACIItemUserClassesComposite( Composite parent, int style )
{
super( parent, style );
GridLayout layout = new GridLayout();
layout.horizontalSpacing = 0;
layout.verticalSpacing = 0;
layout.marginHeight = 0;
layout.marginWidth = 0;
setLayout( layout );
GridData layoutData = new GridData();
layoutData.horizontalAlignment = GridData.FILL;
layoutData.grabExcessHorizontalSpace = true;
layoutData.verticalAlignment = GridData.CENTER;
setLayoutData( layoutData );
createComposite();
}
/**
* This method initializes composite
*
*/
private void createComposite()
{
GridData labelGridData = new GridData();
labelGridData.horizontalSpan = 2;
labelGridData.verticalAlignment = GridData.CENTER;
labelGridData.grabExcessHorizontalSpace = true;
labelGridData.horizontalAlignment = GridData.FILL;
GridLayout gridLayout = new GridLayout();
gridLayout.makeColumnsEqualWidth = false;
gridLayout.numColumns = 2;
GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.verticalSpan = 1;
gridData.verticalAlignment = GridData.BEGINNING;
composite = new Composite( this, SWT.NONE );
composite.setLayoutData( gridData );
composite.setLayout( gridLayout );
Label label = new Label( composite, SWT.NONE );
label.setText( Messages.getString( "ACIItemUserClassesComposite.description" ) ); //$NON-NLS-1$
label.setLayoutData( labelGridData );
createTable();
createButtonComposite();
}
/**
* This method initializes table and table viewer
*
*/
private void createTable()
{
GridData tableGridData = new GridData();
tableGridData.grabExcessHorizontalSpace = true;
tableGridData.verticalAlignment = GridData.FILL;
tableGridData.horizontalAlignment = GridData.FILL;
Table table = new Table( composite, SWT.BORDER | SWT.CHECK );
table.setHeaderVisible( false );
table.setLayoutData( tableGridData );
table.setLinesVisible( false );
tableViewer = new CheckboxTableViewer( table );
tableViewer.setContentProvider( new ArrayContentProvider() );
tableViewer.setLabelProvider( new UserClassesLabelProvider() );
tableViewer.setInput( userClassWrappers );
tableViewer.addSelectionChangedListener( new ISelectionChangedListener()
{
@Override
public void selectionChanged( SelectionChangedEvent event )
{
userClassSelected();
}
} );
tableViewer.addCheckStateListener( new ICheckStateListener()
{
@Override
public void checkStateChanged( CheckStateChangedEvent event )
{
userClassChecked();
}
} );
tableViewer.addDoubleClickListener( new IDoubleClickListener()
{
@Override
public void doubleClick( DoubleClickEvent event )
{
if ( editButton.isEnabled() )
{
editUserClass();
}
}
} );
}
/**
* This method initializes buttons
*
*/
private void createButtonComposite()
{
GridData reverseSelectionButtonGridData = new GridData();
reverseSelectionButtonGridData.horizontalAlignment = GridData.FILL;
reverseSelectionButtonGridData.grabExcessHorizontalSpace = false;
reverseSelectionButtonGridData.verticalAlignment = GridData.BEGINNING;
reverseSelectionButtonGridData.widthHint = Activator.getButtonWidth( this );
GridData deselectAllButtonGridData = new GridData();
deselectAllButtonGridData.horizontalAlignment = GridData.FILL;
deselectAllButtonGridData.grabExcessHorizontalSpace = false;
deselectAllButtonGridData.verticalAlignment = GridData.BEGINNING;
deselectAllButtonGridData.widthHint = Activator.getButtonWidth( this );
GridData selectAllButtonGridData = new GridData();
selectAllButtonGridData.horizontalAlignment = GridData.FILL;
selectAllButtonGridData.grabExcessHorizontalSpace = false;
selectAllButtonGridData.verticalAlignment = GridData.BEGINNING;
selectAllButtonGridData.widthHint = Activator.getButtonWidth( this );
GridData editButtonGridData = new GridData();
editButtonGridData.horizontalAlignment = GridData.FILL;
editButtonGridData.grabExcessHorizontalSpace = false;
editButtonGridData.verticalAlignment = GridData.BEGINNING;
editButtonGridData.widthHint = Activator.getButtonWidth( this );
GridLayout gridLayout = new GridLayout();
gridLayout.marginWidth = 0;
gridLayout.marginHeight = 0;
GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.CENTER;
gridData.grabExcessHorizontalSpace = false;
gridData.grabExcessVerticalSpace = false;
gridData.verticalAlignment = GridData.FILL;
Composite buttonComposite = new Composite( composite, SWT.NONE );
buttonComposite.setLayoutData( gridData );
buttonComposite.setLayout( gridLayout );
editButton = new Button( buttonComposite, SWT.NONE );
editButton.setText( Messages.getString( "ACIItemUserClassesComposite.edit.button" ) ); //$NON-NLS-1$
editButton.setLayoutData( editButtonGridData );
editButton.addSelectionListener( new SelectionAdapter()
{
@Override
public void widgetSelected( SelectionEvent event )
{
editUserClass();
}
} );
editButton.setEnabled( false );
Button selectAllButton = new Button( buttonComposite, SWT.NONE );
selectAllButton.setText( Messages.getString( "ACIItemUserClassesComposite.selectAll.button" ) ); //$NON-NLS-1$
selectAllButton.setLayoutData( selectAllButtonGridData );
selectAllButton.addSelectionListener( new SelectionAdapter()
{
@Override
public void widgetSelected( SelectionEvent event )
{
tableViewer.setCheckedElements( userClassWrappers );
refreshTable();
}
} );
Button deselectAllButton = new Button( buttonComposite, SWT.NONE );
deselectAllButton.setText( Messages.getString( "ACIItemUserClassesComposite.deselectAll.button" ) ); //$NON-NLS-1$
deselectAllButton.setLayoutData( deselectAllButtonGridData );
deselectAllButton.addSelectionListener( new SelectionAdapter()
{
@Override
public void widgetSelected( SelectionEvent event )
{
tableViewer.setCheckedElements( new ProtectedItem[0] );
refreshTable();
}
} );
Button reverseSelectionButton = new Button( buttonComposite, SWT.NONE );
reverseSelectionButton.setText( Messages.getString( "ACIItemUserClassesComposite.revert.buton" ) ); //$NON-NLS-1$
reverseSelectionButton.setLayoutData( reverseSelectionButtonGridData );
reverseSelectionButton.addSelectionListener( new SelectionAdapter()
{
@Override
public void widgetSelected( SelectionEvent event )
{
List<Object> elements = new ArrayList<Object>();
elements.addAll( Arrays.asList( userClassWrappers ) );
elements.removeAll( Arrays.asList( tableViewer.getCheckedElements() ) );
tableViewer.setCheckedElements( elements.toArray() );
refreshTable();
}
} );
}
/**
* The label provider used for this table viewer.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
private class UserClassesLabelProvider extends LabelProvider
{
/**
* Returns the error icon if the user class is checked and invalid.
*
* @param element the element
*
* @return the image
*/
public Image getImage( Object element )
{
if ( element instanceof UserClassWrapper )
{
UserClassWrapper wrapper = ( UserClassWrapper ) element;
if ( tableViewer.getChecked( wrapper ) )
{
try
{
wrapper.getUserClass();
}
catch ( ParseException e )
{
return Activator.getDefault().getImage(
Messages.getString( "ACIItemUserClassesComposite.error.icon" ) ); //$NON-NLS-1$
}
}
}
return null;
}
}
/**
* Sets the context.
*
* @param context the context
*/
public void setContext( ACIItemValueWithContext context )
{
this.context = context;
}
/**
* Sets the user classes.
*
* @param userClasses the user classes
*/
public void setUserClasses( Collection<UserClass> userClasses )
{
// reset first
for ( UserClassWrapper userClassWrapper : userClassWrappers )
{
tableViewer.setChecked( userClassWrapper, false );
}
for ( UserClass userClass : userClasses )
{
for ( UserClassWrapper userClassWrapper : userClassWrappers )
{
if ( userClassWrapper.getClazz() == userClass.getClass() )
{
userClassWrapper.setUserClass( userClass );
tableViewer.setChecked( userClassWrapper, true );
}
}
}
refreshTable();
}
/**
* Returns the user classes as selected by the user.
*
* @return the user classes
* @throws ParseException if the user classes or its values are not valid.
*/
public Collection<UserClass> getUserClasses() throws ParseException
{
Collection<UserClass> userClasses = new ArrayList<UserClass>();
for ( UserClassWrapper userClassWrapper : userClassWrappers )
{
if ( tableViewer.getChecked( userClassWrapper ) )
{
UserClass userClass = userClassWrapper.getUserClass();
userClasses.add( userClass );
}
}
return userClasses;
}
/**
* Shows or hides this composite.
*
* @param visible true if visible
*/
public void setVisible( boolean visible )
{
super.setVisible( visible );
if ( visible )
{
( ( GridData ) getLayoutData() ).heightHint = -1;
}
else
{
( ( GridData ) getLayoutData() ).heightHint = 0;
}
}
/**
*
* @return the user class that is selected in the table viewer, or null.
*/
private UserClassWrapper getSelectedUserClassWrapper()
{
IStructuredSelection selection = ( IStructuredSelection ) tableViewer.getSelection();
if ( !selection.isEmpty() )
{
Object element = selection.getFirstElement();
if ( element instanceof UserClassWrapper )
{
return ( UserClassWrapper ) element;
}
}
return null;
}
/**
* Called, when a user class is selected in the table viewer.
* - enables/disables the edit button
*
*/
private void userClassSelected()
{
UserClassWrapper userClassWrapper = getSelectedUserClassWrapper();
if ( ( userClassWrapper == null ) || !userClassWrapper.isEditable() )
{
editButton.setEnabled( false );
}
else
{
editButton.setEnabled( true );
}
}
/**
* Called, when a user class checkbox is checked or unchecked.
*
*/
private void userClassChecked()
{
refreshTable();
}
/**
* Called, when pushing the edit button. Opens the editor.
*/
private void editUserClass()
{
UserClassWrapper userClassWrapper = getSelectedUserClassWrapper();
AbstractDialogStringValueEditor editor = userClassWrapper.getValueEditor();
if ( editor != null )
{
MultiValuedDialog dialog = new MultiValuedDialog( getShell(), userClassWrapper.getDisplayName(),
userClassWrapper.getValues(), context, editor );
dialog.open();
refreshTable();
}
}
/**
* Refreshes the table viewer.
*/
private void refreshTable()
{
tableViewer.refresh();
}
}