Package org.opensourcephysics.tools

Class LibraryCollection

java.lang.Object

org.opensourcephysics.tools.LibraryResource

org.opensourcephysics.tools.LibraryCollection

All Implemented Interfaces:

Comparable<LibraryResource>

public class LibraryCollection
extends LibraryResource

This represents a collection of library resources.

Version:

1.0

Author:

Douglas Brown

Nested Class Summary

Nested classes/interfaces inherited from class org.opensourcephysics.tools.LibraryResource

LibraryResource.Metadata

Field Summary

Fields inherited from class org.opensourcephysics.tools.LibraryResource

allResourceTypes, bodyFont, COLLECTION_TYPE, collectionIcon, collectionPath, DATA_TYPE, dataIcon, displayName, EJS_TYPE, ejsIcon, h1Font, h2Font, h3Font, HTML_TYPE, htmlIcon, IMAGE_TYPE, imageIcon, loaderMetadata, megabyteFormat, META_AUTHOR, META_CONTACT, META_KEYWORDS, META_TYPES, parent, PDF_TYPE, pdfIcon, RESOURCE_TYPES, target, TRACKER_TYPE, trackerIcon, treePath, UNKNOWN_TYPE, unknownIcon, URL_TYPE, urlIcon, VIDEO_TYPE, videoIcon

Constructor Summary

Constructors

Constructor	Description
LibraryCollection(String name)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addResource(LibraryResource resource)	Adds a resource to the end of this collection.
void	clearResources()	Clears resources.
static XML.ObjectLoader	getLoader()	Returns an ObjectLoader to save and load data for this class.
LibraryResource[]	getResources()	Gets the array of resources in this collection.
String	getType()	Gets the type of resource.
boolean	insertResource(LibraryResource resource, int index)	Inserts a resource into this collection at a specified index.
void	removeResource(LibraryResource resource)	Removes a resource from this collection.
boolean	setTarget(String path)	Sets the target of this collection.
boolean	setType(String type)	Overrides LibraryResource method.

Methods inherited from class org.opensourcephysics.tools.LibraryResource

addMetadata, compareTo, equals, getAbsoluteTarget, getBasePath, getBodyStyle, getClone, getCollectionPath, getDescription, getDisplayString, getH1Style, getH2Style, getH3Style, getHTMLBody, getHTMLCode, getHTMLPath, getHTMLStyles, getIcon, getInheritedBasePath, getMetadata, getMetadata, getName, getProperty, getPropertyNames, getPStyle, getStyleSheetCode, getTarget, getThumbnail, getTitle, getTreePath, insertLineBreaks, removeMetadata, setBasePath, setDescription, setHTMLPath, setMetadata, setName, setProperty, setThumbnail, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

LibraryCollection

public LibraryCollection(String name)

Constructor.

Parameters:

name - the name of the collection

Method Details

getType

public String getType()

Gets the type of resource.

Overrides:

getType in class LibraryResource

Returns:

collection type

setType

public boolean setType(String type)

Overrides LibraryResource method.

Overrides:

setType in class LibraryResource

Parameters:

type - ignored

Returns:

false, since never changes

setTarget

public boolean setTarget(String path)

Sets the target of this collection.

Overrides:

setTarget in class LibraryResource

Parameters:

path - the target path

Returns:

true if changed

addResource

public void addResource(LibraryResource resource)

Adds a resource to the end of this collection.

Parameters:

resource - the resource

insertResource

public boolean insertResource(LibraryResource resource,
 int index)

Inserts a resource into this collection at a specified index.

Parameters:

resource - the resource

index - the index

Returns:

true if inserted

removeResource

public void removeResource(LibraryResource resource)

Removes a resource from this collection.

Parameters:

resource - the resource to remove

getResources

public LibraryResource[] getResources()

Gets the array of resources in this collection.

Returns:

an array of resources

clearResources

public void clearResources()

Clears resources.

getLoader

public static XML.ObjectLoader getLoader()

Returns an ObjectLoader to save and load data for this class.

Returns:

the object loader