TimeBarViewerInterface (Jaret timebars 1.48 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.jaret.util.ui.timebars
Interface TimeBarViewerInterface

All Known Implementing Classes:: TimeBarViewer, TimeBarViewer

public interface TimeBarViewerInterface

This interface has to be implemented by the Swing and SWT version of the timebar viewer. Its use is mainly for the TimeBarViewerDelegate to interact with the concrete implementation it supports. Applications should use the specific TimeBarViewer (Swing or SWT) directly.

Version:: $Id: TimeBarViewerInterface.java 1083 2011-07-01 20:29:16Z kliem $
Author:: Peter Kliem

Nested Class Summary
`static class`	`TimeBarViewerInterface.Orientation` enum for the possible orientations.

Field Summary
`static int`	`DEFAULT_ROWHEIGHT` default for the rowheight.
`static int`	`DEFAULT_XAXISHEIGHT` default for the xaxis (timescale) height.
`static int`	`DEFAULT_YAXISWIDTH` default for the yaxis width.
`static java.lang.String`	`PROPERTYNAME_FIRSTROW` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_FIRSTROWOFFSET` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_INTERVALFILTER` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_MAXDATE` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_MINDATE` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_PIXELPERSECOND` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_ROWFILTER` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_ROWHEIGHT` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_ROWHEIGHTDRAGGINGALLOWED` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_ROWSORTER` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_STARTDATE` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_XAXISHEIGHT` property name constant of the bound property.
`static java.lang.String`	`PROPERTYNAME_YAXISWIDTH` property name constant of the bound property.
`static int`	`TIMESCALE_POSITION_BOTTOM` Constant value indicating the time scale should be drawn at the bottom of the diagram.
`static int`	`TIMESCALE_POSITION_NONE` Constant value indicating no time scale should be painted.
`static int`	`TIMESCALE_POSITION_TOP` Constant value indicating the time scale should be drawn on top of the diagram.

Method Summary
`void`	`addFocussedIntervalListener(FocussedIntervalListener listener)` Add a listener to be informed when the focus inside the viewer changes.
`void`	`addIntervalModificator(IntervalModificator intervalModificator)` Add an intervalModificator controlling changes on the intervals.
`void`	`addMarker(TimeBarMarker marker)` Add a timebar marker.
`void`	`addMarkers(java.util.List<TimeBarMarker> markers)` Directly set a list of markers.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Add a PropertyChangeListener.
`void`	`addSelectionRectListener(ISelectionRectListener listener)` Add a listener to be informed when the selection rect changes.
`void`	`addTimeBarChangeListener(ITimeBarChangeListener listener)` Add a listener to be informaed about interval changes.
`void`	`clearRegionRect()` Remove the selction of a region if existent.
`de.jaret.util.date.JaretDate`	`dateForX(int x)` Get the corresponding date for an x coordinate in the viewer area.
`de.jaret.util.date.JaretDate`	`dateForXY(int x, int y)` Get the corresponding date for a point in the viewer area.
`void`	`displayBodyContextMenu(int x, int y)` Display the context menu for the normal viewer body.
`void`	`displayHeaderContextMenu(TimeBarRow row, int x, int y)` Display the header context menu.
`void`	`displayHierarchyContextMenu(TimeBarRow row, int x, int y)` Display the hierarchy area context menu.
`void`	`displayIntervalContextMenu(de.jaret.util.date.Interval interval, int x, int y)` Display the context menu for an interval.
`void`	`displayTimeScaleContextMenu(int x, int y)` Display the context menu for the time scale.
`void`	`displayTitleContextMenu(int x, int y)` Display the title area context menu.
`void`	`doScrollHorizontal(int diff)` Do horizontal scrolling by diff pixel.
`void`	`doScrollVertical(int diff)` Do vertical scrolling by diff pixel.
`void`	`firePropertyChange(java.lang.String string, double oldValue, double newValue)` Fire a property change.
`void`	`firePropertyChangeX(java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue)` Fire a property change.
`void`	`fireSelectionChanged()` Called by the delegate whenever the selection changed (to support selction provider under SWT).
`boolean`	`getAdjustMinMaxDatesByModel()` Retrieve the adjustment policy for min and max date.
`int`	`getAutoScaleRows()` Get the number of rows (columns) that the viewer scales itself to.
`int`	`getAutoscrollDelta()` Retrieve the currently set autoscroll delta.
`TimeBarViewerDelegate`	`getDelegate()` Retrieve the delegate ATTENTION: the delegate is for mostly internal usage only.
`boolean`	`getDragAllSelectedIntervals()` If `true` all selected intervals will be dragged together with the interval on that the drag happened.
`boolean`	`getDrawRowGrid()` Retrieve the status of row grid drawing.
`int`	`getFirstRowDisplayed()` Retrieve the index of the first row that is displayed.
`int`	`getFirstRowOffset()` Retrieve the pixeloffset for the first row.
`java.lang.String`	`getHeaderToolTipText(TimeBarRow row, int x, int y)` Retrieve the tooltip for a position on a row.
`int`	`getHeight()` Return the height of the viewer.
`boolean`	`getHideRoot()` Retrieve whether the root node is shown when using a hierachical model.
`HierarchicalTimeBarModel`	`getHierarchicalModel()` Retrieve the hierarchical model of the viewer.
`HierarchicalViewState`	`getHierarchicalViewState()` Retrieve the hierarchical viewstate used by the viewer.
`java.lang.String`	`getHierarchyToolTipText(TimeBarNode node, int x, int y)` Retrieve the tooltip for a position in the hierarchy.
`int`	`getHierarchyWidth()` Retrieve the width of the hierarchy area.
`java.lang.String`	`getIntervalToolTipText(de.jaret.util.date.Interval interval, java.awt.Rectangle intervalRect, int x, int y)` Get the tooltip text for a given location in a rendered interval.
`boolean`	`getMarkerDraggingInDiagramArea()` Retrieve whether marker dragging in the diagram area is activated.
`java.util.List<TimeBarMarker>`	`getMarkers()` Retrieve the list of al markers.
`int`	`getMarkerWidth(TimeBarMarker marker)` Get the width for marker painting (as requested by a marker renderer).
`de.jaret.util.date.JaretDate`	`getMaxDate()` Retrieve the maximum date that can be displayed.
`de.jaret.util.date.JaretDate`	`getMinDate()` Retrieve the minimum value present in the data of the viewer.
`TimeBarModel`	`getModel()` Retrieve the flat model used by the viewer.
`java.lang.String`	`getName()` Retrieve the name set on the viewer.
`boolean`	`getOptimizeScrolling()` Get whether optimzed scrollnig is used.
`IOverlapStrategy`	`getOverlapStrategy()` Retrieve the used strategy for determing overlap information.
`double`	`getPixelPerSecond()` Return the pixel per second ratio.
`de.jaret.util.misc.Pair<TimeBarRow,de.jaret.util.date.JaretDate>`	`getPopUpInformation()` Retrieve the row and date of the click leading to the activation of a context menu.
`TimeBarNode`	`getPpsRow()` Retrieve the row that hold intervals (PpsIntervals) defining the pps value for different intervals.
`TBRect`	`getRegionRect()` Retrieve the selected region.
`boolean`	`getRegionRectEnable()` Retrieve whether region selections are enabled.
`java.util.List<IIntervalRelation>`	`getRelationsForCoord(int x, int y)` Retrieve the list of relations hit for a coordinate.
`java.lang.String`	`getRelationTooltip(int x, int y)` Provide the tooltip for a relation if any.
`TimeBarRow`	`getRowForXY(int x, int y)` Retrieve the row for a given point.
`TimeBarRow`	`getRowForY(int y)` Retrieve the row for a given y coodinate (x if oriented vertcal; use getRowForXY instead!).
`int`	`getRowHeight()` Retrieve the current row height or the default row height if variable row heights/widths are enabled.
`int`	`getScrollLookBackMinutes()` Retrieve the time to be additionally considered (looking back) when deciding which intervals are to be painted.
`int`	`getScrollLookForwardMinutes()` Retrieve the time to be additionally considered (looking forward) when deciding which intervals are to be painted.
`boolean`	`getScrollOnFocus()` Retrieve the state of the scroll to focus flag.
`int`	`getSecondsDisplayed()` Get the seconds currently displayed by the diagram.
`int`	`getSelectionDelta()` Retrieve the selection delta used to determine whether a marker or interval edge is clicked/dragged.
`TimeBarSelectionModel`	`getSelectionModel()` Get the selection model of the viewer.
`de.jaret.util.date.JaretDate`	`getStartDate()` Retrive the current start date of the displayed time span.
`boolean`	`getStrictClipTimeCheck()` Retrieve the strategy for filtering when painting (see `setStrictClipTimeCheck(boolean)`).
`TimeBarViewerInterface.Orientation`	`getTBOrientation()` Retrieve the orientation of the viewer.
`ITimeBarViewState`	`getTimeBarViewState()` Retrieve the statndard viewstate of the viewer containing the row heights/column widths.
`java.lang.String`	`getTimeScaleToolTipText(int x, int y)` Retrieve the tooltip for a position on the timescale.
`java.lang.String`	`getTitle()` Retrieve the title.
`java.lang.String`	`getToolTipText()` Return the tool tip text of the viewer.
`boolean`	`getUseUniformHeight()` Retrieve whether uniform height is use for all intervals in a row.
`int`	`getWidth()` Return the width of the viewer.
`int`	`getXAxisHeight()` Retrieve the height (or width when orientation is vertical) of the timescale.
`int`	`getYAxisWidth()` Retrieve the width of the y axis (header area).
`int`	`getYForRow(TimeBarRow row)` Retrieve the y coordinate in the diagram pane for the given row.
`boolean`	`hasVariableXScale()` Retrieve the state of the variable xscale state.
`boolean`	`isAutoscrollEnabled()` Get the autoscroll behaviour.
`boolean`	`isDisplayed(de.jaret.util.date.JaretDate date)` Check whether a date is currently visible.
`boolean`	`isInDiagram(int x, int y)` Check whether a given point is in the main diagram area.
`boolean`	`isInHierarchySelectionArea(TimeBarNode node, int x, int y)` Check whether the given position is in the selection area of the hierarchy.
`boolean`	`isInRowAxis(int x, int y)` Check whether a given point is in the row axis area (hierarchy or header).
`boolean`	`isInToggleArea(TimeBarNode node, int x, int y)` Check whether the given position should toggle expanded state of a node.
`boolean`	`isLineDraggingAllowed()` Check whether it is allowed to drag the limiting lines of the hierarchy ara and the header (yaxis) area.
`boolean`	`isMilliAccuracy()` Check whether th delegate is setup for millisecond accuracy.
`boolean`	`isRowHeightDragginAllowed()` Check whether row height dragging is allowed.
`void`	`remFocussedIntervalListener(FocussedIntervalListener listener)` Remove a focussedIntervalListener.
`void`	`remIntervalModificator(IntervalModificator intervalModificator)` Remove an interval modificator.
`void`	`remMarker(TimeBarMarker marker)` Remove a timebar marker.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Remove a property change listener.
`void`	`removeTimeBarChangeListener(ITimeBarChangeListener listener)` Remove a timebar change listener.
`void`	`remSelectionRectListener(ISelectionRectListener listener)` Remove a selection rect listener.
`void`	`repaint()` Mark the whole viewer as dirty causing a repaint.
`void`	`repaint(int x, int y, int width, int height)` Mark area the needs repaint.
`void`	`repaint(java.awt.Rectangle rect)` Mark area to be repainted.
`boolean`	`rowLineHit(int x, int y)` Check whether a row delimiter line is hit by a coordinate.
`int`	`scrollDateToVisible(de.jaret.util.date.JaretDate date)` Scroll a date into the visible area of the viewer.
`void`	`scrollIntervalToVisible(TimeBarRow row, de.jaret.util.date.Interval interval)` Make sure the specified interval is in the visibe area of the viewer.
`void`	`scrollRowToVisible(TimeBarRow row)` Make sure the specified row is visible.
`void`	`setAdjustMinMaxDatesByModel(boolean adjustMinMaxDatesByModel)` Set the adjustment policy.
`void`	`setAutoScaleRows(int rows)` Set a number of rows (columns) to be displayed by the viewer.
`void`	`setAutoscrollDelta(int autoscrollDelta)` Set the autoscroll delta.
`void`	`setAutoscrollEnabled(boolean enableAutoscroll)` Set the autoscroll behaviour.
`void`	`setCursor(int cursorType)` Set the cursor type.
`void`	`setDragAllSelectedIntervals(boolean dragAllSelectedIntervals)` If set to `true` all selected intervals are dragged when an interval is dragged.
`void`	`setDrawRowGrid(boolean drawRowGrid)` Set the row grid drawing status.
`void`	`setFirstRow(int firstRow, int pixOffset)` Set the first row to be displayed.
`void`	`setFirstRowDisplayed(int rowIdx)` Set the first row to be displayed.
`void`	`setFirstRowDisplayed(TimeBarRow row)` Set the the first row to be displayed.
`void`	`setFirstRowOffset(int offset)` Set the pixeloffset of the first row.
`void`	`setHideRoot(boolean hideRoot)` Set whether the root node should be shown when using a hierachical model.
`void`	`setHierarchicalViewState(HierarchicalViewState hierarchicalViewState)` Set the hierarchical viewstate to be used.
`void`	`setHierarchyWidth(int width)` Set the width of the hierarchy area of the viewer.
`void`	`setInitialDisplayRange(de.jaret.util.date.JaretDate startDate, int secondsDisplayed)` Set a date range and scaling that will be set as the initial display right after the viewer is displayed.
`void`	`setLastRow(int index)` Set the last row in the viewer.
`void`	`setLastRow(TimeBarRow row)` Set the last row in the viewer.
`void`	`setLineDraggingAllowed(boolean lineDraggingAllowed)` Set the allowance for line dragging of the limiting lines for hierarchy and header(yaxis) areas.
`void`	`setMarkerDraggingInDiagramArea(boolean allowed)` Set whether marker dragging is allowed in the diagram area (If intervals are modificable the marker will only be grabbed when no other operation is applicable).
`void`	`setMaxDate(de.jaret.util.date.JaretDate maxDate)` Set the maximum date to be displayed.
`void`	`setMilliAccuracy(boolean milliAccuracy)` Set the delegates status concerning millisecond accuracy.
`void`	`setMinDate(de.jaret.util.date.JaretDate minDate)` Set the minimum date to be displayed.
`void`	`setModel(HierarchicalTimeBarModel hModel)` Set a hierarchical model to be displayed.
`void`	`setModel(TimeBarModel model)` Set the flat model to be displayed.
`void`	`setName(java.lang.String name)` Set a name as a simple string property for internal application use.
`void`	`setOptimizeScrolling(boolean optimizeScrolling)` Set whether optimized scrolling should be used.
`void`	`setOverlapStrategy(IOverlapStrategy overlapStrategy)` Set the strategy to be used for calculating overlap information.
`void`	`setPixelPerSecond(double pixelPerSecond)` Sets the scale ox the x axis as pixel per second, thus a value of 1000.0 / (24.0 * 60 * 60) will result in displaying one day over 1000 pixel.
`void`	`setRegionRectEnable(boolean enabled)` Enable/Disable region selections.
`void`	`setRowHeight(int rowHeight)` Set the height for the rows in pixel.
`void`	`setRowHeightDraggingAllowed(boolean rowHeightDraggingAllowed)` Set whether row height dragging should be allowed.
`void`	`setScrollLookBackMinutes(int scrollLookBackMinutes)` Set the additional time to be considered when deciding whether to draw an interval looking back.
`void`	`setScrollLookForwardMinutes(int scrollLookForwardMinutes)` Set the additional time to be considered when deciding whether to draw an interval looking forward.
`void`	`setScrollOnFocus(boolean scrollOnFocus)` If set to true the viewer will scroll to the begin of an interval if it's focussed.
`void`	`setSecondsDisplayed(int seconds, boolean center)` Set the scaling of the x axis by specifying the number of seconds that should be displayed.
`void`	`setSecondsDisplayed(int seconds, de.jaret.util.date.JaretDate centerDate)` Set the scaling of the x axis by specifying the number of seconds that should be displayed.
`void`	`setSelectionDelta(int selectionDelta)` Set the selection delta used to determine whether a marker or interval edge is clicked/dragged.
`void`	`setSelectionModel(TimeBarSelectionModel selectionModel)` Set the selectionmodel to be used by the viewer.
`void`	`setStartDate(de.jaret.util.date.JaretDate startDate)` Set the start date of the display.
`void`	`setStrictClipTimeCheck(boolean strictClipTimeCheck)` Set the optimization strategy for interval filtering when painting.
`void`	`setTBOrientation(TimeBarViewerInterface.Orientation orientation)` Set the orientation of the viewer.
`void`	`setTitle(java.lang.String title)` Set a title for the viewer to be displayed.
`void`	`setUseUniformHeight(boolean useUniformHeight)` Set whether all intervals in a non overlapping drawn row should use the same height/width.
`void`	`setVariableXScale(boolean state)` Set the state for the variable xscale.
`void`	`setXAxisHeight(int height)` Set the height (or width) of the timescale.
`void`	`setYAxisWidth(int width)` Set the width of the y axis (the header area).
`java.awt.Rectangle`	`timeBarContainingRect(de.jaret.util.date.Interval interval, java.awt.Rectangle intervalRect, boolean overlappig)` Calculate/get the containing rectangle of a rendered interval.
`boolean`	`timeBarContains(de.jaret.util.date.Interval interval, java.awt.Rectangle intervalRect, int x, int y, boolean overlapping)` Check whether a location is contained in a rendered interval.
`void`	`updateXScrollBar(int max, int pos, int secondsDisplayed)` Update the x scrollbar.
`void`	`updateYScrollBar(int max, int pos, int rowsDisplayed)` Update the y scrollbar.
`int`	`xForDate(de.jaret.util.date.JaretDate date)` Get the corresponding x coordinate in the viewer area for a given date.

Field Detail

TIMESCALE_POSITION_TOP

static final int TIMESCALE_POSITION_TOP

Constant value indicating the time scale should be drawn on top of the diagram.

See Also:: Constant Field Values

TIMESCALE_POSITION_BOTTOM

static final int TIMESCALE_POSITION_BOTTOM

Constant value indicating the time scale should be drawn at the bottom of the diagram.

See Also:: Constant Field Values

TIMESCALE_POSITION_NONE

static final int TIMESCALE_POSITION_NONE

Constant value indicating no time scale should be painted.

See Also:: Constant Field Values

DEFAULT_ROWHEIGHT

static final int DEFAULT_ROWHEIGHT

default for the rowheight.

See Also:: Constant Field Values

DEFAULT_XAXISHEIGHT

static final int DEFAULT_XAXISHEIGHT

default for the xaxis (timescale) height.

See Also:: Constant Field Values

DEFAULT_YAXISWIDTH

static final int DEFAULT_YAXISWIDTH

default for the yaxis width.

See Also:: Constant Field Values