com.mindfusion.diagramming
Class TabbedScrollPane

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by com.mindfusion.diagramming.TabbedScrollPane
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.LayoutManager, java.awt.MenuContainer, java.io.Serializable

public class TabbedScrollPane
extends javax.swing.JComponent
implements java.awt.LayoutManager

Represents a DiagramView that can display DiagramDocument objects. The individual diagram pages can be activated through the tabs in the tray located at one of the view sides.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TabbedScrollPane()
          Initializes a new instance of the TabbedScrollPane class.
TabbedScrollPane(DocumentView view)
          Initializes a new instance of the TabbedScrollPane class with the specified DocumentView as a view.
 
Method Summary
 void addLayoutComponent(java.lang.String name, java.awt.Component comp)
          LayoutManager.addLayoutComponent implementation.
 void addTabbedScrollPaneListener(TabbedScrollPaneListener listener)
          Registers listener so that it will receive view events.
 DiagramPage getCurrentPage()
          Gets the currently active page.
 DiagramView getDiagramView()
          Gets a reference to the underlying diagram view.
 DiagramDocument getDocument()
          Gets the displayed diagram document.
 DocumentView getDocumentView()
          Gets the underlying document view.
 boolean getShowCreateNewTab()
          Gets a value indicating whether to display the 'Create New Tab' button.
 boolean getShowTabCloseButtons()
          Gets a value indicating whether to display a close button for each tab.
 boolean getShowTabNavigationButtons()
          Gets a value indicating whether the tab navigation buttons.
 boolean getShowTabs()
          Gets a value indicating whether the tabs are visible.
 int getTabAlignment()
          Gets the tabs alignment.
 void layoutContainer(java.awt.Container parent)
          LayoutManager.layoutContainer implementation.
 java.awt.Dimension minimumLayoutSize(java.awt.Container parent)
          LayoutManager.minimumLayoutSize implementation.
 java.awt.Dimension preferredLayoutSize(java.awt.Container parent)
          LayoutManager.preferredLayoutSize implementation.
 void removeLayoutComponent(java.awt.Component comp)
          LayoutManager.removeLayoutComponent implementation.
 void removeTabbedScrollPaneListener(TabbedScrollPaneListener listener)
          Unregisters listener so that it will no longer receive view events.
 void setCurrentPage(DiagramPage value)
          Sets the currently active page.
 void setDocument(DiagramDocument value)
          Sets the displayed diagram document.
 void setDocumentView(DocumentView value)
          Sets the underlying document view.
 void setShowCreateNewTab(boolean value)
          Sets a value indicating whether to display the 'Create New Tab' button.
 void setShowTabCloseButtons(boolean value)
          Sets a value indicating whether to display a close button for each tab.
 void setShowTabNavigationButtons(boolean value)
          Sets a value indicating whether the tab navigation buttons.
 void setShowTabs(boolean value)
          Sets a value indicating whether the tabs are visible.
 void setTabAlignment(int value)
          Sets the tabs alignment.
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, 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, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, getFocusCycleRootAncestor, 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, hide, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TabbedScrollPane

public TabbedScrollPane()
Initializes a new instance of the TabbedScrollPane class.


TabbedScrollPane

public TabbedScrollPane(DocumentView view)
Initializes a new instance of the TabbedScrollPane class with the specified DocumentView as a view.

Method Detail

addLayoutComponent

public void addLayoutComponent(java.lang.String name,
                               java.awt.Component comp)
LayoutManager.addLayoutComponent implementation.

Specified by:
addLayoutComponent in interface java.awt.LayoutManager

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component comp)
LayoutManager.removeLayoutComponent implementation.

Specified by:
removeLayoutComponent in interface java.awt.LayoutManager

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container parent)
LayoutManager.preferredLayoutSize implementation.

Specified by:
preferredLayoutSize in interface java.awt.LayoutManager

minimumLayoutSize

public java.awt.Dimension minimumLayoutSize(java.awt.Container parent)
LayoutManager.minimumLayoutSize implementation.

Specified by:
minimumLayoutSize in interface java.awt.LayoutManager

layoutContainer

public void layoutContainer(java.awt.Container parent)
LayoutManager.layoutContainer implementation.

Specified by:
layoutContainer in interface java.awt.LayoutManager

addTabbedScrollPaneListener

public void addTabbedScrollPaneListener(TabbedScrollPaneListener listener)
Registers listener so that it will receive view events.

Parameters:
listener - An object implementing the TabbedScrollPaneListener interface.

removeTabbedScrollPaneListener

public void removeTabbedScrollPaneListener(TabbedScrollPaneListener listener)
Unregisters listener so that it will no longer receive view events.

Parameters:
listener - An object implementing the TabbedScrollPaneListener interface.

getDocumentView

public DocumentView getDocumentView()
Gets the underlying document view.


setDocumentView

public void setDocumentView(DocumentView value)
Sets the underlying document view.


getDocument

public DiagramDocument getDocument()
Gets the displayed diagram document.


setDocument

public void setDocument(DiagramDocument value)
Sets the displayed diagram document.


getCurrentPage

public DiagramPage getCurrentPage()
Gets the currently active page.


setCurrentPage

public void setCurrentPage(DiagramPage value)
Sets the currently active page.


getShowTabs

public boolean getShowTabs()
Gets a value indicating whether the tabs are visible.


setShowTabs

public void setShowTabs(boolean value)
Sets a value indicating whether the tabs are visible.


getTabAlignment

public int getTabAlignment()
Gets the tabs alignment.

Returns:
One of the following constants of the JTabbedPane class:
  • SwingConstants.TOP
  • SwingConstants.BOTTOM
  • SwingConstants.LEFT
  • SwingConstants.RIGHT

setTabAlignment

public void setTabAlignment(int value)
Sets the tabs alignment.

Parameters:
value - One of the following constants of the JTabbedPane class:
  • SwingConstants.TOP
  • SwingConstants.BOTTOM
  • SwingConstants.LEFT
  • SwingConstants.RIGHT

getShowTabCloseButtons

public boolean getShowTabCloseButtons()
Gets a value indicating whether to display a close button for each tab.


setShowTabCloseButtons

public void setShowTabCloseButtons(boolean value)
Sets a value indicating whether to display a close button for each tab.


getShowTabNavigationButtons

public boolean getShowTabNavigationButtons()
Gets a value indicating whether the tab navigation buttons.


setShowTabNavigationButtons

public void setShowTabNavigationButtons(boolean value)
Sets a value indicating whether the tab navigation buttons.


getShowCreateNewTab

public boolean getShowCreateNewTab()
Gets a value indicating whether to display the 'Create New Tab' button.


getDiagramView

public DiagramView getDiagramView()
Gets a reference to the underlying diagram view.


setShowCreateNewTab

public void setShowCreateNewTab(boolean value)
Sets a value indicating whether to display the 'Create New Tab' button.