/*******************************************************************************
* Copyright (c) 2005, 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Stefan Dimov, stefan.dimov@sap.com - bug 207826
*******************************************************************************/
/*
* Created on Jan 17, 2005
*/
package org.eclipse.jst.j2ee.internal;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import org.eclipse.core.resources.IProject;
import org.eclipse.jface.viewers.CheckStateChangedEvent;
import org.eclipse.jface.viewers.CheckboxTableViewer;
import org.eclipse.jface.viewers.ICheckStateListener;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jst.j2ee.application.internal.operations.ClassPathSelection;
import org.eclipse.jst.j2ee.application.internal.operations.ClasspathElement;
import org.eclipse.jst.j2ee.componentcore.J2EEModuleVirtualArchiveComponent;
import org.eclipse.jst.j2ee.internal.common.ClasspathModel;
import org.eclipse.jst.j2ee.internal.common.ClasspathModelEvent;
import org.eclipse.jst.j2ee.internal.dialogs.DependencyConflictResolveDialog;
import org.eclipse.jst.j2ee.internal.listeners.IValidateEditListener;
import org.eclipse.jst.j2ee.internal.plugin.J2EEUIMessages;
import org.eclipse.jst.j2ee.internal.project.J2EEProjectUtilities;
import org.eclipse.jst.j2ee.internal.wizard.AvailableJarsProvider;
import org.eclipse.jst.j2ee.project.EarUtilities;
import org.eclipse.jst.j2ee.project.JavaEEProjectUtilities;
import org.eclipse.jst.j2ee.project.facet.IJ2EEFacetConstants;
import org.eclipse.swt.SWT;
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.Event;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.ui.PlatformUI;
import org.eclipse.wst.common.componentcore.ComponentCore;
import org.eclipse.wst.common.componentcore.resources.IVirtualComponent;
import org.eclipse.wst.common.componentcore.resources.IVirtualReference;
/**
* @author jialin
*/
public class ClasspathTableManager implements Listener, ICommonManifestUIConstants {
protected Button useClientJARsBtn;
protected Button useServerJARsBtn;
protected Button useAnyJARsBtn;
protected Button upButton;
protected Button downButton;
protected Button selectAllButton;
protected Button deselectAllButton;
protected IClasspathTableOwner owner;
protected Composite buttonColumn;
protected ClasspathModel model;
protected CheckboxTableViewer availableJARsViewer;
protected IValidateEditListener validateEditListener;
/**
* @deprecated this field should be removed
*/
protected boolean isWLPEntry;
protected Group radioGroup;
protected boolean readOnly;
protected AvailableJarsProvider availableJarsProvider;
protected Button externalJarButton;
protected Button projectJarButton;
protected Button addVariableButton;
protected Set compsToUncheck = new HashSet();
/**
* Constructor for ButtonBarManager.
*/
public ClasspathTableManager(IClasspathTableOwner owner, ClasspathModel model) {
this(owner, model, null);
}
public ClasspathTableManager(IClasspathTableOwner owner, ClasspathModel model, IValidateEditListener listener) {
super();
this.owner = owner;
this.model = model;
this.validateEditListener = listener;
}
public void fillComposite(Composite parent) {
GridLayout layout = new GridLayout();
layout.numColumns = 2;
layout.marginHeight = 0;
parent.setLayout(layout);
parent.setLayoutData(new GridData(GridData.FILL_BOTH));
createRadioGroup(parent);
createTable(parent);
createButtonColumn(parent);
}
public void fillWLPComposite(Composite parent) {
GridLayout layout = new GridLayout();
layout.numColumns = 2;
layout.marginHeight = 0;
parent.setLayout(layout);
parent.setLayoutData(new GridData(GridData.FILL_BOTH));
createTable(parent);
createWLPButtonColumn(parent);
}
public void fillWebRefComposite(Composite parent) {
GridLayout layout = new GridLayout();
layout.numColumns = 2;
layout.marginHeight = 0;
parent.setLayout(layout);
parent.setLayoutData(new GridData(GridData.FILL_BOTH));
createTable(parent);
createWebRefButtonColumn(parent);
}
private void initializeEJBClientDefaults() {
if (model == null || model.getClassPathSelection() == null)
return;
boolean shouldUseServerJARs = false;
ClassPathSelection selection = model.getClassPathSelection();
int filterLevel;
boolean ejbSelected = selection.isAnyEJBJarSelected();
boolean clientSelected = selection.isAnyEJBClientJARSelected();
if (ejbSelected && clientSelected)
filterLevel = ClassPathSelection.FILTER_NONE;
else if (shouldUseServerJARs) {
if (clientSelected)
filterLevel = ClassPathSelection.FILTER_NONE;
else
filterLevel = ClassPathSelection.FILTER_EJB_CLIENT_JARS;
} else {
if (ejbSelected)
filterLevel = ClassPathSelection.FILTER_NONE;
else
filterLevel = ClassPathSelection.FILTER_EJB_SERVER_JARS;
}
initFilterLevel(filterLevel);
}
private void initFilterLevel(int filterLevel) {
model.getClassPathSelection().setFilterLevel(filterLevel);
switch (filterLevel) {
case (ClassPathSelection.FILTER_NONE) :
useAnyJARsBtn.setSelection(true);
useClientJARsBtn.setSelection(false);
useServerJARsBtn.setSelection(false);
break;
case (ClassPathSelection.FILTER_EJB_CLIENT_JARS) :
useAnyJARsBtn.setSelection(false);
useClientJARsBtn.setSelection(false);
useServerJARsBtn.setSelection(true);
break;
case (ClassPathSelection.FILTER_EJB_SERVER_JARS) :
useAnyJARsBtn.setSelection(false);
useClientJARsBtn.setSelection(true);
useServerJARsBtn.setSelection(false);
break;
}
}
private void createRadioGroup(Composite parent) {
radioGroup = owner.createGroup(parent);
radioGroup.setText(EJB_CLIENT_RADIO_UI_);
GridData data = new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_FILL);
data.horizontalSpan = 2;
data.horizontalIndent = 0;
GridLayout layout = new GridLayout(3, false);
radioGroup.setLayout(layout);
radioGroup.setLayoutData(data);
useServerJARsBtn = createRadioButton(USE_EJB_SERVER_JARs_UI_, radioGroup);
useClientJARsBtn = createRadioButton(USE_EJB_CLIENT_JARs_UI_, radioGroup);
useAnyJARsBtn = createRadioButton(USE_BOTH_UI_, radioGroup);
initializeEJBClientDefaults();
}
protected void createButtonColumn(Composite parent) {
buttonColumn = owner.createButtonColumnComposite(parent);
GridData data = new GridData(GridData.HORIZONTAL_ALIGN_END);
buttonColumn.setLayoutData(data);
createPushButtons();
}
protected void createWLPButtonColumn(Composite parent) {
buttonColumn = owner.createButtonColumnComposite(parent);
GridData data = new GridData(GridData.HORIZONTAL_ALIGN_END);
buttonColumn.setLayoutData(data);
createWLPPushButtons();
}
protected void createWebRefButtonColumn(Composite parent) {
buttonColumn = owner.createButtonColumnComposite(parent);
GridData data = new GridData(GridData.HORIZONTAL_ALIGN_END);
buttonColumn.setLayoutData(data);
createWebRefPushButtons();
}
protected void createTable(Composite parent) {
availableJARsViewer = owner.createAvailableJARsViewer(parent);
GridData gd = new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.FILL_VERTICAL);
availableJARsViewer.getTable().setLayoutData(gd);
availableJarsProvider = new AvailableJarsProvider();
availableJARsViewer.setContentProvider(availableJarsProvider);
availableJARsViewer.setLabelProvider(availableJarsProvider);
addTableListeners();
}
protected void createWLPPushButtons() {
selectAllButton = createPushButton(SELECT_ALL_BUTTON);
deselectAllButton = createPushButton(DE_SELECT_ALL_BUTTON);
projectJarButton = createPushButton(J2EEUIMessages.getResourceString("PROJECT_JAR")); //$NON-NLS-1$
externalJarButton = createPushButton(J2EEUIMessages.getResourceString("EXTERNAL_JAR")); //$NON-NLS-1$
addVariableButton = createPushButton(J2EEUIMessages.getResourceString("ADDVARIABLE"));//$NON-NLS-1$
if (isReadOnly()) {
selectAllButton.setEnabled(false);
deselectAllButton.setEnabled(false);
projectJarButton.setEnabled(false);
externalJarButton.setEnabled(false);
addVariableButton.setEnabled(false);
}
}
protected void createWebRefPushButtons() {
selectAllButton = createPushButton(SELECT_ALL_BUTTON);
deselectAllButton = createPushButton(DE_SELECT_ALL_BUTTON);
if (isReadOnly()) {
selectAllButton.setEnabled(false);
deselectAllButton.setEnabled(false);
}
}
protected void createPushButtons() {
upButton = createPushButton(UP_BUTTON);
downButton = createPushButton(DOWN_BUTTON);
selectAllButton = createPushButton(SELECT_ALL_BUTTON);
deselectAllButton = createPushButton(DE_SELECT_ALL_BUTTON);
if (isReadOnly()) {
upButton.setEnabled(false);
downButton.setEnabled(false);
selectAllButton.setEnabled(false);
deselectAllButton.setEnabled(false);
}
}
protected void createWebLibPushButtons() {
selectAllButton = createPushButton(SELECT_ALL_BUTTON);
deselectAllButton = createPushButton(DE_SELECT_ALL_BUTTON);
projectJarButton = createPushButton(J2EEUIMessages.getResourceString("PROJECT_JAR")); //$NON-NLS-1$
externalJarButton = createPushButton(J2EEUIMessages.getResourceString("EXTERNAL_JAR")); //$NON-NLS-1$
addVariableButton = createPushButton(J2EEUIMessages.getResourceString("ADDVARIABLE"));//$NON-NLS-1$
if (isReadOnly()) {
selectAllButton.setEnabled(false);
deselectAllButton.setEnabled(false);
}
}
protected Button createPushButton(String label) {
Button aButton = owner.primCreatePushButton(label, buttonColumn);
aButton.addListener(SWT.Selection, this);
aButton.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
return aButton;
}
protected Button createRadioButton(String label, Composite parent) {
Button aButton = owner.primCreateRadioButton(label, parent);
aButton.addListener(SWT.Selection, this);
return aButton;
}
/**
* @see Listener#handleEvent(Event)
*/
public void handleEvent(Event event) {
ClasspathModelEvent evt = new ClasspathModelEvent(ClasspathModelEvent.CLASS_PATH_CHANGED);
model.fireNotification(evt);
if (event.widget == upButton)
upButtonSelected();
else if (event.widget == downButton)
downButtonSelected();
else if (event.widget == selectAllButton)
selectAllButtonSelected();
else if (event.widget == deselectAllButton)
deselectAllButtonSelected();
else if (event.widget == useServerJARsBtn)
handleServerJARsButtonSelected();
else if (event.widget == useClientJARsBtn)
handleClientJARsButtonSelected();
else if (event.widget == useAnyJARsBtn)
handleAnyJARsButtonSelected();
else if(event.widget == projectJarButton)
handleSelectProjectJarButton();
else if(event.widget == externalJarButton)
handleSelectExternalJarButton();
else if(event.widget == addVariableButton)
handleSelectVariableButton();
}
private void handleSelectExternalJarButton(){
//owner.handleSelectExternalJarButton();
if( owner instanceof WebLibDependencyPropertiesPage){
WebLibDependencyPropertiesPage control = (WebLibDependencyPropertiesPage)owner;
control.handleSelectExternalJarButton();
}
}
private void handleSelectProjectJarButton(){
//owner.handleSelectExternalJarButton();
if( owner instanceof WebLibDependencyPropertiesPage){
WebLibDependencyPropertiesPage control = (WebLibDependencyPropertiesPage)owner;
control.handleSelectProjectJarButton();
}
}
private void handleSelectVariableButton(){
//owner.handleSelectVariableButton();
if( owner instanceof WebLibDependencyPropertiesPage){
WebLibDependencyPropertiesPage control = (WebLibDependencyPropertiesPage)owner;
control.handleSelectVariableButton();
}
}
private void handleServerJARsButtonSelected() {
model.selectFilterLevel(ClassPathSelection.FILTER_EJB_CLIENT_JARS);
refresh();
}
private void handleClientJARsButtonSelected() {
model.selectFilterLevel(ClassPathSelection.FILTER_EJB_SERVER_JARS);
refresh();
}
private void handleAnyJARsButtonSelected() {
model.selectFilterLevel(ClassPathSelection.FILTER_NONE);
refresh();
}
public boolean validatateEdit() {
return validateEditListener.validateState().isOK();
}
protected void deselectAllButtonSelected() {
if (!validatateEdit())
return;
availableJARsViewer.setAllChecked(false);
model.setAllClasspathElementsSelected(false);
compsToUncheck.clear();
}
protected void selectAllButtonSelected() {
if (!validatateEdit())
return;
availableJARsViewer.setAllChecked(true);
Object[] elements = availableJARsViewer.getCheckedElements();
model.setAllClasspathElementsSelected(Arrays.asList(elements), true);
for (int i = 0; i < elements.length; i++) {
ClasspathElement el = (ClasspathElement)elements[i];
el.getComponent().getAdapter(IVirtualComponent.class);
IVirtualComponent ar = el.getTargetComponent();
IVirtualComponent comp = (ar instanceof J2EEModuleVirtualArchiveComponent) ? ar : el.getComponent();
if (isLibrary(comp))
compsToUncheck.add(comp);
}
}
protected java.util.List getSelectionAsList() {
return ((IStructuredSelection) availableJARsViewer.getSelection()).toList();
}
protected java.util.List getCheckedLibsAsList() {
List res = new LinkedList();
Iterator it = compsToUncheck.iterator();
while (it.hasNext()) {
IVirtualComponent comp = (IVirtualComponent)it.next();
res.add(comp);
}
return res;
}
protected void downButtonSelected() {
if (!validatateEdit())
return;
model.moveDown(getSelectionAsList());
refresh();
}
protected void upButtonSelected() {
if (!validatateEdit())
return;
model.moveUp(getSelectionAsList());
refresh();
}
/*
* Updates the enable state of the all buttons
*/
protected void updateButtonEnablements() {
int[] indices = availableJARsViewer.getTable().getSelectionIndices();
if (upButton != null && downButton != null) {
upButton.setEnabled(canMoveUp(indices));
downButton.setEnabled(canMoveDown(indices, availableJARsViewer.getTable().getItemCount()));
}
}
protected boolean canMoveUp(int[] indices) {
return canMove(indices, 0);
}
protected boolean canMoveDown(int[] indices, int itemCount) {
return canMove(indices, itemCount - 1);
}
protected boolean canMove(int[] indices, int referenceIndex) {
int length = indices.length;
if (length == 0)
return false;
for (int i = 0; i < length; i++) {
if (indices[i] == referenceIndex)
return false;
}
return true;
}
protected void addTableListeners() {
addCheckStateListener();
addSelectionListener();
}
protected void addCheckStateListener() {
availableJARsViewer.addCheckStateListener(new ICheckStateListener() {
public void checkStateChanged(CheckStateChangedEvent event) {
availableJARCheckStateChanged(event);
}
});
}
private boolean isLibrary(IVirtualComponent component) {
if (JavaEEProjectUtilities.isApplicationClientComponent(component)) return false;
if (JavaEEProjectUtilities.isEARProject(component.getProject()) && component.isBinary()) return true;
if (JavaEEProjectUtilities.isEJBComponent(component)) return false;
if (JavaEEProjectUtilities.isDynamicWebComponent(component)) return false;
if (JavaEEProjectUtilities.isJCAComponent(component)) return false;
if (JavaEEProjectUtilities.isStaticWebProject(component.getProject())) return false;
if (JavaEEProjectUtilities.isProjectOfType(component.getProject(), IJ2EEFacetConstants.JAVA)) return true;
return true;
}
protected void availableJARCheckStateChanged(CheckStateChangedEvent event) {
ClasspathElement el = (ClasspathElement)event.getElement();
//226823 targeting a regular java project from web libs
if(el.getComponent() == null){
ClasspathElement element = (ClasspathElement) event.getElement();
model.setSelection(element, event.getChecked());
return;
}
el.getComponent().getAdapter(IVirtualComponent.class);
IVirtualComponent ar = el.getTargetComponent();
IVirtualComponent comp = (ar instanceof J2EEModuleVirtualArchiveComponent) ? ar : el.getComponent();
CheckboxTableViewer v = (CheckboxTableViewer)event.getSource();
if (isLibrary(comp) && event.getChecked()) {
if (isConflict(comp)) {
DependencyConflictResolveDialog dlg = new DependencyConflictResolveDialog(PlatformUI.
getWorkbench().
getActiveWorkbenchWindow().
getShell(),
DependencyConflictResolveDialog.DLG_TYPE_1);
if (dlg.open() == DependencyConflictResolveDialog.BTN_ID_CANCEL) {
v.setChecked(el, false);
return;
}
}
compsToUncheck.add(comp);
} else if (!event.getChecked()) {
compsToUncheck.remove(comp);
}
if (!EarUtilities.isStandaloneProject(model.getComponent().getProject()) && (isReadOnly() || !validatateEdit() || (isMyClientJAR(event) && !event.getChecked()))) {
availableJARsViewer.setChecked(event.getElement(), !event.getChecked());
return;
}
ClasspathElement element = (ClasspathElement) event.getElement();
model.setSelection(element, event.getChecked());
}
private boolean isConflict(IVirtualComponent lib) {
IProject[] ears = EarUtilities.getReferencingEARProjects(lib.getProject());
for (int i = 0; i < ears.length; i++) {
if (J2EEProjectUtilities.isJEEProject(ears[i])) {
IVirtualComponent cmp = ComponentCore.createComponent(ears[i]);
IVirtualReference[] refs = cmp.getReferences();
for (int j = 0; j < refs.length; j++) {
if (model.getProject().equals(refs[j].getReferencedComponent().getProject())) {
IVirtualReference ref = cmp.getReference(lib.getName());
if (ref != null && !ref.getRuntimePath().isRoot()) return true;
}
}
}
}
return false;
}
/**
* @param event
* @return
*/
private boolean isMyClientJAR(CheckStateChangedEvent event) {
ClasspathElement element = (ClasspathElement) event.getElement();
if(getClasspathSelection() != null)
return getClasspathSelection().isMyClientJAR(element);
return false;
}
protected void addSelectionListener() {
availableJARsViewer.addSelectionChangedListener(new ISelectionChangedListener() {
public void selectionChanged(SelectionChangedEvent event) {
tableSelectionChanged();
}
});
}
protected void tableSelectionChanged() {
if (!isReadOnly())
updateButtonEnablements();
}
protected ClassPathSelection getClasspathSelection() {
if (model == null || model.getSelectedEARComponent() == null && !(EarUtilities.isStandaloneProject(model.getComponent().getProject())))
return null;
return model.getClassPathSelection();
}
public void refreshCheckedItems() {
if (getClasspathSelection() == null)
return;
java.util.List elements = getClasspathSelection().getClasspathElements();
for (int i = 0; i < elements.size(); i++) {
ClasspathElement element = (ClasspathElement) elements.get(i);
availableJARsViewer.setChecked(element, element.isSelected());
if (element.isClasspathDependency()) {
availableJARsViewer.setGrayed(element, true);
}
}
}
public void refresh() {
final IProject project = model.getComponent().getProject();
// if not a web project and it is either referenced by an EAR or a dynamic web project.
if (!isWLPEntry() && (!EarUtilities.isStandaloneProject(project) ||
(J2EEProjectUtilities.getReferencingWebProjects(project).length > 0))) {
availableJARsViewer.setInput(getClasspathSelection());
GridData data = new GridData(GridData.FILL_BOTH);
int numlines = Math.min(10, availableJARsViewer.getTable().getItemCount());
data.heightHint = availableJARsViewer.getTable().getItemHeight() * numlines;
availableJARsViewer.getTable().setLayoutData(data);
refreshCheckedItems();
updateButtonEnablements();
} else {
availableJARsViewer.setInput(model.getClassPathSelectionForWLPs());
GridData data = new GridData(GridData.FILL_BOTH);
int numlines = Math.min(10, availableJARsViewer.getTable().getItemCount());
data.heightHint = availableJARsViewer.getTable().getItemHeight() * numlines;
availableJARsViewer.getTable().setLayoutData(data);
refreshWLPCheckedItems();
}
}
private void refreshWLPCheckedItems() {
if (availableJARsViewer.getInput() != null) {
java.util.List elements = ((ClassPathSelection) availableJARsViewer.getInput()).getClasspathElements();
for (int i = 0; i < elements.size(); i++) {
ClasspathElement element = (ClasspathElement) elements.get(i);
availableJARsViewer.setChecked(element, element.isSelected());
if (element.isClasspathDependency()) {
availableJARsViewer.setGrayed(element, true);
}
}
}
}
/**
* Gets the model.
* @return Returns a ClasspathModel
*/
public ClasspathModel getModel() {
return model;
}
/**
* Sets the model.
* @param model The model to set
*/
public void setModel(ClasspathModel model) {
this.model = model;
initializeEJBClientDefaults();
}
/**
* Returns the readOnly.
* @return boolean
*/
public boolean isReadOnly() {
return readOnly;
}
/**
* Sets the readOnly.
* @param readOnly The readOnly to set
*/
public void setReadOnly(boolean readOnly) {
this.readOnly = readOnly;
}
public boolean isWLPEntry() {
return model.isWLPModel();
}
/**
* @deprecated do not use this method
* @param isWLPEntry
*/
public void setWLPEntry(boolean isWLPEntry) {
this.isWLPEntry = isWLPEntry;
}
}