/*
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package flash.swf.tags;

import flash.swf.Tag;
import flash.swf.TagHandler;

/**
 * The FrameLabel tag gives the specified Name to the current
 * frame. This name is used by ActionGoToLabel to identify the frame.
 * <p>
 * Any frame can have a FrameLabel tag but only the main timeline may
 * have bookmark labels.  bookmark labels on sprite timelines are
 * ignored by the player.
 * @since SWF3
 */
public class FrameLabel extends Tag
{
	public FrameLabel()
	{
		super(stagFrameLabel);
	}

    public void visit(TagHandler h)
	{
		h.frameLabel(this);
	}

    /**
	 * label for the current frame
	 */
	public String label;

	/**
	 * named anchor flag.  labels this frame for seeking using HTML anchor syntax.
	 * @since SWF6
     */
	public boolean anchor;

    public boolean equals(Object object)
    {
        boolean isEqual = false;

        if (super.equals(object) && (object instanceof FrameLabel))
        {
            FrameLabel frameLabel = (FrameLabel) object;

            if ( equals(frameLabel.label, this.label) &&
                 (frameLabel.anchor == this.anchor) )
            {
                isEqual = true;
            }
        }

        return isEqual;
    }
}