net.sf.fmj.ejmf.toolkit.gui.controls.ActionListenerControl 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.controls;

import java.awt.event.*;
import java.util.*;

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

/**
 * All button controls extends from ActionListenerControl.
 *
 * ActionListenerControl supplies public methods for manipulating a control's
 * EventListener as an ActionListener thereby providing type-safety.
 */

public abstract class ActionListenerControl extends AbstractListenerControl
{
    /**
     * Create an ActionListenerControl
     */
    protected ActionListenerControl(Skin skin)
    {
        super(skin);
    }

    /**
     * Create an ActionListenerControl and associate it with a Controller.
     *
     * @param controller
     *            A Controller with which listener is associated.
     */
    protected ActionListenerControl(Skin skin, Controller controller)
            throws ClassCastException
    {
        super(skin, controller);
        if (!(getControlComponent() instanceof AbstractButton))
        {
            throw new ClassCastException("AbstractButton required");
        }
    }

    /**
     * Add control semantics to this Control.
     * 
     *
     * @param listener
     *            java.util.EventListener representing control semantics to be
     *            added.
     */
    @Override
    protected void addControlListener(EventListener listener)
    {
        getButton().addActionListener((ActionListener) listener);
    }

    private AbstractButton getButton()
    {
        return (AbstractButton) getControlComponent();
    }

    /**
     * Add control semantics to this Control. Remove the listener named by the
     * listener argument.
     * 
     *
     * @param listener
     *            java.util.EventListener representing control semantics to be
     *            removed.
     */
    @Override
    protected void removeControlListener(EventListener listener)
    {
        getButton().removeActionListener((ActionListener) listener);
    }

    /**
     * Type-way to set Control Component.
     */
    public void setComponent(AbstractButton button)
    {
        super.setComponent(button);
    }

    /**
     * Type-way to set Control Component and control listener.
     *
     * @param button
     *            An AbstractButton that serves as Control component.
     * @param listener
     *            An ActionListener that implements Control semantics.
     */
    public void setComponentAndListener(AbstractButton button,
            ActionListener listener)
    {
        super.setComponentAndListener(button, listener);
    }

    /**
     * Type-way to set Control listener.
     *
     * @param listener
     *            An ActionListener that implements Control semantics.
     */
    public void setControlListener(ActionListener listener)
    {
        super.setControlListener(listener);
    }
}