edu.cmu.hcii.calo.view.panes.CALOPane Class Reference

Inherits edu.cmu.hcii.calo.view.CALOComponent.

Inheritance diagram for edu.cmu.hcii.calo.view.panes.CALOPane:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

A generic pane in the CALO sidebar.

Author:
Will Haines


Public Member Functions

 CALOPane (String title, CALOComponent component, boolean scrollable, boolean collapsible, boolean resizable)
 Constructs a CALOPane with the given properties.
CALOComponent getCALOComponent ()
 Returns the component contained in this pane.
String getTitle ()
 Returns the title of this pane.
boolean isCollapsible ()
 Returns whether the pane is collapsible.
boolean isResizable ()
 Returns whether the pane is resizable.
boolean isScrollable ()
 Returns whether the pane is scrollable.
void setBorder (Border border)
 Sets the border of this pane.
void setCollapsible (boolean collapsible)
 Sets whether this pane is collapsible.
void setResizable (boolean resizable)
 Sets whether this pane is resizable.
void setScrollable (boolean scrollable)
 Sets whether this pane is scrollable.
void update ()
 Updates the visualization of this pane.

Static Public Member Functions

static void main (String[] args)
 Runs a small test program to verify that CALOPane works correctly.

Private Member Functions

void reAddComponents ()
 Removes the title view, component, and draggy bit from this pane and re-adds them with the appropriate constraints.

Private Attributes

Dimension savedSize
 The last known size of this pane when it's expanded.
String title
 The title of this pane.
boolean scrollable
 Whether this pane is scrollable.
boolean resizable
 Whether this pane is resizable.
boolean collapsible
 Whether this pane is collapsible.
boolean wasExpandedBeforeLastUpdate
 Whether this pane was expanded before the last time update() was called on it.
boolean wasExpandedBeforeTitleViewRemoved
 Whether this pane was expanded before the title view was removed from it.
Controls
Swing controls displayed in the pane.

PaneTitleView titleView
CALOComponent component
DraggyBit draggyBit

Static Private Attributes

static final long serialVersionUID = 7319381556003412785L
 Prevent serialization collisions.


Constructor & Destructor Documentation

edu.cmu.hcii.calo.view.panes.CALOPane.CALOPane ( String  title,
CALOComponent  component,
boolean  scrollable,
boolean  collapsible,
boolean  resizable 
)

Constructs a CALOPane with the given properties.

Parameters:
title the title of the pane
component the main component that should be displayed inside the pane
scrollable if true, this pane will expand its component to fill it, which is the desired behavior if the component is inside a scroll pane
collapsible if true, this pane's title region will have a collapse button
resizable if true, this pane will have a draggy bit at the bottom of it to allow the user to resize the pane


Member Function Documentation

static void edu.cmu.hcii.calo.view.panes.CALOPane.main ( String[]  args  )  [static]

Runs a small test program to verify that CALOPane works correctly.

Parameters:
args command-line args; don't bother passing any

CALOComponent edu.cmu.hcii.calo.view.panes.CALOPane.getCALOComponent (  ) 

Returns the component contained in this pane.

Returns:
the component

String edu.cmu.hcii.calo.view.panes.CALOPane.getTitle (  ) 

Returns the title of this pane.

Returns:
the title

boolean edu.cmu.hcii.calo.view.panes.CALOPane.isCollapsible (  ) 

Returns whether the pane is collapsible.

Returns:
whether the pane is collapsible

boolean edu.cmu.hcii.calo.view.panes.CALOPane.isResizable (  ) 

Returns whether the pane is resizable.

Returns:
whether the pane is resizable

boolean edu.cmu.hcii.calo.view.panes.CALOPane.isScrollable (  ) 

Returns whether the pane is scrollable.

Returns:
whether the pane is scrollable

void edu.cmu.hcii.calo.view.panes.CALOPane.reAddComponents (  )  [private]

Removes the title view, component, and draggy bit from this pane and re-adds them with the appropriate constraints.

This allows the pane's appearance to be updated if its collapsibility or resizability are changed after it is created.

void edu.cmu.hcii.calo.view.panes.CALOPane.setBorder ( Border  border  ) 

Sets the border of this pane.

This is overridden because reAddComponents() has to take into account the border size for some strange reason.

Parameters:
border the border to set

void edu.cmu.hcii.calo.view.panes.CALOPane.setCollapsible ( boolean  collapsible  ) 

Sets whether this pane is collapsible.

Parameters:
collapsible whether this pane is collapsible

void edu.cmu.hcii.calo.view.panes.CALOPane.setResizable ( boolean  resizable  ) 

Sets whether this pane is resizable.

Parameters:
resizable whether this pane is resizable

void edu.cmu.hcii.calo.view.panes.CALOPane.setScrollable ( boolean  scrollable  ) 

Sets whether this pane is scrollable.

Parameters:
scrollable whether this pane is scrollable

void edu.cmu.hcii.calo.view.panes.CALOPane.update (  ) 

Updates the visualization of this pane.

Sets up the expansion.


Member Data Documentation

final long edu.cmu.hcii.calo.view.panes.CALOPane.serialVersionUID = 7319381556003412785L [static, private]

Prevent serialization collisions.

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

Dimension edu.cmu.hcii.calo.view.panes.CALOPane.savedSize [private]

The last known size of this pane when it's expanded.

String edu.cmu.hcii.calo.view.panes.CALOPane.title [private]

The title of this pane.

boolean edu.cmu.hcii.calo.view.panes.CALOPane.scrollable [private]

Whether this pane is scrollable.

boolean edu.cmu.hcii.calo.view.panes.CALOPane.resizable [private]

Whether this pane is resizable.

boolean edu.cmu.hcii.calo.view.panes.CALOPane.collapsible [private]

Whether this pane is collapsible.

boolean edu.cmu.hcii.calo.view.panes.CALOPane.wasExpandedBeforeLastUpdate [private]

Whether this pane was expanded before the last time update() was called on it.

boolean edu.cmu.hcii.calo.view.panes.CALOPane.wasExpandedBeforeTitleViewRemoved [private]

Whether this pane was expanded before the title view was removed from it.


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