Spec-Zone .ru
спецификации, руководства, описания, API
001/*
002 * Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package javafx.scene.media;
027
028import javafx.event.ActionEvent;
029import javafx.util.Duration;
030import javafx.util.Pair;
031
032/**
033 * An {@link ActionEvent} representing a media marker. A marker is added to a
034 * {@link Media} which is then played by a {@link MediaPlayer}. The event
035 * is fired when the playback position reaches the position of the marker.
036 *
037 * @see MediaPlayer#onMarker
038 */
039public class MediaMarkerEvent extends ActionEvent {
040
041    private static final long serialVersionUID = 20121107L;
042    
043    private Pair<String,Duration> marker;
044
045    MediaMarkerEvent(Pair<String,Duration> marker) {
046        super();
047        this.marker = marker;
048    }
049
050    /**
051     * Retrieves the marker the event represents.
052     *
053     * @return the value of the marker.
054     */
055    public Pair<String,Duration> getMarker() {
056        return marker;
057    }
058}