net.sf.fmj.ejmf.toolkit.gui.controlpanel.AbstractControlPanel Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of fmj Show documentation
Freedom for Media in Java
There is a newer version: 1.0.2-jitsi
package net.sf.fmj.ejmf.toolkit.gui.controlpanel;

import java.awt.*;

import javax.media.*;
import javax.swing.*;

import net.sf.fmj.ejmf.toolkit.gui.controls.*;

/**
 * Root class form which custom Control Panels should extends.
 * AbstractControlPanel provides layout a collection Controls provided by
 * AbstractControls reference.
 * 
 * Subclasses must supply definitions of the following methods:
 * 

 * void addComponents(int flags);
 * 
AbstractControls createControls(Player player);
 * 
 */

public abstract class AbstractControlPanel extends JPanel
{
    /**
     * Value for start button control.
     */
    public static final int USE_START_CONTROL = 1;
    /**
     * Value for stop button control.
     */
    public static final int USE_STOP_CONTROL = 2;
    /**
     * Value for reverse button control.
     */
    public static final int USE_REVERSE_CONTROL = 4;
    /**
     * Value for pause button control.
     */
    public static final int USE_PAUSE_CONTROL = 8;
    /**
     * Value for volume control.
     */
    public static final int USE_GAIN_CONTROL = 16;
    /**
     * Value for fast forward control
     */
    public static final int USE_FF_CONTROL = 32;
    /**
     * Value for progress bar control.
     */
    public static final int USE_PROGRESS_CONTROL = 64;

    /**
     * Value for volume meter/mute control
     */
    public static final int USE_GAINMETER_CONTROL = 128;

    private AbstractControls controls;
    protected final Skin skin;

    /**
     * Create a Control Panel with complete suite of Controls
     *
     * @param player
     *            Player with which control panel is associated.
     */
    protected AbstractControlPanel(Skin skin, Player player)
    {
        this(skin, player, 0xffffffff);
    }

    /**
     * Create a Control panel with those Controls identified by flags
     * argument associated with player.
     *
     * @param player
     *            Player with which control panel is associated.
     * @param flags
     *            OR'd value of USE values that determine which control buttons
     *            are displayed.
     */
    protected AbstractControlPanel(Skin skin, Player player, int flags)
    {
        this.skin = skin;
        setControlPanelLayout();
        setControlPanelBorder();
        controls = createControls(player);
        addComponents(flags);
    }

    /**
     * Add appropriate Components to Control Panel.
     *
     * @param flags
     *            Is the bit-wise OR of some number of Control identifiers, e.g.
     *            USE_START_CONTROL. OR'd value of USE values that determine
     *            which control buttons are displayed.
     */
    protected abstract void addComponents(int flags);

    /**
     * Create the Controls to be displayed in the Control Panel.
     *
     * @param player
     *            Playera with which control panel is associated.
     */
    protected abstract AbstractControls createControls(Player player);

    /**
     * Return Control with given name.
     */
    public AbstractListenerControl getControl(String name)
    {
        return controls.getControl(name);
    }

    /**
     * Return AbstractControls managed by this AbstractControlPanel.
     */
    protected AbstractControls getControls()
    {
        return controls;
    }

    /**
     * Remove all control components from the Control panel container.
     */
    protected void removeControlComponents()
    {
        int count = getComponentCount();
        for (int i = 0; i < count; i++)
        {
            remove(i);
        }
    }

    /**
     * Remove the control component identified by c and replace it with
     * withComponent.
     * 
     * If default layout is changed by a subclass, this method may need to be
     * overridden.
     *
     * @param c
     *            Existing component
     * @param withComponent
     *            New component to be installed in control panel.
     */

    protected void replaceControlComponent(Component c, Component withComponent)
    {
        int count = getComponentCount();
        for (int i = 0; i < count; i++)
        {
            if (c == getComponent(i))
            {
                replaceControlComponent(withComponent, i);
                break;
            }
        }
    }

    /**
     * Remove the control component at location atIndex with the
     * component named by withComponent.
     * 

     * If default layout is changed by a subclass, this method may need to be
     * overridden.
     *
     * @param withComponent
     *            New component to be installed in control panel.
     * @param atIndex
     *            Position of component to replace.
     */
    protected void replaceControlComponent(Component withComponent, int atIndex)
    {
        remove(atIndex);
        add(withComponent, atIndex);
    }

    /**
     * Set border of control panel. Subclasses should override this method if
     * they prefer a border different than EtchedBorder.
     */

    protected void setControlPanelBorder()
    {
        setBorder(BorderFactory.createEtchedBorder());
    }

    /**
     * Set layout for control panel. Subclasses override this method to change
     * layout.
     * 
     * Default layout is FlowLayout.
     */
    protected void setControlPanelLayout()
    {
        FlowLayout flow = new FlowLayout();
        flow.setHgap(5);
        setLayout(flow);
    }
}