unbbayes.util.extension
Class UnBBayesModule

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JInternalFrame
                  unbbayes.util.extension.UnBBayesModule

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, IPersistenceAwareWindow

Direct Known Subclasses:

NetworkWindow

public abstract class UnBBayesModule
extends JInternalFrame
implements IPersistenceAwareWindow

Plugins for UnBBayes core is expected to extend this class.

Version:

16-10-2009

Author:

Shou Matsumoto

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JInternalFrame

JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

Constructor Summary

UnBBayesModule()
It is equal to super("Plugin", true, true, true, true);

UnBBayesModule(String title)

Method Summary

JInternalFrame	getInternalFrame() Obtains the internal frame to be created by UnBBayes Swing core when a file listed within #getSupportedFileExtensions() is opened by the user.
String	getModuleID()
abstract String	getModuleName() Obtains the name of this module.
String	getSavingMessage() Obtains a message to be shown to user while saving a net editted by a window implementing this interface.
String[]	getSupportedFileExtensions(boolean isLoadOnly) Deprecated. use BaseIO.getSupportedFileExtensions(boolean) from IPersistenceAwareWindow.getIO() instead.
String	getSupportedFilesDescription(boolean isLoadOnly) Deprecated. use BaseIO##getSupportedFilesDescription(boolean) from IPersistenceAwareWindow.getIO() instead.
UnBBayesFrame	getUnbbayesFrame() This is the top frame of UnBBayes, where all inner frames resides.
abstract UnBBayesModule	openFile(File file) Loads a file into this window.
void	setModuleID(String moduleID)
void	setName(String name)
void	setUnbbayesFrame(UnBBayesFrame unbbayesFrame) This is the top frame of UnBBayes, where all inner frames resides.

Methods inherited from class javax.swing.JInternalFrame

addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface unbbayes.gui.IPersistenceAwareWindow

getIO, getPersistingGraph

Constructor Detail

UnBBayesModule

public UnBBayesModule()

It is equal to super("Plugin", true, true, true, true);

See Also:

JInternalFrame

UnBBayesModule

public UnBBayesModule(String title)

Parameters:

title -

See Also:

JInternalFrame

Method Detail

getInternalFrame

public JInternalFrame getInternalFrame()

Description copied from interface: IPersistenceAwareWindow

Obtains the internal frame to be created by UnBBayes Swing core when a file listed within #getSupportedFileExtensions() is opened by the user.

Specified by:

getInternalFrame in interface IPersistenceAwareWindow

Returns:

a instance of JInternalFrame

getSavingMessage

public String getSavingMessage()

Description copied from interface: IPersistenceAwareWindow

Obtains a message to be shown to user while saving a net editted by a window implementing this interface. For example, you may want a FileChooser to show personalized title depending on what you are saving.

Specified by:

getSavingMessage in interface IPersistenceAwareWindow

Returns:

getSupportedFileExtensions

public String[] getSupportedFileExtensions(boolean isLoadOnly)

Deprecated. use BaseIO.getSupportedFileExtensions(boolean) from IPersistenceAwareWindow.getIO() instead.

Description copied from interface: IPersistenceAwareWindow

Obtains an array of file extensions supported by this network window. The file extensions should come without the dot

Specified by:

getSupportedFileExtensions in interface IPersistenceAwareWindow

Parameters:

isLoadOnly - : if set to true, it should consider file extensions for file loading (input). If set to false, it should consider both saving and loading. Note that not every module/plugin can implement both loading and saving, and this parameter may separate such special behaviors.

Returns:

See Also:

IPersistenceAwareWindow.getSupportedFileExtensions(boolean)

getSupportedFilesDescription

public String getSupportedFilesDescription(boolean isLoadOnly)

Deprecated. use BaseIO##getSupportedFilesDescription(boolean) from IPersistenceAwareWindow.getIO() instead.

(non-Javadoc)

Specified by:

getSupportedFilesDescription in interface IPersistenceAwareWindow

Parameters:

isLoadOnly - : if set to true, it should consider file extensions for file loading (input). If set to false, it should consider both saving and loading. Note that not every module/plugin can implement both loading and saving, and this parameter may separate such special behaviors.

See Also:

IPersistenceAwareWindow.getSupportedFilesDescription(boolean)

getModuleName

public abstract String getModuleName()

Obtains the name of this module.

Returns:

the name of this module.

openFile

public abstract UnBBayesModule openFile(File file)
                                 throws IOException

Loads a file into this window. Please, note that the file must be compatible to this module. File compatibility is checked by 2 possible ways: by IPersistenceAwareWindow#getSupportedFileExtensions() and/or by getting the I/O class (IPersistenceAwareWindow#getIO()) and checking directly using BaseIO#supportsExtension(String).

Parameters:

file - : the file to be opened

Returns:

the UnBBayesModule which has the new opened graph. If null, no internal frame will be displayed to user.

Throws:

IOException

See Also:

IPersistenceAwareWindow#getSupportedFileExtensions(), IPersistenceAwareWindow.getIO(), BaseIO#supportsExtension(String)

getModuleID

public String getModuleID()

Returns:

the moduleID

setModuleID

public void setModuleID(String moduleID)

Parameters:

moduleID - the moduleID to set

getUnbbayesFrame

public UnBBayesFrame getUnbbayesFrame()

This is the top frame of UnBBayes, where all inner frames resides. By accessing this, you can virtually control everything of UnBBayes' GUI.

Returns:

the unbbayesFrame

setUnbbayesFrame

public void setUnbbayesFrame(UnBBayesFrame unbbayesFrame)

This is the top frame of UnBBayes, where all inner frames resides. By accessing this, you can virtually control everything of UnBBayes' GUI.

Parameters:

unbbayesFrame - the unbbayesFrame to set

setName

public void setName(String name)

Overrides:

setName in class Component