ComponentPropertiesReplayer.java :  » Testing » jacareto » jacareto » replay » Java Open Source

/*
 * Jacareto Copyright (c) 2002-2005
 * Applied Computer Science Research Group, Darmstadt University of
 * Technology, Institute of Mathematics & Computer Science,
 * Ludwigsburg University of Education, and Computer Based
 * Learning Research Group, Aachen University. All rights reserved.
 *
 * Jacareto is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * Jacareto 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with Jacareto; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */

package jacareto.replay;


import jacareto.comp.Components;
import jacareto.record.ComponentPropertiesRecordable;
import jacareto.struct.StructureElement;
import jacareto.system.Environment;

import java.awt.Component;

/**
 * A replayer which is responsible for component properties. The properties of a specified
 * component will be set.
 *
 * @author <a href="mailto:cspannagel@web.de">Christian Spannagel</a>
 * @version 1.01
 */
public class ComponentPropertiesReplayer extends Replayer {
    /**
     * Creates a new replayer.
     *
     * @param env the environment
     * @param replay the replay object
     */
    public ComponentPropertiesReplayer (Environment env, Replay replay) {
        super(env, replay);
    }

    /**
     * Returns whether or not this replayer is responsible for the given structure element. This is
     * <code>true</code> if the structure element is an {@link ComponentPropertiesRecordable}.
     *
     * @param element the structure element
     *
     * @return <code>true</code> if this replayer is responsible for the specified element;
     *         otherwise <code>false</code>.
     */
    public boolean handlesElement (StructureElement element) {
        return (element != null) && (element instanceof ComponentPropertiesRecordable);
    }

    /**
     * Sets the properties of the specified component.
     *
     * @param element the structure element this replayer should work with
     *
     * @return whether or not the replay process has been successful
     */
    public boolean replay (StructureElement element) {
        ComponentPropertiesRecordable cpRecordable = (ComponentPropertiesRecordable) element;

        // if no properties should be applied, return
        if (! cpRecordable.getApplyIsEnabled () && ! cpRecordable.getApplyIsVisible ()) {
            return true;
        }

        // Get the component
        Components components = getReplay ().getComponents ();
        String componentName = cpRecordable.getComponentName ();
        Component component = components.getComponent (componentName);

        if ((component != null)) {
            // apply properties
            cpRecordable.apply (component, components);

            /* is done by the recordable now
            if (cpRecordable.getKeepState ()) {
            components.getComponentWatcher ().addComponent (component, cpRecordable);
            } */
            return true;
        } else {
            return false;
        }
    }
}