edu.cmu.hcii.calo.view.CALOComponent Class Reference

Inherits edu.cmu.hcii.calo.view.TranslucentView.

Inherited by edu.cmu.hcii.calo.thinkaloud.WOZFrontEndNotificationPanel, edu.cmu.hcii.calo.thinkaloud.WOZFrontEndTaskPanel, edu.cmu.hcii.calo.view.AnimatedPane, edu.cmu.hcii.calo.view.CALOScrollPane, edu.cmu.hcii.calo.view.iconwell.IconWellView, edu.cmu.hcii.calo.view.ImageStretchView, edu.cmu.hcii.calo.view.notification.NotificationGroupTitleView, edu.cmu.hcii.calo.view.notification.NotificationGroupView, edu.cmu.hcii.calo.view.notification.NotificationView, edu.cmu.hcii.calo.view.panes.CALOPane, edu.cmu.hcii.calo.view.panes.PaneTitleView, edu.cmu.hcii.calo.view.relevantstuff.RelevantStuffPaneView, edu.cmu.hcii.calo.view.schedule.ScheduleItemView, edu.cmu.hcii.calo.view.schedule.SchedulePaneView, edu.cmu.hcii.calo.view.task.ExpandedTaskInfoPanel, edu.cmu.hcii.calo.view.task.TaskPaneView, edu.cmu.hcii.calo.view.task.TaskView, edu.cmu.hcii.calo.view.task.viewer.TaskViewerPanel, edu.cmu.hcii.calo.view.task.viewer.TaskViewerTaskList, and edu.cmu.hcii.calo.view.task.viewer.TaskViewerTaskListCell.

Inheritance diagram for edu.cmu.hcii.calo.view.CALOComponent:

Inheritance graph
[legend]
Collaboration diagram for edu.cmu.hcii.calo.view.CALOComponent:

Collaboration graph
[legend]
List of all members.

Detailed Description

The base class for a CALO view.

The only differences between this and a TranslucentView is that the JComponent.firePropertyChange(String, Object, Object) method is promoted from protected to public to allow PropertyChangeForwarder to work, and a PropertyChangeForwarder is automatically installed in any components added to this one with this CALOComponent as the delegator. This means that to the extent that your view hierarchy consists solely of CALOComponent-derived panes, property change events will be propagated up the hierarchy automatically.

Author:
Brian Ellis


Public Member Functions

void firePropertyChange (String propertyName, Object oldValue, Object newValue)
 Calls super.firePropertyChange(propertyName, oldValue, newValue).
Dimension getPreferredScrollableViewportSize ()
 Returns the preferred size of this component's viewport when it's in a scroll pane.
int getScrollableBlockIncrement (Rectangle theVisibleRect, int theOrientation, int theDirection)
 Returns the scrollable block increment for this control when it's in a scroll pane.
boolean getScrollableTracksViewportHeight ()
 Returns whether this component should resize itself to match the height of the viewport of its containing scroll pane.
boolean getScrollableTracksViewportWidth ()
 Returns whether this component should resize itself to match the width of the viewport of its containing scroll pane.
int getScrollableUnitIncrement (Rectangle theVisibleRect, int theOrientation, int theDirection)
 Returns the scrollable unit increment for this control when it's in a scroll pane.

Protected Member Functions

void addImpl (Component comp, Object constraints, int index)
 Adds the given component to this container with the specified constraints at the specified index.

Protected Attributes

PropertyChangeForwarder forwarder = new PropertyChangeForwarder(this)
 The PropertyChangeForwarder that will be attached to all children of this component.

Static Private Attributes

static final long serialVersionUID = 893219346685374644L
 Prevent serialization collisions.


Member Function Documentation

void edu.cmu.hcii.calo.view.CALOComponent.addImpl ( Component  comp,
Object  constraints,
int  index 
) [protected]

Adds the given component to this container with the specified constraints at the specified index.

Overridden to also attach a PropertyChangeForwarder to the component being added.

Parameters:
comp the component to add
constraints the constraints to add it with
index the index to add it at

Reimplemented in edu.cmu.hcii.calo.view.task.TaskView.

void edu.cmu.hcii.calo.view.CALOComponent.firePropertyChange ( String  propertyName,
Object  oldValue,
Object  newValue 
)

Calls super.firePropertyChange(propertyName, oldValue, newValue).

Overridden to increase the visibility to public so the PropertyChangeForwarder can fire property change events with object parameters on behalf of this view.

Parameters:
propertyName the name of the property that is changing
oldValue the old value of the property
newValue the new value of the property
See also:
java.awt.Component.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

Dimension edu.cmu.hcii.calo.view.CALOComponent.getPreferredScrollableViewportSize (  ) 

Returns the preferred size of this component's viewport when it's in a scroll pane.

See also:
javax.swing.Scrollable.getPreferredScrollableViewportSize()

int edu.cmu.hcii.calo.view.CALOComponent.getScrollableBlockIncrement ( Rectangle  theVisibleRect,
int  theOrientation,
int  theDirection 
)

Returns the scrollable block increment for this control when it's in a scroll pane.

Parameters:
theVisibleRect the currently visible rectangle within the scroll pane
theOrientation the orientation of this component
theDirection the direction the pane is being scrolled
See also:
javax.swing.Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)

boolean edu.cmu.hcii.calo.view.CALOComponent.getScrollableTracksViewportHeight (  ) 

Returns whether this component should resize itself to match the height of the viewport of its containing scroll pane.

Always returns false (i.e., there will be a vertical scrollbar when necessary).

See also:
javax.swing.Scrollable.getScrollableTracksViewportHeight()

boolean edu.cmu.hcii.calo.view.CALOComponent.getScrollableTracksViewportWidth (  ) 

Returns whether this component should resize itself to match the width of the viewport of its containing scroll pane.

Always returns true (i.e., there will never be a horizontal scrollbar).

See also:
javax.swing.Scrollable.getScrollableTracksViewportWidth()

int edu.cmu.hcii.calo.view.CALOComponent.getScrollableUnitIncrement ( Rectangle  theVisibleRect,
int  theOrientation,
int  theDirection 
)

Returns the scrollable unit increment for this control when it's in a scroll pane.

Parameters:
theVisibleRect the currently visible rectangle within the scroll pane
theOrientation the orientation of this component
theDirection the direction the pane is being scrolled
See also:
javax.swing.Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int)


Member Data Documentation

final long edu.cmu.hcii.calo.view.CALOComponent.serialVersionUID = 893219346685374644L [static, private]

Prevent serialization collisions.

Reimplemented from edu.cmu.hcii.calo.view.TranslucentView.

Reimplemented in edu.cmu.hcii.calo.thinkaloud.WOZFrontEndNotificationPanel, edu.cmu.hcii.calo.thinkaloud.WOZFrontEndTaskPanel, edu.cmu.hcii.calo.view.CALOScrollPane, edu.cmu.hcii.calo.view.iconwell.IconWellView, edu.cmu.hcii.calo.view.ImageStretchView, edu.cmu.hcii.calo.view.notification.NotificationCenterView, edu.cmu.hcii.calo.view.notification.NotificationGroupTitleView, edu.cmu.hcii.calo.view.notification.NotificationGroupView, edu.cmu.hcii.calo.view.notification.NotificationView, edu.cmu.hcii.calo.view.panes.CALOPane, edu.cmu.hcii.calo.view.panes.PaneTitleView, edu.cmu.hcii.calo.view.relevantstuff.RelevantStuffPaneView, edu.cmu.hcii.calo.view.schedule.BlockScheduleView, edu.cmu.hcii.calo.view.schedule.ScheduleItemView, edu.cmu.hcii.calo.view.schedule.SchedulePaneView, edu.cmu.hcii.calo.view.task.ExpandedTaskInfoPanel, edu.cmu.hcii.calo.view.task.TaskPaneView, and edu.cmu.hcii.calo.view.task.TaskSubpaneContainerView.

PropertyChangeForwarder edu.cmu.hcii.calo.view.CALOComponent.forwarder = new PropertyChangeForwarder(this) [protected]

The PropertyChangeForwarder that will be attached to all children of this component.


The documentation for this class was generated from the following file:
Generated on Mon Aug 13 15:06:21 2007 for CALO by  doxygen 1.5.2