net.sf.fmj.media.AbstractControls 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.media;

import javax.media.*;

import net.sf.fmj.utility.*;

/**
 *
 * Abstract implementation of Controls, useful for subclassing.
 *
 * @author Ken Larson
 * @author Warren Bloomer
 *
 */
public abstract class AbstractControls implements Controls
{
    /**
     * A collection of Objects that allows retrieval of objects based on
     * classname
     */
    private final ControlCollection controls = new ControlCollection();

    /**
     * Called by subclasses of this Abstract class to add a control.
     *
     * @param control
     *            The control object to add to the controls list.
     */
    protected void addControl(Control control)
    {
        controls.addControl(control);
    }

    /**
     * Retrieve the first object that implements the given Class or Interface.
     * The full class name must be used. If the control is not supported then
     * null is returned.
     *
     * @return the object that implements the control, or null.
     */
    public Object getControl(String controlType)
    {
        return controls.getControl(controlType);
    }

    /**
     * Retrieve an array of objects that control the object. If no controls are
     * supported, a zero length array is returned.
     *
     * @return the array of object controls
     */
    public Object[] getControls()
    {
        return controls.getControls();
    }

    /**
     * Remove a control object from the list of controls for this object. Will
     * be used by subclasses of this Abstract class.
     *
     * @param control
     *            the control object to remove from the list.
     */
    protected void removeControl(Control control)
    {
        controls.removeControl(control);
    }
}