BlockCanvas

java.lang.Object
- edu.mit.blocks.workspace.BlockCanvas

All Implemented Interfaces:

ISupportMemento, PageChangeListener
```
public class BlockCanvas
extends java.lang.Object
implements PageChangeListener, ISupportMemento
```
A BlockCanvas is a container of Pages and is a scrollable panel. When a page is added to a BlockCanvas, that particular new page must be added to both the data structure holding the set of pages and the scrollable panel that renders the page. A BlockCanvas is also a PageChangeListener. When any pages are changed, the Blockcanvas must update itself appropriately to reflect this change. As of the current implementation, the BlockCanvas must have at least one Page when it becomes visible (that is, when its viewable JComponent becomes visible).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class BlockCanvas.Canvas
The graphical representation of the block canvas's Swng Container of pages.

Nested Classes
Modifier and Type	Class and Description
`class`	`BlockCanvas.Canvas` The graphical representation of the block canvas's Swng Container of pages.

Constructor Summary

Constructors
Constructor and Description

BlockCanvas(Workspace workspace)
Constructs BlockCanvas and subscribes this BlockCanvas to PageChange events

Constructors
Constructor and Description
`BlockCanvas(Workspace workspace)` Constructs BlockCanvas and subscribes this BlockCanvas to PageChange events

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPage(Page page)`
`void`	`addPage(Page page, int position)`
`void`	`arrangeAllBlocks()`
`java.lang.Iterable<RenderableBlock>`	`getBlocks()`
`javax.swing.JComponent`	`getCanvas()`
`int`	`getHeight()`
`javax.swing.BoundedRangeModel`	`getHorizontalModel()`
`javax.swing.JComponent`	`getJComponent()` Warning: Please take special care in useing this method, as it exposes implementation details.
`java.util.List<Page>`	`getLeftmostPages(int left)`
`Page`	`getPageNamed(java.lang.String name)`
`java.util.List<Page>`	`getPages()`
`org.w3c.dom.Node`	`getSaveNode(org.w3c.dom.Document document)` Returns an XML node describing all the blocks and pages within the BlockCanvas
`java.lang.Object`	`getState()`
`java.lang.Iterable<RenderableBlock>`	`getTopLevelBlocks()`
`javax.swing.BoundedRangeModel`	`getVerticalModel()`
`int`	`getWidth()`
`int`	`getX()`
`int`	`getY()`
`boolean`	`hasPageAt(int position)`
`void`	`loadState(java.lang.Object memento)`
`int`	`numOfPages()`
`void`	`reformBlockCanvas()`
`Page`	`removePage(int position)`
`Page`	`removePage(Page page)`
`Page`	`renamePage(java.lang.String oldName, java.lang.String newName)`
`void`	`reset()`
`void`	`scrollToComponent(javax.swing.JComponent c)`
`void`	`scrollToShowBlock(RenderableBlock block)`
`void`	`switchViewToPage(Page page)`
`java.lang.String`	`toString()`
`void`	`update()` notifies this PageChangeListener that at least one of the pages have changed states.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BlockCanvas
```
public BlockCanvas(Workspace workspace)
```
    Constructs BlockCanvas and subscribes this BlockCanvas to PageChange events
- Method Detail
  - reset
```
public void reset()
```
  - getX
```
public int getX()
```
    Returns:
    
    X Coordinate of BlockCanvas graphical representation
  - getY
```
public int getY()
```
    Returns:
    
    Y coordinate of BlockCanvas graphical representation
  - getWidth
```
public int getWidth()
```
    Returns:
    
    width of BlockCanvas graphical representation
  - getHeight
```
public int getHeight()
```
    Returns:
    
    height of BlockCanvas graphical representation
  - getVerticalModel
```
public javax.swing.BoundedRangeModel getVerticalModel()
```
    Returns:
    
    vertical scroll bar bounding range model. MAY BE NULL
  - getHorizontalModel
```
public javax.swing.BoundedRangeModel getHorizontalModel()
```
    Returns:
    
    horizontal scroll bar bounding range model. MAY BE NULL
  - getCanvas
```
public javax.swing.JComponent getCanvas()
```
    Returns:
    
    the Swing Container that holds all the graphical panels of all the pages in this Blockcanvas
  - getJComponent
```
public javax.swing.JComponent getJComponent()
```
    Warning: Please take special care in useing this method, as it exposes implementation details.
    
    Returns:
    
    JComponent representation of this
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string representation of this
  - getLeftmostPages
```
public java.util.List<Page> getLeftmostPages(int left)
```
  - getBlocks
```
public java.lang.Iterable<RenderableBlock> getBlocks()
```
    Returns:
    
    the RendearbleBlocks that are contained within this widget or an empty Iterable if no blocks exists
  - arrangeAllBlocks
```
public void arrangeAllBlocks()
```
  - getTopLevelBlocks
```
public java.lang.Iterable<RenderableBlock> getTopLevelBlocks()
```
    Returns:
    
    a collection of top level blocks within this page (blocks with no parents that and are the first block of each stack) or an empty collection if no blocks are found on this page.
  - scrollToShowBlock
```
public void scrollToShowBlock(RenderableBlock block)
```
    Parameters:
    
    block - - the RenderableBlock to make sure is shown in the viewport
  - scrollToComponent
```
public void scrollToComponent(javax.swing.JComponent c)
```
  - numOfPages
```
public int numOfPages()
```
    Returns:
    
    the number of Pages.
  - hasPageAt
```
public boolean hasPageAt(int position)
```
    Parameters:
    
    position - - 0 is the left most position
    
    Returns:
    
    true if there exists a page at the specified position
  - getPageNamed
```
public Page getPageNamed(java.lang.String name)
```
    Parameters:
    
    name - - name of page
    
    Returns:
    
    FIRST page with matchng name (if more than one page has matching name, it returns the first) or null if no matching name exists.
  - getPages
```
public java.util.List<Page> getPages()
```
    Returns:
    
    List of pages or an empty list if no pages exists
  - addPage
```
public void addPage(Page page)
```
    Parameters:
    
    page - the page to add to the BlockCanvas
  - addPage
```
public void addPage(Page page,
                    int position)
```
    Parameters:
    
    page - - page to be added
    
    position - - the index at which to add the page where 0 is rightmost
    
    Throws:
    
    java.lang.RuntimeException - if (position < 0 || position > pages.size() || page == null)
  - removePage
```
public Page removePage(Page page)
```
    Parameters:
    
    page - - the page to be removed
  - removePage
```
public Page removePage(int position)
```
    Parameters:
    
    position - - 0 is the left most page
    
    Returns:
    
    the page that was removed or null if non was removed.
  - switchViewToPage
```
public void switchViewToPage(Page page)
```
    Parameters:
    
    page - the desired page to switch view to
  - renamePage
```
public Page renamePage(java.lang.String oldName,
                       java.lang.String newName)
```
    Parameters:
    
    oldName - - the original name of the page
    
    newName - - the String name to rename the page to
    
    Returns:
    
    If a matching page was found, return the renamed Page. Otherwise, return null.
  - update
```
public void update()
```
    Description copied from interface: PageChangeListener
    
    notifies this PageChangeListener that at least one of the pages have changed states.
    
    Specified by:
    
    update in interface PageChangeListener
  - reformBlockCanvas
```
public void reformBlockCanvas()
```
  - getSaveNode
```
public org.w3c.dom.Node getSaveNode(org.w3c.dom.Document document)
```
    Returns an XML node describing all the blocks and pages within the BlockCanvas
    
    Returns:
    
    Node or null if there are no pages
  - getState
```
public java.lang.Object getState()
```
    Specified by:
    
    getState in interface ISupportMemento
  - loadState
```
public void loadState(java.lang.Object memento)
```
    Specified by:
    
    loadState in interface ISupportMemento

Class BlockCanvas

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BlockCanvas

Method Detail

reset

getX

getY

getWidth

getHeight

getVerticalModel

getHorizontalModel

getCanvas

getJComponent

toString

getLeftmostPages

getBlocks

arrangeAllBlocks

getTopLevelBlocks

scrollToShowBlock

scrollToComponent

numOfPages

hasPageAt

getPageNamed

getPages

addPage

addPage

removePage

removePage

switchViewToPage

renamePage

update

reformBlockCanvas

getSaveNode

getState

loadState