org.wings.tree.SDefaultTreeSelectionModel Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings.tree;

import javax.swing.event.TreeSelectionEvent;
import javax.swing.tree.DefaultTreeSelectionModel;
import javax.swing.tree.TreePath;

import java.util.ArrayList;

/**
 * @author Armin Haaf
 */
public class SDefaultTreeSelectionModel
        extends DefaultTreeSelectionModel
        implements STreeSelectionModel {

    /**
     * indicates if we should fire event immediately when they arise, or if we
     * should collect them for a later delivery
     */
    private boolean delayEvents = false;

    /**
     * got a delayed Event?
     */
    protected final ArrayList delayedEvents = new ArrayList();

    public SDefaultTreeSelectionModel() {
        super();
    }

    @Override
    public boolean getDelayEvents() {
        return delayEvents;
    }

    @Override
    public void setDelayEvents(boolean b) {
        delayEvents = b;
    }

    /**
     * fire event with isValueIsAdjusting true
     */
    @Override
    public void fireDelayedIntermediateEvents() {}

    @Override
    public void fireDelayedFinalEvents() {
        for (Object delayedEvent : delayedEvents) {
            TreeSelectionEvent e = (TreeSelectionEvent) delayedEvent;

            fireValueChanged(e);
        }
        delayedEvents.clear();
    }

    @Override
    protected void fireValueChanged(TreeSelectionEvent e) {
        if (delayEvents) {
            delayedEvents.add(e);
        } else {
            super.fireValueChanged(e);
        }
    }


    /**
     * Unique shared instance. No selection possible.
     */
    public static final SDefaultTreeSelectionModel NO_SELECTION_MODEL =
            new SDefaultTreeSelectionModel() {
                /**
                 * A null implementation that selects nothing
                 */
                @Override
                public void setSelectionPaths(TreePath[] pPaths) {
                }

                /**
                 * A null implementation that adds nothing
                 */
                @Override
                public void addSelectionPaths(TreePath[] paths) {
                }

                /**
                 * A null implementation that removes nothing
                 */
                @Override
                public void removeSelectionPaths(TreePath[] paths) {
                }

                // don't fire events, because there should be not state change
                @Override
                protected void fireValueChanged(TreeSelectionEvent e) {}

    };

}