projectviewer.config
Class ProjectOptions

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended byorg.gjt.sp.jedit.gui.EnhancedDialog
                          extended byorg.gjt.sp.jedit.gui.OptionsDialog
                              extended byprojectviewer.config.ProjectOptions
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.event.TreeSelectionListener, javax.swing.WindowConstants

public class ProjectOptions
extends org.gjt.sp.jedit.gui.OptionsDialog

A dialog for configuring the properties of a project. It works like jEdit's OptionsDialog (from which this class extends) to provide ways for other plugins to add option panes to it.

Version:
$Id: ProjectOptions.java 6705 2006-08-20 00:04:22Z vanza $
Author:
Marcelo Vanzin
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class org.gjt.sp.jedit.gui.OptionsDialog
org.gjt.sp.jedit.gui.OptionsDialog.OptionTreeModel, org.gjt.sp.jedit.gui.OptionsDialog.PaneNameRenderer
 
Nested classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class org.gjt.sp.jedit.gui.EnhancedDialog
enterEnabled, keyHandler
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Method Summary
 void cancel()
          Called when the cancel button is pressed.
protected  boolean createOptions(org.gjt.sp.jedit.EditPlugin plugin)
          For jEdit 4.2: creates options panes based on properties set by the plugin, so manual registration of the plugin is not necessary.
protected  org.gjt.sp.jedit.gui.OptionsDialog.OptionTreeModel createOptionTreeModel()
           
protected  org.gjt.sp.jedit.OptionGroup getDefaultGroup()
           
static VPTProject getProject()
          Returns the project currently being edited, or null if the dialog is not active.
 void ok()
          Called when ok is pressed.
static VPTProject run(VPTProject project)
          Shows the project options dialog for the given project.
static VPTProject run(VPTProject project, VPTGroup parent, java.lang.String startPath)
          Shows the project options dialog for the given project, with an optional default start folder where to open the file chooser dialog.
static VPTProject run(VPTProject project, VPTGroup parent, java.lang.String startPath, java.lang.String startPane)
          Shows the project options dialog for the given project, with an optional default start folder where to open the file chooser dialog.
 void setTitle(java.lang.String title)
           
 
Methods inherited from class org.gjt.sp.jedit.gui.OptionsDialog
actionPerformed, addOptionGroup, addOptionPane, dispose, ok, valueChanged
 
Methods inherited from class org.gjt.sp.jedit.gui.EnhancedDialog
getEnterEnabled, setEnterEnabled
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

run

public static VPTProject run(VPTProject project)
Shows the project options dialog for the given project.

Parameters:
project - The project to edit or null to create a new one.
Returns:
The new or modified project, or null if p was null and dialog was cancelled.

run

public static VPTProject run(VPTProject project,
                             VPTGroup parent,
                             java.lang.String startPath)
Shows the project options dialog for the given project, with an optional default start folder where to open the file chooser dialog.

Method is sychronized so that the use of the static variables is safe.

Parameters:
project - The project to edit or null to create a new one.
parent - If creating a new project, the parent where the project should be added (null is ok).
startPath - Where to open the "choose root" file dialog.
Returns:
The new or modified project, or null if p was null and dialog was cancelled.

run

public static VPTProject run(VPTProject project,
                             VPTGroup parent,
                             java.lang.String startPath,
                             java.lang.String startPane)
Shows the project options dialog for the given project, with an optional default start folder where to open the file chooser dialog.

Method is sychronized so that the use of the static variables is safe.

Parameters:
project - The project to edit or null to create a new one.
parent - If creating a new project, the parent where the project should be added (null is ok).
startPath - Where to open the "choose root" file dialog.
startPane - The name of the option pane to be shown by default. If null, will show the main project options pane.
Returns:
The new or modified project, or null if p was null and dialog was cancelled.
Since:
PV 2.1.3.4

getProject

public static VPTProject getProject()
Returns the project currently being edited, or null if the dialog is not active.

Since:
PV 2.1.0.1

setTitle

public void setTitle(java.lang.String title)

cancel

public void cancel()
Called when the cancel button is pressed. Sets the project to null if "isNew" is true.


ok

public void ok()
Called when ok is pressed. Verifies if the project's properties are OK before closing the dialog.


getDefaultGroup

protected org.gjt.sp.jedit.OptionGroup getDefaultGroup()

createOptionTreeModel

protected org.gjt.sp.jedit.gui.OptionsDialog.OptionTreeModel createOptionTreeModel()

createOptions

protected boolean createOptions(org.gjt.sp.jedit.EditPlugin plugin)
For jEdit 4.2: creates options panes based on properties set by the plugin, so manual registration of the plugin is not necessary. More details in the package description documentation.

Returns:
true if an option pane or an option group was added, false otherwise.