de.quippy.javamod.main.playlist

Class PlayList

java.lang.Object

de.quippy.javamod.main.playlist.PlayList

public class PlayList
extends Object

Since:

03.12.2006

Author:

Daniel Becker

Field Summary

Fields

Modifier and Type	Field and Description
static FileChooserFilter	PLAYLIST_FILE_FILTER
static FileChooserFilter	PLAYLIST_SAVE_FILE_FILTER
static String[]	SUPPORTEDPLAYLISTS
static String[]	SUPPORTEDSAVELISTS

Constructor Summary

Constructors

Constructor and Description
PlayList(ArrayList<PlayListEntry> entries, boolean shuffle, boolean repeat)
PlayList(boolean shuffle, boolean repeat) Constructor for PlayList
PlayList(File[] files, boolean shuffle, boolean repeat) Constructor for PlayList
PlayList(String[] fileNames, boolean shuffle, boolean repeat) Constructor for PlayList
PlayList(URL[] urls, boolean shuffle, boolean repeat) Constructor for PlayList

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllAt(int indexAt, PlayList newPlaylist)
void	addEntry(PlayListEntry newPlaylistEntry)
void	addPlaylistChangedListener(PlaylistChangedListener listener)
void	addSelectedElement(int index)
static PlayList	createFromFile(File f, boolean shuffle, boolean repeat) reads a Playlist from a file
static PlayList	createFromFile(String fileName, boolean shuffle, boolean repeat) reads a Playlist from a file
static PlayList	createFromFile(URL url, boolean shuffle, boolean repeat) reads a playlist from a file
static PlayList	createNewListWithFile(File file, boolean shuffle, boolean repeat) will create a playlists with the given file if the file represents a playlist, it will get expanded
static PlayList	createNewListWithFile(URL url, boolean shuffle, boolean repeat) will create a playlists with the given file if the file represents a playlist, it will get expanded
static PlayList	createNewListWithFiles(File[] file, boolean shuffle, boolean repeat) will create a playlists with the given files if a file represents a playlist, it will get expanded
static PlayList	createNewListWithFiles(URL[] url, boolean shuffle, boolean repeat) will create a playlists with the given files if a file represents a playlist, it will get expanded
void	doShuffle()
void	fireActiveElementChanged(PlayListEntry oldElement, PlayListEntry newEntry)
void	fireSelectedElementChanged(PlayListEntry oldElement, PlayListEntry newEntry)
PlayListEntry[]	getAllEntries()
PlayListEntry	getCurrentEntry() Retrieve the current playlist entry if no (more) entries are set this will return null
PlayListEntry	getEntry(int index)
static String	getFileChooserDescription()
static String	getFileChooserSaveDescription()
Iterator<PlayListEntry>	getIterator()
URL	getLoadedFromURL()
PlayListEntry[]	getSelectedEntries()
boolean	hasNext()
boolean	hasPrevious()
int	indexOf(PlayListEntry entry)
static boolean	isPlaylistFile(String fileName)
static boolean	isPlaylistFile(URL fileURL)
boolean	isRepeat()
void	move(int fromIndex, int toIndex)
boolean	next() set index to next element or return false, if end is reached.
boolean	previous() set index to prev element and wrap around
void	remove(int fromIndex)
void	removePlaylistChangedListener(PlaylistChangedListener listener)
void	savePlayListTo(File f) Saves the current playlist to a File
void	savePlayListTo(String fileName) Saves the current playlist to a File
PlayListEntry	setCurrentElement(int index)
void	setCurrentElementByTimeIndex(long timeIndex) set the current Element by timeIndex This Method refers to the starttimeIndex and Duration of each entry The index is searched in the current entrie's file
void	setRepeat(boolean repeat)
void	setSelectedElement(int index)
void	setSelectedElements(int fromIndex, int toIndex)
int	size()
void	toggleSelectedElement(int index)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTEDPLAYLISTS

public static String[] SUPPORTEDPLAYLISTS

PLAYLIST_FILE_FILTER

public static FileChooserFilter PLAYLIST_FILE_FILTER

SUPPORTEDSAVELISTS

public static String[] SUPPORTEDSAVELISTS

PLAYLIST_SAVE_FILE_FILTER

public static FileChooserFilter PLAYLIST_SAVE_FILE_FILTER

Constructor Detail

PlayList

public PlayList(boolean shuffle,
        boolean repeat)

Constructor for PlayList

PlayList

public PlayList(ArrayList<PlayListEntry> entries,
        boolean shuffle,
        boolean repeat)

Parameters:

entries -

shuffle -

Since:

23.03.2011

PlayList

public PlayList(File[] files,
        boolean shuffle,
        boolean repeat)

Constructor for PlayList

PlayList

public PlayList(String[] fileNames,
        boolean shuffle,
        boolean repeat)

Constructor for PlayList

PlayList

public PlayList(URL[] urls,
        boolean shuffle,
        boolean repeat)

Constructor for PlayList

Method Detail

addPlaylistChangedListener

public void addPlaylistChangedListener(PlaylistChangedListener listener)

removePlaylistChangedListener

public void removePlaylistChangedListener(PlaylistChangedListener listener)

fireActiveElementChanged

public void fireActiveElementChanged(PlayListEntry oldElement,
                            PlayListEntry newEntry)

fireSelectedElementChanged

public void fireSelectedElementChanged(PlayListEntry oldElement,
                              PlayListEntry newEntry)

isRepeat

public boolean isRepeat()

Returns:

the repeat

Since:

22.11.2011

setRepeat

public void setRepeat(boolean repeat)

Parameters:

repeat - the repeat to set

Since:

22.11.2011

doShuffle

public void doShuffle()

Since:

08.11.2008

getAllEntries

public PlayListEntry[] getAllEntries()

getCurrentEntry

public PlayListEntry getCurrentEntry()

Retrieve the current playlist entry if no (more) entries are set this will return null

Returns:

Since:

03.12.2006

getEntry

public PlayListEntry getEntry(int index)

Parameters:

index -

Returns:

Since:

23.03.2011

setCurrentElement

public PlayListEntry setCurrentElement(int index)

Parameters:

index -

Returns:

Since:

12.02.2011

setCurrentElementByTimeIndex

public void setCurrentElementByTimeIndex(long timeIndex)

set the current Element by timeIndex This Method refers to the starttimeIndex and Duration of each entry The index is searched in the current entrie's file

Parameters:

timeIndex -

Since:

15.02.2012

getSelectedEntries

public PlayListEntry[] getSelectedEntries()

Returns:

Since:

03.04.2011

addSelectedElement

public void addSelectedElement(int index)

Parameters:

index -

Since:

03.04.2011

toggleSelectedElement

public void toggleSelectedElement(int index)

Parameters:

index -

Since:

03.04.2011

setSelectedElement

public void setSelectedElement(int index)

Parameters:

index - (-1 means deselect any!)

Since:

12.02.2011

setSelectedElements

public void setSelectedElements(int fromIndex,
                       int toIndex)

Parameters:

fromIndex -

toIndex -

Since:

03.04.2011

next

public boolean next()

set index to next element or return false, if end is reached. The first call of "next" steps to the first element

Since:

03.12.2006

previous

public boolean previous()

set index to prev element and wrap around

Since:

03.12.2006

hasNext

public boolean hasNext()

Returns:

Since:

14.09.2008

hasPrevious

public boolean hasPrevious()

Returns:

Since:

14.09.2008

size

public int size()

Returns:

Since:

08.03.2011

indexOf

public int indexOf(PlayListEntry entry)

addAllAt

public void addAllAt(int indexAt,
            PlayList newPlaylist)

addEntry

public void addEntry(PlayListEntry newPlaylistEntry)

move

public void move(int fromIndex,
        int toIndex)

remove

public void remove(int fromIndex)

getLoadedFromURL

public URL getLoadedFromURL()

Returns:

the loadedFromURL

savePlayListTo

public void savePlayListTo(File f)
                    throws IOException

Saves the current playlist to a File

Parameters:

f -

Throws:

IOException

Since:

03.12.2006

savePlayListTo

public void savePlayListTo(String fileName)
                    throws IOException

Saves the current playlist to a File

Parameters:

fileName -

Throws:

IOException

Since:

03.12.2006

createNewListWithFiles

public static PlayList createNewListWithFiles(URL[] url,
                              boolean shuffle,
                              boolean repeat)

will create a playlists with the given files if a file represents a playlist, it will get expanded

Parameters:

url -

shuffle -

Returns:

Since:

28.04.2011

createNewListWithFile

public static PlayList createNewListWithFile(URL url,
                             boolean shuffle,
                             boolean repeat)

will create a playlists with the given file if the file represents a playlist, it will get expanded

Parameters:

url -

shuffle -

Returns:

Since:

28.04.2011

createNewListWithFiles

public static PlayList createNewListWithFiles(File[] file,
                              boolean shuffle,
                              boolean repeat)

will create a playlists with the given files if a file represents a playlist, it will get expanded

Parameters:

file -

shuffle -

Returns:

Since:

28.04.2011

createNewListWithFile

public static PlayList createNewListWithFile(File file,
                             boolean shuffle,
                             boolean repeat)

will create a playlists with the given file if the file represents a playlist, it will get expanded

Parameters:

file -

shuffle -

Returns:

Since:

28.04.2011

createFromFile

public static PlayList createFromFile(URL url,
                      boolean shuffle,
                      boolean repeat)
                               throws IOException

reads a playlist from a file

Parameters:

url -

Returns:

Throws:

IOException

Since:

03.12.2006

createFromFile

public static PlayList createFromFile(File f,
                      boolean shuffle,
                      boolean repeat)
                               throws IOException

reads a Playlist from a file

Parameters:

f -

shuffle -

Returns:

Throws:

IOException

Since:

03.12.2006

createFromFile

public static PlayList createFromFile(String fileName,
                      boolean shuffle,
                      boolean repeat)
                               throws IOException

reads a Playlist from a file

Parameters:

fileName -

Returns:

Throws:

IOException

Since:

03.12.2006

isPlaylistFile

public static boolean isPlaylistFile(URL fileURL)

Parameters:

fileURL -

Returns:

Since:

02.01.2011

isPlaylistFile

public static boolean isPlaylistFile(String fileName)

Parameters:

fileName -

Returns:

Since:

02.01.2011

getFileChooserDescription

public static String getFileChooserDescription()

Returns:

Since:

02.01.2011

getFileChooserSaveDescription

public static String getFileChooserSaveDescription()

Returns:

Since:

03.04.2011

getIterator

public Iterator<PlayListEntry> getIterator()

Returns:

Since:

02.01.2011

toString

public String toString()

Overrides:

toString in class Object

Returns:

See Also:

Object.toString()