/*
* Copyright (c) 2011, grossmann, Nikolaus Moll
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the jo-widgets.org nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL jo-widgets.org BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*/
package org.jowidgets.spi.impl.swt.common.widgets;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabFolder2Adapter;
import org.eclipse.swt.custom.CTabFolderEvent;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.events.MenuDetectEvent;
import org.eclipse.swt.events.MenuDetectListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.jowidgets.common.types.Dimension;
import org.jowidgets.common.types.Position;
import org.jowidgets.common.types.TabPlacement;
import org.jowidgets.common.widgets.factory.IGenericWidgetFactory;
import org.jowidgets.spi.impl.swt.common.image.SwtImageRegistry;
import org.jowidgets.spi.impl.swt.common.options.SwtOptions;
import org.jowidgets.spi.widgets.ITabFolderSpi;
import org.jowidgets.spi.widgets.ITabItemSpi;
import org.jowidgets.spi.widgets.setup.ITabFolderSetupSpi;
import org.jowidgets.spi.widgets.setup.ITabItemSetupSpi;
import org.jowidgets.util.Assert;
import org.jowidgets.util.TypeCast;
public class TabFolderImpl extends SwtControl implements ITabFolderSpi {
private final IGenericWidgetFactory widgetFactory;
private final SwtImageRegistry imageRegistry;
private final boolean tabsCloseable;
private final Map<CTabItem, TabItemImpl> items;
public TabFolderImpl(
final IGenericWidgetFactory widgetFactory,
final Object parentUiReference,
final ITabFolderSetupSpi setup,
final SwtImageRegistry imageRegistry) {
super(new CTabFolder((Composite) parentUiReference, getStyle(setup)), imageRegistry);
this.tabsCloseable = setup.isTabsCloseable();
this.widgetFactory = widgetFactory;
this.imageRegistry = imageRegistry;
this.items = new HashMap<CTabItem, TabItemImpl>();
getUiReference().setUnselectedImageVisible(true);
getUiReference().setUnselectedCloseVisible(true);
try {
getUiReference().setSimple(SwtOptions.hasClassicTabs());
}
catch (final NoSuchMethodError error) {
//RWT does not support simple=false
}
setMenuDetectListener(new MenuDetectListener() {
@Override
public void menuDetected(final MenuDetectEvent e) {
final Point position = getUiReference().toControl(e.x, e.y);
final CTabItem item = getUiReference().getItem(position);
if (item == null) {
getPopupDetectionObservable().firePopupDetected(new Position(position.x, position.y));
}
else {
final TabItemImpl itemImpl = items.get(item);
getUiReference().setSelection(item);
itemImpl.fireSelected();
itemImpl.firePopupDetected(new Position(position.x, position.y));
}
}
});
getUiReference().addCTabFolder2Listener(new CTabFolder2Adapter() {
@Override
public void close(final CTabFolderEvent event) {
final TabItemImpl itemImpl = items.get(event.item);
if (itemImpl != null) {
final boolean veto = itemImpl.fireOnClose();
if (veto) {
event.doit = false;
}
else {
items.remove(event.item);
itemImpl.fireClosed();
itemImpl.dispose();
}
}
else {
throw new IllegalStateException("CloseEvent for item '"
+ event.item
+ "' that is not attached to this folder. This seems to be a bug.");
}
}
});
getUiReference().addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(final SelectionEvent event) {
final TabItemImpl itemImpl = items.get(event.item);
if (itemImpl != null) {
itemImpl.fireSelected();
}
else {
throw new IllegalStateException("SelectionEvent for item '"
+ event.item
+ "' that is not attached to this folder. This seems to be a bug.");
}
}
});
}
@Override
public CTabFolder getUiReference() {
return (CTabFolder) super.getUiReference();
}
@Override
public void removeItem(final int index) {
final CTabItem item = getUiReference().getItem(index);
items.remove(item);
final Control control = item.getControl();
if (control != null && !control.isDisposed()) {
control.dispose();
}
item.dispose();
}
@Override
public ITabItemSpi addItem(final ITabItemSetupSpi setup) {
final TabItemImpl result = new TabItemImpl(widgetFactory, getUiReference(), tabsCloseable, imageRegistry);
items.put(result.getUiReference(), result);
return result;
}
@Override
public ITabItemSpi addItem(final int index, final ITabItemSetupSpi setup) {
final TabItemImpl result = new TabItemImpl(
widgetFactory,
getUiReference(),
tabsCloseable,
Integer.valueOf(index),
imageRegistry);
items.put(result.getUiReference(), result);
return result;
}
@Override
public void detachItem(final ITabItemSpi item) {
Assert.paramNotNull(item, "item");
final TabItemImpl itemImpl = TypeCast.toType(item, TabItemImpl.class);
if (!items.containsKey(itemImpl.getUiReference())) {
throw new IllegalArgumentException("Item is not attached to this folder");
}
if (itemImpl.isDetached()) {
throw new IllegalArgumentException("Item is already detached");
}
items.remove(item);
itemImpl.detach();
}
@Override
public void attachItem(final ITabItemSpi item) {
Assert.paramNotNull(item, "item");
final TabItemImpl itemImpl = TypeCast.toType(item, TabItemImpl.class);
if (!itemImpl.isDetached()) {
throw new IllegalArgumentException("Item is not detached");
}
itemImpl.attach(getUiReference(), tabsCloseable, null);
items.put(itemImpl.getUiReference(), itemImpl);
}
@Override
public void attachItem(final int index, final ITabItemSpi item) {
Assert.paramNotNull(item, "item");
final TabItemImpl itemImpl = TypeCast.toType(item, TabItemImpl.class);
if (!itemImpl.isDetached()) {
throw new IllegalArgumentException("Item is not detached");
}
itemImpl.attach(getUiReference(), tabsCloseable, Integer.valueOf(index));
items.put(itemImpl.getUiReference(), itemImpl);
}
@Override
public void setSelectedItem(final int index) {
getUiReference().setSelection(index);
final CTabItem selection = getUiReference().getSelection();
if (selection != null) {
final TabItemImpl itemImpl = items.get(selection);
if (itemImpl != null) {
itemImpl.fireSelected();
}
}
}
@Override
public int getSelectedIndex() {
return getUiReference().getSelectionIndex();
}
@Override
public Dimension computeDecoratedSize(final Dimension clientAreaSize) {
Assert.paramNotNull(clientAreaSize, "clientAreaSize");
final org.eclipse.swt.graphics.Rectangle trim = getUiReference().computeTrim(
0,
0,
clientAreaSize.getWidth(),
clientAreaSize.getHeight());
return new Dimension(trim.width, trim.height);
}
private static int getStyle(final ITabFolderSetupSpi setup) {
int result = SWT.BORDER;
if (TabPlacement.BOTTOM == setup.getTabPlacement()) {
result = result | SWT.BOTTOM;
}
else if (TabPlacement.TOP == setup.getTabPlacement()) {
result = result | SWT.TOP;
}
else {
throw new IllegalArgumentException("TabPlacement '" + setup.getTabPlacement() + "' is not known");
}
return result;
}
}