ilog.views.gantt.swing.calendarview

Class IlvHourlyActivitySheet

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

ilog.views.gantt.swing.calendarview.IlvHourlyActivitySheet

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Scrollable

public class IlvHourlyActivitySheet
extends JComponent
implements Scrollable

IlvHourlyActivitySheet displays a single day of activities arranged in columns along the vertical axis, which represents the hours of the day.

Since:

JViews 7.5

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvHourlyActivitySheet() Creates a new hourly activity sheet.

Method Summary

Modifier and Type	Method and Description
List	getActivities() Returns the activities that are displayed on the sheet.
IlvActivity	getActivity(Point point) Returns the activity or milestone that is displayed at the specified point.
int	getActivityColumnCount() Returns the number of activity columns being displayed.
IlvActivityCalendarRenderer	getActivityRenderer() Returns the renderer that is used to draw the graphic presentation of activities within the activity sheet.
int	getActivitySpacing() Returns the horizontal spacing between activity bars and milestones.
Calendar	getCalendar() Returns the calendar displayed by the sheet.
Calendar	getCalendar(int y) Returns the calendar that corresponds to the specified Y position.
Paint	getHalfHourPaint() Returns the paint object used to stroke the half hour grid lines.
Stroke	getHalfHourStroke() Returns the style used to stroke the half hour grid lines.
int	getHourHeight() Returns the height of each hour interval.
float	getHourOfDay(int y) Returns the hour of the day that corresponds to the specified Y position.
Paint	getHourPaint() Returns the paint object used to stroke the hour grid lines.
Stroke	getHourStroke() Returns the style used to stroke the hour grid lines.
Dimension	getMaximumSize() Returns the maximum size of the sheet.
IlvMilestoneCalendarRenderer	getMilestoneRenderer() Returns the renderer that is used to draw the graphic presentation of milestones within the activity sheet.
Dimension	getPreferredScrollableViewportSize() Returns the preferred size of the viewport for this activity sheet.
Dimension	getPreferredSize() Returns the preferred size of the sheet.
int	getPreferredVisibleHours() Returns the preferred number of hours that will be displayed when the activity sheet is placed in a scrollpane.
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) Returns the distance to scroll to expose the next or previous block of hour rows for vertical scrolling, or the value of 10 pixels for horizontal scrolling.
boolean	getScrollableTracksViewportHeight() Returns false to indicate that a viewport should not force the height of the activity sheet to match the height of the viewport.
boolean	getScrollableTracksViewportWidth() Returns true to indicate that a viewport should always force the width of the activity sheet to match the width of the viewport.
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) Returns the distance to scroll to expose the next or previous hour row for vertical scrolling, or the value of 1 pixel for horizontal scrolling.
Collection	getSelectedActivities() Returns a collection of the currently selected activities.
String	getToolTipText(MouseEvent event) Returns the string to be used as the tooltip for the specified mouse event.
float	getY(Calendar calendar) Returns the vertical Y position within the sheet that corresponds to the hour of the day of the specified calendar.
float	getY(float hourOfDay) Returns the vertical Y position within the sheet that corresponds to the specified hour of the day.
void	paintComponent(Graphics g) Paints the activity sheet.
void	setActivities(List activities, IlvGanttModel ganttModel) Sets the activities that are displayed on the sheet.
void	setActivityRenderer(IlvActivityCalendarRenderer activityRenderer) Sets the renderer that will be used to draw the graphic presentation of activities within the activity sheet.
void	setActivitySpacing(int spacing) Sets the horizontal spacing between activity bars and milestones.
void	setCalendar(Calendar calendar) Sets the calendar representing the day that is displayed by the sheet.
void	setHalfHourPaint(Paint paint) Sets the paint object used to stroke the half hour grid lines.
void	setHalfHourStroke(Stroke stroke) Sets the style used to stroke the half hour grid lines.
void	setHourHeight(int height) Sets the height of each hour interval.
void	setHourPaint(Paint paint) Sets the paint object used to stroke the hour grid lines.
void	setHourStroke(Stroke stroke) Sets the style used to stroke the hour grid lines.
void	setMilestoneRenderer(IlvMilestoneCalendarRenderer milestoneRenderer) Sets the renderer that will be used to draw the graphic presentation of milestones within the activity sheet.
void	setPreferredVisibleHours(int visibleHours) Sets the preferred number of hours that will be displayed when the activity sheet is placed in a scrollpane.
void	setSelectedActivities(Collection activities) Sets the collection of activities that are currently selected.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IlvHourlyActivitySheet

public IlvHourlyActivitySheet()

Creates a new hourly activity sheet.

Method Detail

getCalendar

public Calendar getCalendar()

Returns the calendar displayed by the sheet. The calendar value will be midnight of the currently displayed day. Because Calendar objects are mutable, this method returns a copy of the sheet's internal calendar value.

Returns:

The calendar.

See Also:

setCalendar(java.util.Calendar)

getCalendar

public Calendar getCalendar(int y)

Returns the calendar that corresponds to the specified Y position.

Parameters:

y - The vertical Y position.

Returns:

The calendar.

Since:

JViews 8.0

setCalendar

public void setCalendar(Calendar calendar)

Sets the calendar representing the day that is displayed by the sheet.

Parameters:

calendar - The calendar to set.

See Also:

getCalendar()

getActivities

public List getActivities()

Returns the activities that are displayed on the sheet.

Returns:

The activities.

setActivities

public void setActivities(List activities,
                          IlvGanttModel ganttModel)

Sets the activities that are displayed on the sheet. Note that the sheet does not monitor changes to the activities and update itself automatically. Instead, the user must explicitly invoke this method every time the activities to be displayed have been modified.

Parameters:

activities - The activities.

ganttModel - The Gantt data model that contains the activities.

getSelectedActivities

public Collection getSelectedActivities()

Returns a collection of the currently selected activities.

Returns:

The selected activities.

See Also:

setSelectedActivities(java.util.Collection)

setSelectedActivities

public void setSelectedActivities(Collection activities)

Sets the collection of activities that are currently selected.

Parameters:

activities - The selected activities.

See Also:

getSelectedActivities()

getHourHeight

public int getHourHeight()

Returns the height of each hour interval.

Returns:

The interval height.

See Also:

setHourHeight(int)

setHourHeight

public void setHourHeight(int height)

Sets the height of each hour interval.

Parameters:

height - The interval height.

See Also:

getHourHeight()

getActivityColumnCount

public int getActivityColumnCount()

Returns the number of activity columns being displayed.

Returns:

The number of activity columns.

getActivitySpacing

public int getActivitySpacing()

Returns the horizontal spacing between activity bars and milestones.

Returns:

The activity spacing.

See Also:

setActivitySpacing(int)

setActivitySpacing

public void setActivitySpacing(int spacing)

Sets the horizontal spacing between activity bars and milestones.

Parameters:

spacing - The activity spacing.

See Also:

getActivitySpacing()

getHourOfDay

public float getHourOfDay(int y)

Returns the hour of the day that corresponds to the specified Y position.

Parameters:

y - The vertical Y position.

Returns:

The hour of the day.

getY

public float getY(float hourOfDay)

Returns the vertical Y position within the sheet that corresponds to the specified hour of the day.

Parameters:

hourOfDay - The hour of the day, which should be a value from 0 to 24.

Returns:

The Y position.

getY

public float getY(Calendar calendar)

Returns the vertical Y position within the sheet that corresponds to the hour of the day of the specified calendar.

Parameters:

calendar - The calendar.

Returns:

The Y position.

getActivity

public IlvActivity getActivity(Point point)

Returns the activity or milestone that is displayed at the specified point. This method returns null if the location does not lie in an activity or a milestone.

Parameters:

point - The location of interest.

Returns:

The activity displayed at the location, or null.

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size of the sheet.

Overrides:

getPreferredSize in class JComponent

Returns:

The preferred size of the sheet, as a Dimension.

getMaximumSize

public Dimension getMaximumSize()

Returns the maximum size of the sheet.

Overrides:

getMaximumSize in class JComponent

Returns:

The maximum size of the sheet, as a Dimension.

getToolTipText

public String getToolTipText(MouseEvent event)

Returns the string to be used as the tooltip for the specified mouse event. If the mouse lies within an activity or a milestone, then the corresponding renderer is asked to supply the tooltip. Otherwise, any tooltip that has been globally set on the sheet by calling its setToolTipText method is returned.

Overrides:

getToolTipText in class JComponent

Parameters:

event - The mouse event that caused the ToolTipManager to show the tooltip.

Returns:

The tooltip text.

getPreferredVisibleHours

public int getPreferredVisibleHours()

Returns the preferred number of hours that will be displayed when the activity sheet is placed in a scrollpane. The default value is 8.

Returns:

The preferred number of hours to display.

See Also:

setPreferredVisibleHours(int)

setPreferredVisibleHours

public void setPreferredVisibleHours(int visibleHours)

Sets the preferred number of hours that will be displayed when the activity sheet is placed in a scrollpane. The value of this property only affects the value of the the activity sheet's getPreferredScrollableViewportSize() property.

Parameters:

visibleHours - The preferred number of visible hours.

See Also:

getPreferredVisibleHours()

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Returns the preferred size of the viewport for this activity sheet.

Specified by:

getPreferredScrollableViewportSize in interface Scrollable

Returns:

The preferredSize of a JViewport whose view is this activity sheet.

See Also:

getPreferredVisibleHours()

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
                                      int orientation,
                                      int direction)

Returns the distance to scroll to expose the next or previous hour row for vertical scrolling, or the value of 1 pixel for horizontal scrolling.

Specified by:

getScrollableUnitIncrement in interface Scrollable

Parameters:

visibleRect - The visible rectangle

orientation - The scroll orientation, which must be either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.

direction - The scroll direction, which will be less than zero to scroll up/left or greater than zero for down/right.

Returns:

The distance, in pixels, to scroll to expose the next or previous unit.

getScrollableBlockIncrement

public int getScrollableBlockIncrement(Rectangle visibleRect,
                                       int orientation,
                                       int direction)

Returns the distance to scroll to expose the next or previous block of hour rows for vertical scrolling, or the value of 10 pixels for horizontal scrolling.

Specified by:

getScrollableBlockIncrement in interface Scrollable

Parameters:

visibleRect - The visible rectangle

orientation - The scroll orientation, which must be either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.

direction - The scroll direction, which will be less than zero to scroll up/left or greater than zero for down/right.

Returns:

The distance, in pixels, to scroll to expose the next or previous block.

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Returns true to indicate that a viewport should always force the width of the activity sheet to match the width of the viewport. Note, that this effectively disables horizontal scrolling when the activity sheet is placed in a JScrollPane.

Specified by:

getScrollableTracksViewportWidth in interface Scrollable

Returns:

true, which indicates that a viewport should force the activity sheet's width to match its own.

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Returns false to indicate that a viewport should not force the height of the activity sheet to match the height of the viewport. Note, that this effectively enables vertical scrolling when the activity sheet is placed in a JScrollPane.

Specified by:

getScrollableTracksViewportHeight in interface Scrollable

Returns:

false, which indicates that a viewport should not force the activity sheet's height to match its own.

getHourPaint

public Paint getHourPaint()

Returns the paint object used to stroke the hour grid lines.

Returns:

The hour grid line paint, or null if the hour grid lines will not be stroked.

See Also:

setHourPaint(java.awt.Paint)

setHourPaint

public void setHourPaint(Paint paint)

Sets the paint object used to stroke the hour grid lines.

Parameters:

paint - The hour grid line paint, or null to indicate that the hour grid lines will not be stroked.

See Also:

getHourPaint()

getHourStroke

public Stroke getHourStroke()

Returns the style used to stroke the hour grid lines. The default value is a BasicStroke.

Returns:

The stroke style, or null if the hour grid lines will not be stroked.

See Also:

setHourStroke(java.awt.Stroke)

setHourStroke

public void setHourStroke(Stroke stroke)

Sets the style used to stroke the hour grid lines.

Parameters:

stroke - The stroke style, or null to indicate that the hour grid lines will not be stroked.

See Also:

getHourStroke()

getHalfHourPaint

public Paint getHalfHourPaint()

Returns the paint object used to stroke the half hour grid lines.

Returns:

The half hour grid line paint, or null if the half hour grid lines will not be stroked.

See Also:

setHalfHourPaint(java.awt.Paint)

setHalfHourPaint

public void setHalfHourPaint(Paint paint)

Sets the paint object used to stroke the half hour grid lines.

Parameters:

paint - The half hour grid line paint, or null to indicate that the half hour grid lines will not be stroked.

See Also:

getHalfHourPaint()

getHalfHourStroke

public Stroke getHalfHourStroke()

Returns the style used to stroke the half hour grid lines. The default value is a BasicStroke.

Returns:

The stroke style, or null if the half hour grid lines will not be stroked.

See Also:

setHalfHourStroke(java.awt.Stroke)

setHalfHourStroke

public void setHalfHourStroke(Stroke stroke)

Sets the style used to stroke the half hour grid lines.

Parameters:

stroke - The stroke style, or null to indicate that the half hour grid lines will not be stroked.

See Also:

getHalfHourStroke()

getActivityRenderer

public IlvActivityCalendarRenderer getActivityRenderer()

Returns the renderer that is used to draw the graphic presentation of activities within the activity sheet.

Returns:

The activity renderer.

See Also:

setActivityRenderer(ilog.views.gantt.swing.calendarview.IlvActivityCalendarRenderer)

setActivityRenderer

public void setActivityRenderer(IlvActivityCalendarRenderer activityRenderer)

Sets the renderer that will be used to draw the graphic presentation of activities within the activity sheet.

Parameters:

activityRenderer - The activity renderer.

See Also:

getActivityRenderer()

getMilestoneRenderer

public IlvMilestoneCalendarRenderer getMilestoneRenderer()

Returns the renderer that is used to draw the graphic presentation of milestones within the activity sheet.

Returns:

The milestone renderer.

See Also:

setMilestoneRenderer(ilog.views.gantt.swing.calendarview.IlvMilestoneCalendarRenderer)

setMilestoneRenderer

public void setMilestoneRenderer(IlvMilestoneCalendarRenderer milestoneRenderer)

Sets the renderer that will be used to draw the graphic presentation of milestones within the activity sheet.

Parameters:

milestoneRenderer - The milestone renderer.

See Also:

getMilestoneRenderer()

paintComponent

public void paintComponent(Graphics g)

Paints the activity sheet.

Overrides:

paintComponent in class JComponent

Parameters:

g - The graphics context.