EventsRenderer

java.lang.Object
- org.das2.graph.Renderer
- - org.das2.graph.EventsRenderer

All Implemented Interfaces:

Displayable, Editable, DataSetConsumer
```
public class EventsRenderer
extends Renderer
```
Draw colored horizontal bars for the dataset, marking events datasets or modes of the data. This expects a QDataSet with the canonical scheme:
```
    Events[:,BUNDLE_1=4] where the columns are:
      BUNDLE_1=startTime,stopTime,Color,Message
    startTime,stopTime are in some time location unit.  stopTime may also be an offset from startTime (e.g. seconds)
    Color is an int, that is either 0xRRGGBB or 0xAARRGGBB.
    Message is any datum, so typically an enumeration unit is used.
```
Note this also contains systems for coloring data in old schemes, such as the colorSpecifier interface and textSpecifier. These should not be used when a dataset will be sufficient.
See Also:

Schemes.eventsList()

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface EventsRenderer.ColorSpecifier

static interface EventsRenderer.TextSpecifier

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EventsRenderer.ColorSpecifier`
`static interface`	`EventsRenderer.TextSpecifier`

Field Summary

Fields
Modifier and Type	Field and Description
`static EventsRenderer.TextSpecifier`	`DEFAULT_TEXT_SPECIFIER`
`protected java.lang.String`	`fontSize` fontSize allows the font to be rescaled.
`protected boolean`	`orbitMode` orbitMode true means don't show times, draw bars with 1-pixel breaks
`static java.lang.String`	`PROP_COLOR`
`static java.lang.String`	`PROP_COLOR_SPECIFIER`
`static java.lang.String`	`PROP_FONTSIZE`
`static java.lang.String`	`PROP_GANTTMODE`
`static java.lang.String`	`PROP_LINESTYLE`
`static java.lang.String`	`PROP_LINETHICK`
`static java.lang.String`	`PROP_MODE`
`static java.lang.String`	`PROP_OPAQUE`
`static java.lang.String`	`PROP_ORBITMODE`
`static java.lang.String`	`PROP_ROTATELABEL` rotate the label counter clockwise to make more room in orbitMode.
`static java.lang.String`	`PROP_SHOWLABELS`
`protected boolean`	`showLabels` true means draw the event label next to the bar.

Constructor Summary

Constructors
Constructor and Description

EventsRenderer()

Constructors
Constructor and Description
`EventsRenderer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptContext(int x, int y)` Returns true if the render will accept the context for a point.
`static QDataSet`	`doAutorange(QDataSet ds)` return bounding cube
`java.awt.Color`	`getColor()`
`EventsRenderer.ColorSpecifier`	`getColorSpecifier()`
`java.lang.String`	`getControl()` get the string which summarizes the state of the renderer.
`java.lang.String`	`getFontSize()`
`PsymConnector`	`getLineStyle()`
`java.lang.String`	`getLineThick()` the line thickness, examples include "5pt" and "0.1em"
`javax.swing.Icon`	`getListIcon()` An icon can be provided that will be shown in a list along with the textual description of the element.
`java.lang.String`	`getMode()`
`int`	`getRenderTimeLimitMs()`
`int`	`getRotateLabel()`
`EventsRenderer.TextSpecifier`	`getTextSpecifier()` Getter for property textSpecifier.
`protected void`	`installRenderer()`
`boolean`	`isGanttMode()`
`boolean`	`isOpaque()`
`boolean`	`isOrbitMode()`
`boolean`	`isShowLabels()`
`void`	`render(java.awt.Graphics2D g1, DasAxis xAxis, DasAxis yAxis)` Render is called whenever the image needs to be refreshed or the content has changed.
`void`	`setColor(java.awt.Color color)` set the color to use when the data doesn't specify a color.
`void`	`setColorSpecifier(EventsRenderer.ColorSpecifier spec)` set this to be an object implementing ColorSpecifier interface, if more than one color is to be used when drawing the bars.
`void`	`setControl(java.lang.String s)` set the control string which contains a number of properties.
`void`	`setDataSet(QDataSet ds)` Set the dataset to be plotted.
`void`	`setFontSize(java.lang.String fontSize)`
`void`	`setGanttMode(boolean ganttMode)`
`void`	`setLineStyle(PsymConnector lineStyle)`
`void`	`setLineThick(java.lang.String lineThick)`
`void`	`setMode(java.lang.String mode)` if non-empty, then use this named mode
`void`	`setOpaque(boolean opaque)`
`void`	`setOrbitMode(boolean orbitMode)`
`void`	`setRenderTimeLimitMs(int renderTimeLimitMs)`
`void`	`setRotateLabel(int rotateLabel)`
`void`	`setShowLabels(boolean showLabels)`
`void`	`setTextSpecifier(EventsRenderer.TextSpecifier textSpecifier)` Setter for property textSpecifier.
`protected void`	`uninstallRenderer()`

Methods inherited from class org.das2.graph.Renderer
acceptsDataSet, addPropertyChangeListener, addPropertyChangeListener, addToStats, decodeDatum, decodeFillStyle, decodePlotSymbolConnectorControl, decodePlotSymbolControl, drawListIcon, encodeBooleanControl, encodeColorControl, encodeDatum, encodeFillStyle, encodePlotSymbolConnectorControl, encodePlotSymbolControl, formatControl, getAffineTransform, getBooleanControl, getBottomDecorator, getColorBar, getColorControl, getConsumedDataSet, getControl, getDataLoader, getDataSet, getDataSetDescriptor, getDataSetID, getDatumControl, getDoubleArrayControl, getDoubleControl, getId, getIntegerControl, getInternalDataSet, getLastException, getLegendLabel, getListLabel, getParent, getRenderCount, getStatsFile, getTopDecorator, getUpdateCount, getXmemento, getYmemento, hasControl, incrementRenderCount, incrementUpdateCount, invalidateParentCacheImage, isActive, isDrawLegendLabel, isDumpDataSet, isTableDataSet, parseControl, parseLayoutString, postException, postMessage, postMessage, refresh, refreshImage, removePropertyChangeListener, removePropertyChangeListener, renderException, resetCounters, setActive, setBottomDecorator, setColorBar, setDataSetDescriptor, setDataSetID, setDataSetLoader, setDrawLegendLabel, setDumpDataSet, setException, setId, setLastException, setLegendLabel, setParent, setStatsFile, setTopDecorator, setUpFont, setUpFont, update, updateCacheImage, updateImmediately, updatePlotImage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_COLOR
```
public static final java.lang.String PROP_COLOR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TEXT_SPECIFIER
```
public static final EventsRenderer.TextSpecifier DEFAULT_TEXT_SPECIFIER
```
  - PROP_LINESTYLE
```
public static final java.lang.String PROP_LINESTYLE
```
    See Also:
    
    Constant Field Values
  - PROP_LINETHICK
```
public static final java.lang.String PROP_LINETHICK
```
    See Also:
    
    Constant Field Values
  - PROP_OPAQUE
```
public static final java.lang.String PROP_OPAQUE
```
    See Also:
    
    Constant Field Values
  - showLabels
```
protected boolean showLabels
```
    true means draw the event label next to the bar.
  - PROP_SHOWLABELS
```
public static final java.lang.String PROP_SHOWLABELS
```
    See Also:
    
    Constant Field Values
  - PROP_MODE
```
public static final java.lang.String PROP_MODE
```
    See Also:
    
    Constant Field Values
  - orbitMode
```
protected boolean orbitMode
```
    orbitMode true means don't show times, draw bars with 1-pixel breaks
  - PROP_ORBITMODE
```
public static final java.lang.String PROP_ORBITMODE
```
    See Also:
    
    Constant Field Values
  - PROP_GANTTMODE
```
public static final java.lang.String PROP_GANTTMODE
```
    See Also:
    
    Constant Field Values
  - PROP_ROTATELABEL
```
public static final java.lang.String PROP_ROTATELABEL
```
    rotate the label counter clockwise to make more room in orbitMode.
    
    See Also:
    
    Constant Field Values
  - fontSize
```
protected java.lang.String fontSize
```
    fontSize allows the font to be rescaled. 1em is the default size. 2em is twice the size. 12pt is 12 pixels.
  - PROP_FONTSIZE
```
public static final java.lang.String PROP_FONTSIZE
```
    See Also:
    
    Constant Field Values
  - PROP_COLOR_SPECIFIER
```
public static final java.lang.String PROP_COLOR_SPECIFIER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EventsRenderer
```
public EventsRenderer()
```
- Method Detail
  - doAutorange
```
public static QDataSet doAutorange(QDataSet ds)
```
    return bounding cube
    
    Parameters:
    
    ds -
    
    Returns:
  - acceptContext
```
public boolean acceptContext(int x,
                             int y)
```
    Description copied from class: Renderer
    
    Returns true if the render will accept the context for a point. That is, the renderer affected that point, or nearby points. This is used currently to provide a way for the operator to click on a plot and directly edit the renderer which drew the pixel.
    
    Overrides:
    
    acceptContext in class Renderer
    
    Parameters:
    
    x - the x coordinate in the canvas coordinate system.
    
    y - the y coordinate in the canvas coordinate system.
    
    Returns:
    
    true if the renderer will accept the context.
  - installRenderer
```
protected void installRenderer()
```
    Overrides:
    
    installRenderer in class Renderer
  - uninstallRenderer
```
protected void uninstallRenderer()
```
    Overrides:
    
    uninstallRenderer in class Renderer
  - render
```
public void render(java.awt.Graphics2D g1,
                   DasAxis xAxis,
                   DasAxis yAxis)
```
    Description copied from class: Renderer
    
    Render is called whenever the image needs to be refreshed or the content has changed. This operation should occur with an animation-interactive time scale, and an image should be cached when this is not possible. The graphics object will have its origin at the upper-left corner of the screen.
    
    Specified by:
    
    render in class Renderer
    
    Parameters:
    
    g1 - the graphics context in the canvas reference frame.
    
    xAxis - the axis relating x data coordinates to horizontal pixel coordinates
    
    yAxis - the axis relating y data coordinates to horizontal pixel coordinates
  - setDataSet
```
public void setDataSet(QDataSet ds)
```
    Description copied from class: Renderer
    
    Set the dataset to be plotted. Different renderers accept QDataSets with different schemes. For example SeriesRenderer takes: ds[t] rank 1 dataset with rank 1 DEPEND_0 or ds[t,n] rank 2 bundle dataset with X in ds[t,0] and Y in ds[t,n-1] and SpectrogramRenderer takes: ds[t,y] rank 2 table dataset ds[n,t,y] rank 3 dataset with the first dimension join See each renderer's documentation for the schemes it takes. Note the lastException property is cleared, even when the dataset is null.
    
    Overrides:
    
    setDataSet in class Renderer
  - getListIcon
```
public javax.swing.Icon getListIcon()
```
    Description copied from interface: Displayable
    
    An icon can be provided that will be shown in a list along with the textual description of the element. This method should return null if there is no icon available, or a roughly 16x16 pixel icon.
    
    Specified by:
    
    getListIcon in interface Displayable
    
    Overrides:
    
    getListIcon in class Renderer
    
    Returns:
    
    the icon.
  - setControl
```
public void setControl(java.lang.String s)
```
    Description copied from class: Renderer
    
    set the control string which contains a number of properties. These are defined for each renderer, but they should try to be consistent. See http://autoplot.org/developer.guessRenderType#Proposed_extensions When overriding this, be sure to call super.
    
    Overrides:
    
    setControl in class Renderer
    
    Parameters:
    
    s - the control
    
    See Also:
    
    etc
  - getControl
```
public java.lang.String getControl()
```
    Description copied from class: Renderer
    
    get the string which summarizes the state of the renderer. These allow a compact string to contain the renderer settings. This should be an ampersand-delimited list of name=value pairs.
    
    Overrides:
    
    getControl in class Renderer
    
    Returns:
  - getColor
```
public java.awt.Color getColor()
```
  - getLineStyle
```
public PsymConnector getLineStyle()
```
  - setLineStyle
```
public void setLineStyle(PsymConnector lineStyle)
```
  - getLineThick
```
public java.lang.String getLineThick()
```
    the line thickness, examples include "5pt" and "0.1em"
    
    Returns:
  - setLineThick
```
public void setLineThick(java.lang.String lineThick)
```
  - isOpaque
```
public boolean isOpaque()
```
  - setOpaque
```
public void setOpaque(boolean opaque)
```
  - setColor
```
public void setColor(java.awt.Color color)
```
    set the color to use when the data doesn't specify a color. If an alpha channel is specified, then this alpha value is used, otherwise 80% is used.
    
    Parameters:
    
    color -
  - getRenderTimeLimitMs
```
public int getRenderTimeLimitMs()
```
  - setRenderTimeLimitMs
```
public void setRenderTimeLimitMs(int renderTimeLimitMs)
```
  - isShowLabels
```
public boolean isShowLabels()
```
  - setShowLabels
```
public void setShowLabels(boolean showLabels)
```
  - getMode
```
public java.lang.String getMode()
```
  - setMode
```
public void setMode(java.lang.String mode)
```
    if non-empty, then use this named mode
    
    Parameters:
    
    mode -
  - isOrbitMode
```
public boolean isOrbitMode()
```
  - setOrbitMode
```
public void setOrbitMode(boolean orbitMode)
```
  - isGanttMode
```
public boolean isGanttMode()
```
  - setGanttMode
```
public void setGanttMode(boolean ganttMode)
```
  - getRotateLabel
```
public int getRotateLabel()
```
  - setRotateLabel
```
public void setRotateLabel(int rotateLabel)
```
  - getFontSize
```
public java.lang.String getFontSize()
```
  - setFontSize
```
public void setFontSize(java.lang.String fontSize)
```
  - setColorSpecifier
```
public void setColorSpecifier(EventsRenderer.ColorSpecifier spec)
```
    set this to be an object implementing ColorSpecifier interface, if more than one color is to be used when drawing the bars. Setting this to null will restore the initial behavior of drawing all bars in one color (or with rank 2 bundle containing color).
    
    Parameters:
    
    spec - the color specifier.
  - getColorSpecifier
```
public EventsRenderer.ColorSpecifier getColorSpecifier()
```
  - getTextSpecifier
```
public EventsRenderer.TextSpecifier getTextSpecifier()
```
    Getter for property textSpecifier.
    
    Returns:
    
    Value of property textSpecifier.
  - setTextSpecifier
```
public void setTextSpecifier(EventsRenderer.TextSpecifier textSpecifier)
```
    Setter for property textSpecifier.
    
    Parameters:
    
    textSpecifier - New value of property textSpecifier.

Class EventsRenderer

Nested Class Summary

Field Summary

Fields inherited from class org.das2.graph.Renderer

Constructor Summary

Method Summary

Methods inherited from class org.das2.graph.Renderer

Methods inherited from class java.lang.Object

Field Detail

PROP_COLOR

DEFAULT_TEXT_SPECIFIER

PROP_LINESTYLE

PROP_LINETHICK

PROP_OPAQUE

showLabels

PROP_SHOWLABELS

PROP_MODE

orbitMode

PROP_ORBITMODE

PROP_GANTTMODE

PROP_ROTATELABEL

fontSize

PROP_FONTSIZE

PROP_COLOR_SPECIFIER

Constructor Detail

EventsRenderer

Method Detail

doAutorange

acceptContext

installRenderer

uninstallRenderer

render

setDataSet

getListIcon

setControl

getControl

getColor

getLineStyle

setLineStyle

getLineThick

setLineThick

isOpaque

setOpaque

setColor

getRenderTimeLimitMs

setRenderTimeLimitMs

isShowLabels

setShowLabels

getMode

setMode

isOrbitMode

setOrbitMode

isGanttMode

setGanttMode

getRotateLabel

setRotateLabel

getFontSize

setFontSize

setColorSpecifier

getColorSpecifier

getTextSpecifier

setTextSpecifier