tmf: Update Javadoc throughout tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / widgets / timegraph / TimeGraphTreeExpansionEvent.java

/*******************************************************************************\r
 * Copyright (c) 2012 Ericsson\r
 *\r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *   Patrick Tasse - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.widgets.timegraph;\r
\r
import java.util.EventObject;\r
\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeGraphEntry;\r
\r
/**\r
 * Notifier for the time graph view that a tree has been expanded.\r
 *\r
 * @version 1.0\r
 * @author Patrick Tasse\r
 */\r
public class TimeGraphTreeExpansionEvent extends EventObject {\r
\r
    /**\r
     * Default serial version UID for this class.\r
     * @since 1.0\r
     */\r
    private static final long serialVersionUID = 1L;\r
\r
    /**\r
     * The entry that was expanded or collapsed.\r
     */\r
    private final ITimeGraphEntry fEntry;\r
\r
    /**\r
     * Creates a new event for the given source and entry.\r
     *\r
     * @param source the tree viewer\r
     * @param entry the entry\r
     */\r
    public TimeGraphTreeExpansionEvent(Object source, ITimeGraphEntry entry) {\r
        super(source);\r
        fEntry = entry;\r
    }\r
\r
    /**\r
     * Returns the entry that got expanded or collapsed.\r
     *\r
     * @return the entry\r
     */\r
    public ITimeGraphEntry getEntry() {\r
        return fEntry;\r
    }\r
}\r