TabItemImpl.java example

Explorer
jo-widgets-master
/*
 * Copyright (c) 2011, grossmann
 * 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.Collection;
import java.util.HashSet;
import java.util.Set;

import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.jowidgets.common.color.IColorConstant;
import org.jowidgets.common.image.IImageConstant;
import org.jowidgets.common.types.Cursor;
import org.jowidgets.common.types.Dimension;
import org.jowidgets.common.types.Position;
import org.jowidgets.common.types.Rectangle;
import org.jowidgets.common.widgets.IControlCommon;
import org.jowidgets.common.widgets.controller.IComponentListener;
import org.jowidgets.common.widgets.controller.IFocusListener;
import org.jowidgets.common.widgets.controller.IKeyListener;
import org.jowidgets.common.widgets.controller.IMouseListener;
import org.jowidgets.common.widgets.controller.IMouseMotionListener;
import org.jowidgets.common.widgets.controller.IPopupDetectionListener;
import org.jowidgets.common.widgets.descriptor.IWidgetDescriptor;
import org.jowidgets.common.widgets.factory.ICustomWidgetCreator;
import org.jowidgets.common.widgets.factory.IGenericWidgetFactory;
import org.jowidgets.common.widgets.layout.ILayoutDescriptor;
import org.jowidgets.spi.impl.controller.TabItemObservableSpi;
import org.jowidgets.spi.impl.swt.common.image.SwtImageRegistry;
import org.jowidgets.spi.widgets.IPopupMenuSpi;
import org.jowidgets.spi.widgets.ITabItemSpi;

import net.miginfocom.swt.MigLayout;

public class TabItemImpl extends TabItemObservableSpi implements ITabItemSpi {

    private CTabItem cTabItem;
    private boolean detached;
    private Control detachedControl;
    private String text;
    private String toolTipText;
    private IImageConstant icon;

    private final SwtImageRegistry imageRegistry;
    private final CTabFolder parentFolder;
    private final SwtContainer swtContainer;
    private final Set<IPopupDetectionListener> tabPopupDetectionListeners;
    private final Set<PopupMenuImpl> tabPopupMenus;

    public TabItemImpl(
        final IGenericWidgetFactory genericWidgetFactory,
        final CTabFolder parentFolder,
        final boolean closeable,
        final SwtImageRegistry imageRegistry) {
        this(genericWidgetFactory, parentFolder, closeable, null, imageRegistry);
    }

    public TabItemImpl(
        final IGenericWidgetFactory genericWidgetFactory,
        final CTabFolder parentFolder,
        final boolean closeable,
        final Integer index,
        final SwtImageRegistry imageRegistry) {

        this.imageRegistry = imageRegistry;

        this.detached = false;
        this.parentFolder = parentFolder;

        this.tabPopupDetectionListeners = new HashSet<IPopupDetectionListener>();
        this.tabPopupMenus = new HashSet<PopupMenuImpl>();

        cTabItem = createItem(parentFolder, closeable, index);

        final Composite composite = new Composite(parentFolder, SWT.NONE);
        composite.setLayout(new MigLayout("", "[]", "[]"));

        swtContainer = new SwtComposite(genericWidgetFactory, composite, imageRegistry);

        cTabItem.setControl(swtContainer.getUiReference());
    }

    void dispose() {
        if (detachedControl != null && !detachedControl.isDisposed()) {
            detachedControl.dispose();
        }
        final Control control = cTabItem.getControl();
        if (control != null && !control.isDisposed()) {
            control.dispose();
        }
    }

    @Override
    public CTabItem getUiReference() {
        return cTabItem;
    }

    public void detach() {
        detached = true;
        detachedControl = cTabItem.getControl();
        cTabItem.setControl(null);
        cTabItem.dispose();
        cTabItem = null;
    }

    public boolean isDetached() {
        return detached;
    }

    public void attach(final CTabFolder parentFolder, final boolean closeable, final Integer index) {
        cTabItem = createItem(parentFolder, closeable, index);
        setText(text);
        setToolTipText(toolTipText);
        setIcon(icon);

        final Composite composite = (Composite) detachedControl;
        if (composite.getParent() != parentFolder) {
            if (composite.isReparentable()) {
                composite.setParent(parentFolder);
                for (final PopupMenuImpl popupMenu : tabPopupMenus) {
                    popupMenu.setParent(parentFolder);
                }
            }
            else {
                throw new IllegalArgumentException("Content is not reparentable");
            }
        }
        detached = false;
        cTabItem.setControl(composite);
        swtContainer.setComposite(composite);
    }

    @Override
    public boolean isReparentable() {
        final Control control = cTabItem.getControl();
        if (control != null) {
            return control.isReparentable();
        }
        else {
            //workaround to test if potential items can be reparented
            final Composite testComposite = new Composite(parentFolder, SWT.NONE);
            final boolean result = testComposite.isReparentable();
            testComposite.dispose();
            return result;
        }
    }

    @Override
    public void setText(final String text) {
        this.text = text;
        if (text != null) {
            getUiReference().setText(text);
        }
        else {
            getUiReference().setText(String.valueOf(""));
        }
    }

    @Override
    public void setToolTipText(final String toolTipText) {
        this.toolTipText = toolTipText;
        getUiReference().setToolTipText(toolTipText);
    }

    @Override
    public void setIcon(final IImageConstant icon) {
        this.icon = icon;
        final Image oldImage = getUiReference().getImage();
        final Image newImage = imageRegistry.getImage(icon);
        if (oldImage != newImage) {
            getUiReference().setImage(newImage);
        }
    }

    @Override
    public void setVisible(final boolean visible) {
        swtContainer.setVisible(visible);
    }

    @Override
    public boolean isVisible() {
        return swtContainer.isVisible();
    }

    @Override
    public void setEnabled(final boolean enabled) {
        swtContainer.setEnabled(enabled);
    }

    @Override
    public boolean isEnabled() {
        return swtContainer.isEnabled();
    }

    @Override
    public void setTabOrder(final Collection<? extends IControlCommon> tabOrder) {
        swtContainer.setTabOrder(tabOrder);
    }

    @Override
    public <WIDGET_TYPE extends IControlCommon> WIDGET_TYPE add(
        final Integer index,
        final IWidgetDescriptor<? extends WIDGET_TYPE> descriptor,
        final Object layoutConstraints) {
        return swtContainer.add(index, descriptor, layoutConstraints);
    }

    @Override
    public <WIDGET_TYPE extends IControlCommon> WIDGET_TYPE add(
        final Integer index,
        final ICustomWidgetCreator<WIDGET_TYPE> creator,
        final Object layoutConstraints) {
        return swtContainer.add(index, creator, layoutConstraints);
    }

    @Override
    public boolean remove(final IControlCommon control) {
        return swtContainer.remove(control);
    }

    @Override
    public IPopupMenuSpi createPopupMenu() {
        return swtContainer.createPopupMenu();
    }

    @Override
    public IPopupMenuSpi createTabPopupMenu() {
        final PopupMenuImpl result = new PopupMenuImpl(parentFolder, imageRegistry);
        tabPopupMenus.add(result);
        return result;
    }

    @Override
    public void redraw() {
        swtContainer.redraw();
    }

    @Override
    public void setRedrawEnabled(final boolean enabled) {
        swtContainer.setRedrawEnabled(enabled);
    }

    @Override
    public void setForegroundColor(final IColorConstant colorValue) {
        swtContainer.setForegroundColor(colorValue);
    }

    @Override
    public void setBackgroundColor(final IColorConstant colorValue) {
        swtContainer.setBackgroundColor(colorValue);
    }

    @Override
    public IColorConstant getForegroundColor() {
        return swtContainer.getBackgroundColor();
    }

    @Override
    public IColorConstant getBackgroundColor() {
        return swtContainer.getBackgroundColor();
    }

    @Override
    public void setCursor(final Cursor cursor) {
        swtContainer.setCursor(cursor);
    }

    @Override
    public Rectangle getClientArea() {
        return swtContainer.getClientArea();
    }

    @Override
    public Dimension computeDecoratedSize(final Dimension clientAreaSize) {
        return swtContainer.computeDecoratedSize(clientAreaSize);
    }

    @Override
    public Dimension getSize() {
        return swtContainer.getSize();
    }

    @Override
    public void setSize(final Dimension size) {
        swtContainer.setSize(size);
    }

    @Override
    public Position getPosition() {
        return swtContainer.getPosition();
    }

    @Override
    public void setPosition(final Position position) {
        swtContainer.setPosition(position);
    }

    @Override
    public boolean requestFocus() {
        return swtContainer.requestFocus();
    }

    @Override
    public void addFocusListener(final IFocusListener listener) {
        swtContainer.addFocusListener(listener);
    }

    @Override
    public void removeFocusListener(final IFocusListener listener) {
        swtContainer.removeFocusListener(listener);
    }

    @Override
    public void addPopupDetectionListener(final IPopupDetectionListener listener) {
        swtContainer.addPopupDetectionListener(listener);
    }

    @Override
    public void addKeyListener(final IKeyListener listener) {
        swtContainer.addKeyListener(listener);
    }

    @Override
    public void removeKeyListener(final IKeyListener listener) {
        swtContainer.removeKeyListener(listener);
    }

    @Override
    public void addMouseListener(final IMouseListener mouseListener) {
        swtContainer.addMouseListener(mouseListener);
    }

    @Override
    public void removeMouseListener(final IMouseListener mouseListener) {
        swtContainer.removeMouseListener(mouseListener);
    }

    @Override
    public void addMouseMotionListener(final IMouseMotionListener listener) {
        swtContainer.addMouseMotionListener(listener);
    }

    @Override
    public void removeMouseMotionListener(final IMouseMotionListener listener) {
        swtContainer.addMouseMotionListener(listener);
    }

    @Override
    public void addComponentListener(final IComponentListener componentListener) {
        swtContainer.addComponentListener(componentListener);
    }

    @Override
    public void removeComponentListener(final IComponentListener componentListener) {
        swtContainer.removeComponentListener(componentListener);
    }

    @Override
    public void removePopupDetectionListener(final IPopupDetectionListener listener) {
        swtContainer.removePopupDetectionListener(listener);
    }

    @Override
    public void addTabPopupDetectionListener(final IPopupDetectionListener listener) {
        tabPopupDetectionListeners.add(listener);
    }

    @Override
    public void removeTabPopupDetectionListener(final IPopupDetectionListener listener) {
        tabPopupDetectionListeners.remove(listener);
    }

    @Override
    public void setLayout(final ILayoutDescriptor layoutDescriptor) {
        swtContainer.setLayout(layoutDescriptor);
    }

    @Override
    public void layoutBegin() {
        swtContainer.layoutBegin();
    }

    @Override
    public void layoutEnd() {
        swtContainer.layoutEnd();
    }

    @Override
    public void removeAll() {
        swtContainer.removeAll();
    }

    protected void firePopupDetected(final Position position) {
        for (final IPopupDetectionListener listener : tabPopupDetectionListeners) {
            listener.popupDetected(position);
        }
    }

    private static CTabItem createItem(final CTabFolder parentFolder, final boolean closeable, final Integer index) {
        final CTabItem result;
        if (index != null) {
            result = new CTabItem(parentFolder, closeable ? SWT.CLOSE : SWT.NONE, index.intValue());
        }
        else {
            result = new CTabItem(parentFolder, closeable ? SWT.CLOSE : SWT.NONE);
        }
        return result;
    }

}