ilog.views.gantt.swing.calendarview

Class IlvMonthView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ilog.views.gantt.swing.calendarview.IlvMonthView

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class IlvMonthView
extends JPanel

IlvMonthView is a Swing component that displays activities from a Gantt data model overlaid on a monthly calendar grid. It groups an IlvMonthPanel with a vertical scroll bar that allows you to increment or decrement the month.

The month view displays the leaf activities and milestones of the Gantt data model set on it. The view also listens for changes to the data model and updates itself dynamically. Leaf activities from the data model are displayed using the currently set activity renderer and milestones are displayed using the current milestone renderer. You can also set a static holiday data model on the month view. Leaf activities from the holiday model are displayed using the holiday renderer. Note, that the month view does not listen for dynamic updates to the holiday data model.

Since:

JViews 7.5

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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
IlvMonthView() Creates a new month view.
IlvMonthView(IlvGanttModel ganttModel) Creates a new month view that displays the activities in the specified Gantt data model.

Method Summary

Modifier and Type	Method and Description
void	addSelectionListener(SelectionListener listener) Adds the specified selection listener to receive selection events from this panel.
void	decrementMonth() Decrements the view to display the preceding month.
void	deselectAllActivities() Deselects all of the currently selected activities.
IlvActivityCalendarRenderer	getActivityRenderer() Returns the renderer that is used to draw the graphic presentation of activities within the month panel.
Calendar	getCalendar() Returns the calendar displayed by the view.
IlvCalendarModel	getCalendarModel() Returns the model that holds the calendar displayed by the view.
Date	getDate() Returns the date displayed by the view.
IlvGanttModel	getGanttModel() Returns the Gantt data model that is being displayed.
IlvGanttModel	getHolidayModel() Returns the holiday model that is being displayed.
IlvActivityCalendarRenderer	getHolidayRenderer() Returns the renderer that is used to draw the graphic presentation of holidays within the month panel.
IlvMilestoneCalendarRenderer	getMilestoneRenderer() Returns the renderer that is used to draw the graphic presentation of milestones within the month panel.
IlvMonthPanel	getMonthPanel() Returns the view's month panel component.
int	getMonthScrollRange() Returns the range of the vertical scroll bar, in months.
List	getSelectedActivities() Returns a list of the currently selected activities.
ULocale	getULocale() Returns the locale of this component.
void	incrementMonth() Increments the view to display the next month.
boolean	isMouseSelectionEnabled() Returns whether mouse selection of activities is enabled.
boolean	isSelected(IlvActivity activity) Returns whether the specified activity is currently selected.
void	removeSelectionListener(SelectionListener listener) Remove the specified selection listener so that it no longer receives selection events from this panel.
void	setActivityRenderer(IlvActivityCalendarRenderer activityRenderer) Sets the renderer that will be used to draw the graphic presentation of activities within the month panel.
void	setCalendar(Calendar calendar) Sets the calendar displayed by the view.
void	setCalendarModel(IlvCalendarModel calendarModel) Sets the model that holds the calendar displayed by the view.
void	setDate(Date date) Sets the date displayed by the view.
void	setGanttModel(IlvGanttModel ganttModel) Sets the Gantt data model that will be displayed.
void	setHolidayModel(IlvGanttModel holidays) Sets the holiday model that will be displayed.
void	setHolidayRenderer(IlvActivityCalendarRenderer holidayRenderer) Sets the renderer that will be used to draw the graphic presentation of holidays within the month panel.
void	setLocale(Locale locale) Sets the locale of this component.
void	setMilestoneRenderer(IlvMilestoneCalendarRenderer milestoneRenderer) Sets the renderer that will be used to draw the graphic presentation of milestones within the month panel.
void	setMonthScrollRange(int months) Sets the range of the vertical scroll bar, in months.
void	setMouseSelectionEnabled(boolean enabled) Sets whether mouse selection of activities is enabled.
void	setSelected(IlvActivity activity, boolean selected) Selects or deselects the specified activity.
void	setULocale(ULocale locale) Sets the locale of this component.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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, 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, 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

IlvMonthView

public IlvMonthView()

Creates a new month view.

IlvMonthView

public IlvMonthView(IlvGanttModel ganttModel)

Creates a new month view that displays the activities in the specified Gantt data model.

Parameters:

ganttModel - The Gantt data model.

Method Detail

getULocale

public ULocale getULocale()

Returns the locale of this component. If none is set on this component, this component inherits its locale from the parent component.

Returns:

An ICU ULocale.

Throws:

IllegalStateException - if this component's locale has been removed through setLocale(null) and none of the ancestors has a Locale set either

Since:

JViews 8.8

See Also:

setULocale(ULocale)

setULocale

public void setULocale(ULocale locale)

Sets the locale of this component.

Parameters:

locale - An ICU ULocale, or null if this component shall inherit its locale from the parent component.

Since:

JViews 8.8

See Also:

getULocale(), setLocale(Locale)

setLocale

public void setLocale(Locale locale)

Sets the locale of this component.

Overrides:

setLocale in class Component

Parameters:

locale - An Locale, or null if this component shall inherit its locale from the parent component.

See Also:

setULocale(ULocale)

getMonthPanel

public IlvMonthPanel getMonthPanel()

Returns the view's month panel component.

Returns:

The month panel.

getMonthScrollRange

public int getMonthScrollRange()

Returns the range of the vertical scroll bar, in months. The default value is 24.

Returns:

The scroll range, in months.

See Also:

setMonthScrollRange(int)

setMonthScrollRange

public void setMonthScrollRange(int months)

Sets the range of the vertical scroll bar, in months.

Parameters:

months - The scroll range.

See Also:

getMonthScrollRange()

getCalendarModel

public IlvCalendarModel getCalendarModel()

Returns the model that holds the calendar displayed by the view.

Returns:

The calendar model.

See Also:

setCalendarModel(ilog.views.util.swing.calendar.IlvCalendarModel)

setCalendarModel

public void setCalendarModel(IlvCalendarModel calendarModel)

Sets the model that holds the calendar displayed by the view.

Parameters:

calendarModel - The calendar model.

See Also:

getCalendarModel()

getCalendar

public Calendar getCalendar()

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

Returns:

The calendar.

See Also:

setCalendar(java.util.Calendar)

setCalendar

public void setCalendar(Calendar calendar)

Sets the calendar displayed by the view.

Parameters:

calendar - The calendar to set.

See Also:

getCalendar()

getDate

public Date getDate()

Returns the date displayed by the view. The date value will be the first day of the currently displayed month.

Returns:

The date.

See Also:

setDate(java.util.Date)

setDate

public void setDate(Date date)

Sets the date displayed by the view.

Parameters:

date - The date to set.

See Also:

getDate()

incrementMonth

public void incrementMonth()

Increments the view to display the next month.

decrementMonth

public void decrementMonth()

Decrements the view to display the preceding month.

getGanttModel

public IlvGanttModel getGanttModel()

Returns the Gantt data model that is being displayed.

Returns:

The Gantt data model.

See Also:

setGanttModel(ilog.views.gantt.IlvGanttModel)

setGanttModel

public void setGanttModel(IlvGanttModel ganttModel)

Sets the Gantt data model that will be displayed. The month view will display and dynamically update the leaf activities and milestones from the data model. Leaf activities will be displayed using the activity renderer and milestones will be displayed using the milestone renderer.

Parameters:

ganttModel - The Gantt data model.

See Also:

getGanttModel()

getHolidayModel

public IlvGanttModel getHolidayModel()

Returns the holiday model that is being displayed.

Returns:

The holiday model.

See Also:

setHolidayModel(ilog.views.gantt.IlvGanttModel)

setHolidayModel

public void setHolidayModel(IlvGanttModel holidays)

Sets the holiday model that will be displayed. The month view will display the leaf activities of the holiday model using the holiday renderer.

Parameters:

holidays - The holiday model.

See Also:

getHolidayModel()

getActivityRenderer

public IlvActivityCalendarRenderer getActivityRenderer()

Returns the renderer that is used to draw the graphic presentation of activities within the month panel.

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 month panel.

Parameters:

activityRenderer - The activity renderer.

See Also:

getActivityRenderer()

getHolidayRenderer

public IlvActivityCalendarRenderer getHolidayRenderer()

Returns the renderer that is used to draw the graphic presentation of holidays within the month panel.

Returns:

The holiday renderer.

See Also:

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

setHolidayRenderer

public void setHolidayRenderer(IlvActivityCalendarRenderer holidayRenderer)

Sets the renderer that will be used to draw the graphic presentation of holidays within the month panel.

Parameters:

holidayRenderer - The holiday renderer.

See Also:

getHolidayRenderer()

getMilestoneRenderer

public IlvMilestoneCalendarRenderer getMilestoneRenderer()

Returns the renderer that is used to draw the graphic presentation of milestones within the month panel.

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 month panel.

Parameters:

milestoneRenderer - The milestone renderer.

See Also:

getMilestoneRenderer()

setSelected

public void setSelected(IlvActivity activity,
                        boolean selected)

Selects or deselects the specified activity.

Parameters:

activity - The activity to select or deselect.

selected - true to select the activity or false to deselect it.

See Also:

isSelected(ilog.views.gantt.IlvActivity), deselectAllActivities(), getSelectedActivities()

deselectAllActivities

public void deselectAllActivities()

Deselects all of the currently selected activities.

See Also:

isSelected(ilog.views.gantt.IlvActivity), setSelected(ilog.views.gantt.IlvActivity, boolean), getSelectedActivities()

getSelectedActivities

public List getSelectedActivities()

Returns a list of the currently selected activities.

Returns:

A list of the selected activities.

See Also:

isSelected(ilog.views.gantt.IlvActivity), setSelected(ilog.views.gantt.IlvActivity, boolean), deselectAllActivities()

isSelected

public boolean isSelected(IlvActivity activity)

Returns whether the specified activity is currently selected.

Parameters:

activity - The activity.

Returns:

true if the activity is selected, or false otherwise.

See Also:

setSelected(ilog.views.gantt.IlvActivity, boolean), deselectAllActivities(), getSelectedActivities()

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Adds the specified selection listener to receive selection events from this panel.

Parameters:

listener - The selection listener.

See Also:

removeSelectionListener(ilog.views.gantt.event.SelectionListener)

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Remove the specified selection listener so that it no longer receives selection events from this panel.

Parameters:

listener - The selection listener.

See Also:

addSelectionListener(ilog.views.gantt.event.SelectionListener)

isMouseSelectionEnabled

public boolean isMouseSelectionEnabled()

Returns whether mouse selection of activities is enabled. The default is true

Returns:

true if mouse selection is enabled, false otherwise.

See Also:

setMouseSelectionEnabled(boolean)

setMouseSelectionEnabled

public void setMouseSelectionEnabled(boolean enabled)

Sets whether mouse selection of activities is enabled.

Parameters:

enabled - true to enable mouse selection or false to disable mouse selection.

See Also:

isMouseSelectionEnabled()