edu.mit.blocks.controller

Class WorkspaceController

java.lang.Object

edu.mit.blocks.controller.WorkspaceController

public class WorkspaceController
extends java.lang.Object

Example entry point to OpenBlock application creation.

Author:

Ricarose Roque

Constructor Summary

Constructors

Constructor and Description
WorkspaceController() Constructs a WorkspaceController instance that manages the interaction with the codeblocks.Workspace

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<SearchableContainer>	getAllSearchableContainers() Returns an unmodifiable Iterable of SearchableContainers
org.w3c.dom.Node	getSaveNode() Returns a DOM node for the entire workspace.
org.w3c.dom.Node	getSaveNode(boolean validate) Returns a DOM node for the entire workspace.
java.lang.String	getSaveString() Returns the save string for the entire workspace.
javax.swing.JComponent	getSearchBar() Returns a SearchBar instance capable of searching for blocks within the BlockCanvas and block drawers
Workspace	getWorkspace()
javax.swing.JComponent	getWorkspacePanel() Returns the JComponent of the entire workspace.
void	loadBlockLanguage(org.w3c.dom.Element root) Loads all the block genuses, properties, and link rules of a language specified in the pre-defined language def file.
void	loadFreshWorkspace() Loads a fresh workspace based on the default specifications in the language definition file.
void	loadProject(java.lang.String projectContents, java.lang.String langDefContents) Loads the programming project specified in the projectContents String, which is associated with the language definition file contained in the specified langDefContents.
void	loadProjectFromElement(org.w3c.dom.Element elementToLoad) Loads the programming project from the specified element.
void	loadProjectFromPath(java.lang.String path) Loads the programming project from the specified file path.
static void	main(java.lang.String[] args)
void	resetLanguage() Resets the current language within the active Workspace.
void	resetWorkspace() Resets the entire workspace.
void	setLangDefDtd(java.io.InputStream is)
void	setLangDefFilePath(java.lang.String filePath) Sets the file path for the language definition file, if the language definition file is located in
void	setLangDefStream(java.io.InputStream in) Sets language definition file from the given input stream
void	setLangResourceBundle(java.util.ResourceBundle bundle)
void	setSelectedFile(java.io.File selectedFile)
void	setStyleList(java.util.List<java.lang.String[]> list)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkspaceController

public WorkspaceController()

Constructs a WorkspaceController instance that manages the interaction with the codeblocks.Workspace

Method Detail

getWorkspace

public Workspace getWorkspace()

setLangDefDtd

public void setLangDefDtd(java.io.InputStream is)

setLangResourceBundle

public void setLangResourceBundle(java.util.ResourceBundle bundle)

setStyleList

public void setStyleList(java.util.List<java.lang.String[]> list)

setLangDefFilePath

public void setLangDefFilePath(java.lang.String filePath)

Sets the file path for the language definition file, if the language definition file is located in

setLangDefStream

public void setLangDefStream(java.io.InputStream in)

Sets language definition file from the given input stream

Parameters:

in - input stream to read

loadBlockLanguage

public void loadBlockLanguage(org.w3c.dom.Element root)

Loads all the block genuses, properties, and link rules of a language specified in the pre-defined language def file.

Parameters:

root - Loads the language specified in the Element root

resetLanguage

public void resetLanguage()

Resets the current language within the active Workspace.

getSaveString

public java.lang.String getSaveString()

Returns the save string for the entire workspace. This includes the block workspace, any custom factories, canvas view state and position, pages

Returns:

the save string for the entire workspace.

getSaveNode

public org.w3c.dom.Node getSaveNode()

Returns a DOM node for the entire workspace. This includes the block workspace, any custom factories, canvas view state and position, pages

Returns:

the DOM node for the entire workspace.

getSaveNode

public org.w3c.dom.Node getSaveNode(boolean validate)

Returns a DOM node for the entire workspace. This includes the block workspace, any custom factories, canvas view state and position, pages

Parameters:

validate - If true, perform a validation of the output against the code blocks schema

Returns:

the DOM node for the entire workspace.

loadFreshWorkspace

public void loadFreshWorkspace()

Loads a fresh workspace based on the default specifications in the language definition file. The block canvas will have no live blocks.

loadProjectFromPath

public void loadProjectFromPath(java.lang.String path)
                         throws java.io.IOException

Loads the programming project from the specified file path. This method assumes that a Language Definition File has already been specified for this programming project.

Parameters:

path - String file path of the programming project to load

Throws:

java.io.IOException

loadProjectFromElement

public void loadProjectFromElement(org.w3c.dom.Element elementToLoad)

Loads the programming project from the specified element. This method assumes that a Language Definition File has already been specified for this programming project.

Parameters:

element - element of the programming project to load

loadProject

public void loadProject(java.lang.String projectContents,
                        java.lang.String langDefContents)

Loads the programming project specified in the projectContents String, which is associated with the language definition file contained in the specified langDefContents. All the blocks contained in projectContents must have an associted block genus defined in langDefContents. If the langDefContents have any workspace settings such as pages or drawers and projectContents has workspace settings as well, the workspace settings within the projectContents will override the workspace settings in langDefContents. NOTE: The language definition contained in langDefContents does not replace the default language definition file set by: setLangDefFilePath() or setLangDefFile().

Parameters:

projectContents -

langDefContents - String XML that defines the language of projectContents

resetWorkspace

public void resetWorkspace()

Resets the entire workspace. This includes all blocks, pages, drawers, and trashed blocks. Also resets the undo/redo stack. The language (i.e. genuses and shapes) is not reset.

getWorkspacePanel

public javax.swing.JComponent getWorkspacePanel()

Returns the JComponent of the entire workspace.

Returns:

the JComponent of the entire workspace.

setSelectedFile

public void setSelectedFile(java.io.File selectedFile)

getSearchBar

public javax.swing.JComponent getSearchBar()

Returns a SearchBar instance capable of searching for blocks within the BlockCanvas and block drawers

getAllSearchableContainers

public java.lang.Iterable<SearchableContainer> getAllSearchableContainers()

Returns an unmodifiable Iterable of SearchableContainers

Returns:

an unmodifiable Iterable of SearchableContainers

main

public static void main(java.lang.String[] args)