tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/model/IMarkerEvent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2015 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Patrick Tasse - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model;
  14
  15 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  16
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.swt.graphics.Color;
  19 import org.eclipse.tracecompass.internal.tmf.ui.Messages;
  20
  21 /**
  22  * Interface for a marker time event that includes a category, a color and
  23  * an optional label.
  24  *
  25  * @since 2.0
  26  */
  27 public interface IMarkerEvent extends ITimeEvent {
  28
  29     /** Bookmarks marker category */
  30     @NonNull String BOOKMARKS = checkNotNull(Messages.MarkerEvent_Bookmarks);
  31
  32     /**
  33      * Get this marker's category.
  34      *
  35      * @return The category
  36      */
  37     String getCategory();
  38
  39     /**
  40      * Get this marker's label.
  41      *
  42      * @return The label, or null
  43      */
  44     String getLabel();
  45
  46     /**
  47      * Get this marker's color.
  48      *
  49      * @return The color
  50      */
  51     Color getColor();
  52
  53     /**
  54      * Returns true if the marker is drawn in foreground, and false otherwise.
  55      *
  56      * @return true if the marker is drawn in foreground, and false otherwise.
  57      */
  58     boolean isForeground();
  59 }