processing.app.platform

Class DefaultPlatform

Object

DefaultPlatform

Direct Known Subclasses:

LinuxPlatform, MacPlatform, WindowsPlatform

public class DefaultPlatform
extends Object

Used by Base for platform-specific tweaking, for instance finding the sketchbook location using the Windows registry, or OS X event handling. The methods in this implementation are used by default, and can be overridden by a subclass. These methods throw vanilla-flavored Exceptions, so that error handling occurs inside Platform (which will show warnings in some cases). There is currently no mechanism for adding new platforms, as the setup is not automated. We could use getProperty("os.arch") perhaps, but that's debatable (could be upper/lowercase, have spaces, etc.. basically we don't know if name is proper Java package syntax.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultPlatform.CLibrary

Constructor Summary

Constructors

Constructor and Description
DefaultPlatform()

Method Summary

Modifier and Type	Method and Description
File	getDefaultSketchbookFolder()
String	getenv(String variable)
File	getSettingsFolder() This function should throw an exception or return a value.
int	getSystemDPI()
void	initBase(Base base)
void	openFolder(File file)
boolean	openFolderAvailable()
void	openURL(String url)
void	saveLanguage(String languageCode) Handle any platform-specific languages saving.
void	setenv(String variable, String value)
void	setLookAndFeel() Set the default L & F.
int	unsetenv(String variable)

Methods inherited from class Object

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

Constructor Detail

DefaultPlatform

public DefaultPlatform()

Method Detail

initBase

public void initBase(Base base)

setLookAndFeel

public void setLookAndFeel()
                    throws Exception

Set the default L & F. While I enjoy the bounty of the sixteen possible exception types that this UIManager method might throw, I feel that in just this one particular case, I'm being spoiled by those engineers at Sun, those Masters of the Abstractionverse. So instead, I'll pretend that I'm not offered eleven dozen ways to report to the user exactly what went wrong, and I'll bundle them all into a single catch-all "Exception". Because in the end, all I really care about is whether things worked or not. And even then, I don't care.

Throws:

Exception - Just like I said.

saveLanguage

public void saveLanguage(String languageCode)

Handle any platform-specific languages saving. This is necessary on OS X because of how bundles are handled, but perhaps your platform would like to Think Different too?

Parameters:

languageCode - 2-digit lowercase ISO language code

getSettingsFolder

public File getSettingsFolder()
                       throws Exception

This function should throw an exception or return a value. Do not return null.

Throws:

Exception

getDefaultSketchbookFolder

public File getDefaultSketchbookFolder()
                                throws Exception

Returns:

if not overridden, a folder named "sketchbook" in user.home.

Throws:

Exception - so that subclasses can throw a fit

openURL

public void openURL(String url)
             throws Exception

Throws:

Exception

openFolderAvailable

public boolean openFolderAvailable()

openFolder

public void openFolder(File file)
                throws Exception

Throws:

Exception

setenv

public void setenv(String variable,
                   String value)

getenv

public String getenv(String variable)

unsetenv

public int unsetenv(String variable)

getSystemDPI

public int getSystemDPI()