ICY Version 1.0.1.0
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes

icy.workspace.Workspace Class Reference

Inheritance diagram for icy.workspace.Workspace:
icy.file.xml.XMLPersistent

List of all members.

Classes

class  TaskDefinition

Public Member Functions

 Workspace ()
 Workspace (File file) throws IllegalArgumentException
 Workspace (URL url) throws IllegalArgumentException
 Workspace (String name) throws IllegalArgumentException
String getLocalFilename ()
String getName ()
String getDescription ()
boolean isEmpty ()
void setName (String name)
void setDescription (String description)
boolean isInstalling ()
void clear ()
TaskDefinition findTask (String taskName)
BandDefinition findBand (String taskName, String bandName)
ItemDefinition findItem (String className)
ArrayList< TaskDefinitiongetTasks ()
ArrayList< ItemDefinitiongetAllItems ()
TaskDefinition addTask (RibbonTask ribbonTask)
ItemDefinition addItem (String taskName, String bandName, String className)
boolean removeTask (String taskName)
boolean load ()
boolean load (File file)
boolean load (URL url)
boolean loadFromXML (Node node)
boolean save ()
boolean saveToXML (Node node)
boolean install (PluginRepositoryLoader onlineLoader, final ProgressFrame progressFrame)
int compareTo (Workspace o)

Static Public Member Functions

static boolean contains (ArrayList< TaskDefinition > tasks, TaskDefinition task)
static boolean contains (ArrayList< BandDefinition > bands, BandDefinition band)
static Workspace getWorkspace (ArrayList< Workspace > list, String name)
static boolean addWorkspace (ArrayList< Workspace > list, Workspace workspace)
static boolean removeWorkspace (ArrayList< Workspace > list, String name)

Static Public Attributes

static final String WORKSPACE_DEFAULT_NAME = "default"
static final String WORKSPACE_SYSTEM_NAME = "sys"

Detailed Description

Author:
Stephane

Constructor & Destructor Documentation

icy.workspace.Workspace.Workspace ( )

empty workspace

icy.workspace.Workspace.Workspace ( File  file) throws IllegalArgumentException

workspace loaded from file

icy.workspace.Workspace.Workspace ( URL  url) throws IllegalArgumentException

workspace loaded from url

icy.workspace.Workspace.Workspace ( String  name) throws IllegalArgumentException

workspace loaded from his name


Member Function Documentation

TaskDefinition icy.workspace.Workspace.addTask ( RibbonTask  ribbonTask)

add TaskDefinition from RibbonTask component

Parameters:
ribbonTask
ArrayList<ItemDefinition> icy.workspace.Workspace.getAllItems ( )
Returns:
all items contained in this workspace
String icy.workspace.Workspace.getDescription ( )
Returns:
the description
String icy.workspace.Workspace.getName ( )
Returns:
the name
ArrayList<TaskDefinition> icy.workspace.Workspace.getTasks ( )
Returns:
the definitions
boolean icy.workspace.Workspace.install ( PluginRepositoryLoader  onlineLoader,
final ProgressFrame  progressFrame 
)

Install workspace

boolean icy.workspace.Workspace.isInstalling ( )
Returns:
the installing
boolean icy.workspace.Workspace.load ( URL  url)

load from file

boolean icy.workspace.Workspace.load ( )

load from local

boolean icy.workspace.Workspace.load ( File  file)

load from file

boolean icy.workspace.Workspace.loadFromXML ( Node  node)

LOAD

Implements icy.file.xml.XMLPersistent.

boolean icy.workspace.Workspace.save ( )

save

boolean icy.workspace.Workspace.saveToXML ( Node  node)

SAVE

Implements icy.file.xml.XMLPersistent.

void icy.workspace.Workspace.setDescription ( String  description)
Parameters:
descriptionthe description to set
void icy.workspace.Workspace.setName ( String  name)
Parameters:
namethe name to set

The documentation for this class was generated from the following file:
 All Classes Functions Variables