net.returnvoid.io

Class ColorPaletteLoader

java.lang.Object

net.returnvoid.io.DataLoader

net.returnvoid.io.ColorPaletteLoader

public class ColorPaletteLoader
extends DataLoader

ColorPaletteLoader will handle to load files from type ".color.json". Currently doesn't support the automatic loading of files within sub-folders. The files are loaded "on demand" as they are tried to be read with the getCurrent() or any other get method. The class will handle to run through all files of the given type via methods (e.g. next()) or on a KeyEvent (keyPressed with a pre-defined / defined key / keycode). The ".color.json" files should be constructed as follows:

 {
   "name" : "String",
   "tags" : ["String1","String2",...,"StringN"],
   "colors" : [
      {
        "hexString" : {
           "r" : "float",
           "g" : "float",
           "b" : "float"}
           "a" : "float",
           "importance" : "int"
        }
      }, ...]
 }
 

On default the keyPressed event with following keys are associated with following methods:
Arrow left : previous() - previous ColorPalette
Arrow right : next() - next ColorPalette
Arrow up : first() - first ColorPalette in directory
Arrow down: last() - last ColorPalette in directory
Tab : nextRandom() - random ColorPalette in directory

Use disableKeys() to disable these automatic set key events.

You can add ColorPaletteUpdateObservers. These observers will be informed when there is a change of the current color palette. (e.g. after every next() method call).

Author:

Diana Lange

Field Summary

Fields inherited from class net.returnvoid.io.DataLoader

COLOR_PALETTE, CSV, fileIndex, filePaths, IMAGE, JSON, parent, SHAPE, TEXT, type, XML

Constructor Summary

Constructors

Constructor and Description
ColorPaletteLoader(processing.core.PApplet parent) Builds the ColorPaletteLoader and registers the KeyEvent to the parent (PApplet).
ColorPaletteLoader(processing.core.PApplet parent, java.lang.String folderName) Builds the ColorPaletteLoader and registers the KeyEvent to the parent (PApplet).
ColorPaletteLoader(processing.core.PApplet parent, java.lang.String folderPath, java.lang.String folderName) Builds the ColorPaletteLoader and registers the KeyEvent to the parent (PApplet).

Method Summary

Modifier and Type	Method and Description
ColorPaletteLoader	addObserver(ColorPaletteUpdateObserver observer) Add an object that wants to be informed when there is a change of the current color palette.
ColorPaletteLoader	clearObservers() Remove all observers from this loader.
ColorPaletteLoader	disableKeys() Disable the automatic key events of this object.
ColorPaletteLoader	enableKeys() Enables the automatic key events of this object.
ColorPalette	first() Loads (if necessary) and returns the first file of the given folder.
ColorPalette	get(int index) Loads (if necessary) and returns the file with the given index.
ColorPalette	getCurrent() Loads (if necessary) and returns the current file.
ColorPalette	last() Loads (if necessary) and returns the last file of the given folder.
ColorPalette[]	loadAllFiles() Loads all files (if not loaded yet) and returns them all.
ColorPalette	loadFile(int index) Loads a file with the given index and returns it.
ColorPalette	next() Loads (if necessary) and returns the next file of the given folder.
ColorPalette	nextRandom() Loads (if necessary) and returns the next random file of the given folder.
ColorPalette	previous() Loads (if necessary) and returns the previous file of the given folder.
ColorPaletteLoader	removeObserver(ColorPaletteUpdateObserver observer) Remove an observer from this loader.
ColorPaletteLoader	resetKeySettings() Resets the key settings for the KeyEvents to its default.
ColorPaletteLoader	setIndex(int index) Sets the current element.
ColorPaletteLoader	setIndex(java.lang.String filename) Sets the current element.
ColorPaletteLoader	setKey(java.lang.String which, char key) Links a certain method call (e.g. next()) with a certain key (e.g.
DataLoader	setKey(java.lang.String which, int keyCode) Links a certain method call (e.g. next()) with a certain keyCode (e.g.
ColorPaletteLoader	update() Re-Loads all the absolute paths for all valid files defined by the given type in the set folder.

Methods inherited from class net.returnvoid.io.DataLoader

getFileName, getFileName, getFileName, getFileName, getFolder, getLoadingDirectory, getPath, keyEvent, loadPaths, loadPaths, size

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorPaletteLoader

public ColorPaletteLoader(processing.core.PApplet parent)

Builds the ColorPaletteLoader and registers the KeyEvent to the parent (PApplet). The files have to be located in a sub-folder named "data" in the current sketch folder. The "data" folder should at least contain one ".color.json" file.

Parameters:

parent - A PApplet object.

ColorPaletteLoader

public ColorPaletteLoader(processing.core.PApplet parent,
                          java.lang.String folderName)

Builds the ColorPaletteLoader and registers the KeyEvent to the parent (PApplet).

Parameters:

parent - A PApplet object.

folderName - Folder containing files (not null). This folder should at least contain one .color.json file. The given folder should be a sub-folder of the current sketch directory or a relative path to the sketch path. e.g. "..\\data" is a folder which is located in the parent directory of the sketch folder. Make sure to escape the backslashes in the path in the shown way.

ColorPaletteLoader

public ColorPaletteLoader(processing.core.PApplet parent,
                          java.lang.String folderPath,
                          java.lang.String folderName)

Builds the ColorPaletteLoader and registers the KeyEvent to the parent (PApplet).

Parameters:

parent - A PApplet object.

folderPath - A absolute path to the folder. Example: "C:\\" is the folderPath and "data " is the foldername then the files of the folder located at " C:\\data\\" will be loaded. Make sure to escape the backslashes in the path in the shown way.If folderPath is null, the sketch location will be used to set this path.

folderName - Folder containing files (not null). This folder should at least contain one .color.json file. The given folder should be a sub-folder of folderpath or a relative path to folderPath. e.g. "C:\\data" is the folderpath and "..\\temp" is the foldername then "C:\\temp\\" will be the location where the files will be loaded. Make sure to escape the backslashes in the path in the shown way.

Method Detail

update

public ColorPaletteLoader update()

Description copied from class: DataLoader

Re-Loads all the absolute paths for all valid files defined by the given type in the set folder. All already loaded (and buffered) files will have to be reloaded afterwards. Update might get called after a change in the directory has been made (e.g. a file has been removed). The current object will still be the same after update() if the file still exits in the directory.

Overrides:

update in class DataLoader

Returns:

The DataLoader object.

resetKeySettings

public ColorPaletteLoader resetKeySettings()

Description copied from class: DataLoader

Resets the key settings for the KeyEvents to its default. The default is:
Arrow left = previous
Arrow right = next
Arrow up = first
Arrow down = last
Tabulator = next random

Overrides:

resetKeySettings in class DataLoader

Returns:

The DataLoader object.

disableKeys

public ColorPaletteLoader disableKeys()

Description copied from class: DataLoader

Disable the automatic key events of this object.

Overrides:

disableKeys in class DataLoader

Returns:

The DataLoader object.

enableKeys

public ColorPaletteLoader enableKeys()

Description copied from class: DataLoader

Enables the automatic key events of this object.

Overrides:

enableKeys in class DataLoader

Returns:

The DataLoader object.

setKey

public DataLoader setKey(java.lang.String which,
                         int keyCode)

Description copied from class: DataLoader

Links a certain method call (e.g. next()) with a certain keyCode (e.g. KeyEvent.VK_RIGHT).

Overrides:

setKey in class DataLoader

Parameters:

which - A String representing the method which should be linked to the keyCode. Possible values: \ "previous\", \"next\", \"first\", \"last\", \"random\".

keyCode - The keyCode for the key which should be used for the given function.

Returns:

The DataLoader object.

setKey

public ColorPaletteLoader setKey(java.lang.String which,
                                 char key)

Description copied from class: DataLoader

Links a certain method call (e.g. next()) with a certain key (e.g. \'n\').

Overrides:

setKey in class DataLoader

Parameters:

which - A String representing the method which should be linked to the keyCode. Possible values: \ "previous\", \"next\", \"first\", \"last\", \"random\".

key - The char containing the key which should be used for the given function.

Returns:

The DataLoader object.

loadFile

public ColorPalette loadFile(int index)

Description copied from class: DataLoader

Loads a file with the given index and returns it. Prevent out of bounds exception by checking the range with the size() method. Even if the files has been loaded before this will induce a load again. This might be useful if the content of the file has been changed in the meen time.

Specified by:

loadFile in class DataLoader

Parameters:

index - The index of the file which should be loaded.

Returns:

The loaded file.

loadAllFiles

public ColorPalette[] loadAllFiles()

Description copied from class: DataLoader

Loads all files (if not loaded yet) and returns them all.

Specified by:

loadAllFiles in class DataLoader

Returns:

The object of the file.

nextRandom

public ColorPalette nextRandom()

Description copied from class: DataLoader

Loads (if necessary) and returns the next random file of the given folder.

Specified by:

nextRandom in class DataLoader

Returns:

The object of the file.

previous

public ColorPalette previous()

Description copied from class: DataLoader

Loads (if necessary) and returns the previous file of the given folder. The order of the files is set by their file names. Previous will load the file previous to the current file concerning their names.

Specified by:

previous in class DataLoader

Returns:

The object of the file.

next

public ColorPalette next()

Description copied from class: DataLoader

Loads (if necessary) and returns the next file of the given folder. The order of the files is set by their file names. Previous will load the file previous to the current file concerning their names.

Specified by:

next in class DataLoader

Returns:

The object of the file.

first

public ColorPalette first()

Description copied from class: DataLoader

Loads (if necessary) and returns the first file of the given folder. The order of the files is set by their file names.

Specified by:

first in class DataLoader

Returns:

The object of the file.

last

public ColorPalette last()

Description copied from class: DataLoader

Loads (if necessary) and returns the last file of the given folder. The order of the files is set by their file names.

Specified by:

last in class DataLoader

Returns:

The object of the file.

setIndex

public ColorPaletteLoader setIndex(int index)

Sets the current element.

Overrides:

setIndex in class DataLoader

Parameters:

index - The index of the element which should be the current element. Index is in range of [0, size()).

Returns:

The current ImageLoader object.

setIndex

public ColorPaletteLoader setIndex(java.lang.String filename)

Description copied from class: DataLoader

Sets the current element.

Overrides:

setIndex in class DataLoader

Parameters:

filename - The name of the file which should be the current element.

Returns:

The current DataLoader object.

getCurrent

public ColorPalette getCurrent()

Description copied from class: DataLoader

Loads (if necessary) and returns the current file.

Specified by:

getCurrent in class DataLoader

Returns:

The object of the file.

get

public ColorPalette get(int index)

Description copied from class: DataLoader

Loads (if necessary) and returns the file with the given index. Prevent out of bounds exception by checking the range with the size() method.

Specified by:

get in class DataLoader

Returns:

The object of the file.

addObserver

public ColorPaletteLoader addObserver(ColorPaletteUpdateObserver observer)

Add an object that wants to be informed when there is a change of the current color palette.

Parameters:

observer - An object that will be informed at a change of the current color palette.

Returns:

The ColorPaletteLoader object.

removeObserver

public ColorPaletteLoader removeObserver(ColorPaletteUpdateObserver observer)

Remove an observer from this loader.

Parameters:

observer - An object that was formerly an observer and which should be removed.

Returns:

The ColorPaletteLoader object.

clearObservers

public ColorPaletteLoader clearObservers()

Remove all observers from this loader.

Returns:

The ColorPaletteLoader object.