• Home
• xyz.cofe
• docking-frames-common
• 1.1.2p20b
• source code
• UITransmitter.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

bibliothek.gui.dock.common.intern.ui.UITransmitter Maven / Gradle / Ivy

/*
 * Bibliothek - DockingFrames
 * Library built on Java/Swing, allows the user to "drag and drop"
 * panels containing any Swing-Component the developer likes to add.
 * 
 * Copyright (C) 2007 Benjamin Sigg
 * 
 * This library 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.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Benjamin Sigg
 * [email protected]
 * CH - Switzerland
 */
package bibliothek.gui.dock.common.intern.ui;

import java.util.*;

import bibliothek.gui.dock.common.CControl;
import bibliothek.gui.dock.common.event.CControlListener;
import bibliothek.gui.dock.common.intern.CDockable;
import bibliothek.gui.dock.common.intern.color.ColorTransmitter;
import bibliothek.gui.dock.util.UIBridge;
import bibliothek.gui.dock.util.UIValue;

/**
 * An {@link UITransmitter} listens to some kind of map
 * and updates some {@link UIValue}s when the contents of that map change.
 * @author Benjamin Sigg
 * @param  the kind of value that is described by the {@link UIValue}
 * @param  the kind of {@link UIValue} used in this transmitter
 */
public abstract class UITransmitter> implements UIBridge {
    private CControl control;
    private Set keys = new HashSet();
    private Map> values = new HashMap>();
    private Listener listener = new Listener();
    
    /**
     * Creates a new {@link ColorTransmitter}.
     * @param keys the keys which should be monitored by this transmitter
     */
    public UITransmitter( String... keys ){
        for( String key : keys )
            this.keys.add( key );
    }
    
    public void add( String id, U value ) {
        if( keys.contains( id )){
            boolean empty = values.isEmpty();
            
            List list = values.get( id );
            if( list == null ){
                list = new LinkedList();
                values.put( id, list );
            }
            list.add( value );            
            if( empty )
                setListening( true );
        }
    }
    
    public void remove( String id, U value ) {
        if( keys.contains( id )){
            boolean empty = values.isEmpty();
            
            List list = values.get( id );
            list.remove( value );
            if( list.isEmpty() ){
                values.remove( id );
            }            
            if( !empty && values.isEmpty() )
                setListening( false );
        }
    }
    
    /**
     * Sets the {@link CControl} which should be observed for new {@link CDockable}s
     * by this transmitter.
     * @param control the observed control, can be null
     */
    public void setControl( CControl control ) {
        if( !values.isEmpty() )
            setListening( false );
        
        this.control = control;
        
        if( !values.isEmpty() )
            setListening( true );
    }
    
    /**
     * Adds or removes all listeners from the {@link CControl}.
     * @param listening true if the listeners are to be
     * added, false if they have to be removed
     */
    private void setListening( boolean listening ){
        if( this.control != null ){
            if( listening ){
                control.addControlListener( listener );
                for( int i = 0, n = control.getCDockableCount(); iobserver
     */
    protected abstract V get( V value, String id, U observer );
    
    /**
     * Called when a value in an observed map has changed.
     * @param dockable the owner of the map
     * @param key the name of the changed value
     * @param value the new value in the map, can be null
     */
    protected abstract void update( CDockable dockable, String key, V value );
    
    /**
     * Gets the {@link CDockable} which is associated with observer.
     * @param observer some observer
     * @return the associated dockable or null
     */
    protected abstract CDockable getDockable( U observer );
    
    /**
     * Transmits value to all {@link UIValue}s which
     * listen to the given id and which are associated with dockable.
     * @param id the id of the changed value
     * @param value the new value, might be null
     * @param dockable the associated dockable, might be null
     */
    protected void set( String id, V value, CDockable dockable ){
        List list = values.get( id );
        if( list != null ){
            for( U observer : list ){
                if( dockable == getDockable( observer )){
                    observer.set( value );
                }
            }
        }
    }
    
    /**
     * Adds a listener to dockable and calls
     * {@link #update(CDockable, String, Object)} whenever some value
     * needs an update.
     * @param dockable the element to observe
     */
    protected abstract void connect( CDockable dockable );
    
    /**
     * Removes a listener from dockable.
     * @param dockable the element from which a listener should be removed
     */
    protected abstract void disconnect( CDockable dockable );
    
    /**
     * A listener that gets informed when new maps join or some color in a map
     * changes.
     * @author Benjamin Sigg
     */
    private class Listener implements CControlListener{
        public void added( CControl control, CDockable dockable ) {
            // ignore
        }

        public void removed( CControl control, CDockable dockable ) {
            // ignore
        }

        public void closed( CControl control, CDockable dockable ) {
            disconnect( dockable );
        }

        public void opened( CControl control, CDockable dockable ) {
            connect( dockable );
        }
    }
}