Field Detail

• coreLibraries

  public java.util.ArrayList<Library> coreLibraries

• contribLibraries

  public java.util.ArrayList<Library> contribLibraries

Constructor Detail

• Mode

  public Mode(Base base,
      java.io.File folder)

Method Detail

• getKeywordFiles

  public java.io.File[] getKeywordFiles()

  To add additional keywords, or to grab them from another mode, override this function. If your mode has no keywords, return a zero length array.

• setClassLoader

  public void setClassLoader(java.lang.ClassLoader loader)

• getClassLoader

  public java.lang.ClassLoader getClassLoader()

• setupGUI

  public void setupGUI()

  Setup additional elements that are only required when running with a GUI, rather than from the command-line. Note that this will not be called when the Mode is used from the command line (because Base will be null).

• getContentFile

  public java.io.File getContentFile(java.lang.String path)

• getContentStream

  public java.io.InputStream getContentStream(java.lang.String path)
                                       throws java.io.FileNotFoundException

  Throws:

  java.io.FileNotFoundException

• getTitle

  public abstract java.lang.String getTitle()

  Return the pretty/printable/menu name for this mode. This is separate from the single word name of the folder that contains this mode. It could even have spaces, though that might result in sheer madness or total mayhem.

• getIdentifier

  public java.lang.String getIdentifier()

  Get an identifier that can be used to resurrect this mode and connect it to a sketch. Using this instead of getTitle() because there might be name clashes with the titles, but there should not be once the actual package, et al. is included.

  Returns:

  full name (package + class name) for this mode.

• createEditor

  public abstract Editor createEditor(Base base,
                    java.lang.String path,
                    EditorState state)

  Create a new editor associated with this mode.

• getExamplesFolder

  public java.io.File getExamplesFolder()

• getLibrariesFolder

  public java.io.File getLibrariesFolder()

• getReferenceFolder

  public java.io.File getReferenceFolder()

• rebuildLibraryList

  public void rebuildLibraryList()

• getCoreLibrary

  public Library getCoreLibrary()

• getLibrary

  public Library getLibrary(java.lang.String pkgName)
                     throws SketchException

  Throws:

  SketchException

• getToolbarMenu

  public javax.swing.JMenu getToolbarMenu()

• insertToolbarRecentMenu

  public void insertToolbarRecentMenu()

• removeToolbarRecentMenu

  public void removeToolbarRecentMenu()

• getImportMenu

  public javax.swing.JMenu getImportMenu()

• rebuildImportMenu

  public void rebuildImportMenu()

• getExampleCategoryFolders

  public java.io.File[] getExampleCategoryFolders()

  Override this to control the order of the first set of example folders and how they appear in the examples window.

• buildExamplesTree

  public javax.swing.JTree buildExamplesTree()

• resetExamples

  public void resetExamples()

• showExamplesFrame

  public void showExamplesFrame()

• loadImage

  public java.awt.Image loadImage(java.lang.String filename)

  Get an image object from the theme folder.

• lookupReference

  public java.lang.String lookupReference(java.lang.String keyword)

  Returns the HTML filename (including path prefix if necessary) for this keyword, or null if it doesn't exist.

• getTokenMarker

  public TokenMarker getTokenMarker()

• getBoolean

  public boolean getBoolean(java.lang.String attribute)

• getInteger

  public int getInteger(java.lang.String attribute)

• getColor

  public java.awt.Color getColor(java.lang.String attribute)

• getFont

  public java.awt.Font getFont(java.lang.String attribute)

• getStyle

  public SyntaxStyle getStyle(java.lang.String attribute)

• hideExtension

  public boolean hideExtension(java.lang.String what)

  True if the specified extension should be hidden when shown on a tab. For Processing, this is true for .pde files. (Broken out for subclasses.) You can override this in your Mode subclass to handle it differently.

• isDefaultExtension

  public boolean isDefaultExtension(SketchCode code)

  True if the specified code has the default file extension.

• isDefaultExtension

  public boolean isDefaultExtension(java.lang.String what)

  True if the specified extension is the default file extension.

• validExtension

  public boolean validExtension(java.lang.String what)

  Check this extension (no dots, please) against the list of valid extensions.

• getDefaultExtension

  public abstract java.lang.String getDefaultExtension()

  Returns the default extension for this editor setup.

• getExtensions

  public abstract java.lang.String[] getExtensions()

  Returns a String[] array of proper extensions.

• getIgnorable

  public abstract java.lang.String[] getIgnorable()

  Get array of file/directory names that needn't be copied during "Save As".

• prepareExportFolder

  public void prepareExportFolder(java.io.File targetFolder)

  Create a fresh applet/application folder if the 'delete target folder' pref has been set in the preferences.