Package org.jjazz.ss_editor.api

Class SS_EditorTopComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.openide.windows.TopComponent

org.jjazz.ss_editor.api.SS_EditorTopComponent

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Externalizable, Serializable, EventListener, Accessible, org.openide.util.HelpCtx.Provider, org.openide.util.Lookup.Provider

public final class SS_EditorTopComponent
extends org.openide.windows.TopComponent
implements PropertyChangeListener

Top component for the SongStructure editor.

TopComponent header's popupmenu actions can be added at path "Actions/SS_EditorTopComponent".
Accept a paired TopComponent which must be always be shown/closed in the same time.
The TopComponent's lookup is the SS_Editor's lookup.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openide.windows.TopComponent

org.openide.windows.TopComponent.Cloneable, org.openide.windows.TopComponent.Description, org.openide.windows.TopComponent.NodeName, org.openide.windows.TopComponent.OpenActionRegistration, org.openide.windows.TopComponent.Registration, org.openide.windows.TopComponent.Registry, org.openide.windows.TopComponent.SubComponent

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODE

Fields inherited from class org.openide.windows.TopComponent

CLOSE_EACH, CLOSE_LAST, PERSISTENCE_ALWAYS, PERSISTENCE_NEVER, PERSISTENCE_ONLY_OPENED, PROP_CLOSING_DISABLED, PROP_DND_COPY_DISABLED, PROP_DRAGGING_DISABLED, PROP_KEEP_PREFERRED_SIZE_WHEN_SLIDED_IN, PROP_MAXIMIZATION_DISABLED, PROP_SLIDING_DISABLED, PROP_UNDOCKING_DISABLED

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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

Constructors

Constructor	Description
SS_EditorTopComponent(Song song)	Create an editor.

Method Summary

Modifier and Type	Method	Description
boolean	canClose()
void	closeSilent()	Close the TopComponent without asking for user confirmation.
void	componentClosed()
void	componentOpened()
static SS_EditorTopComponent	get(SongStructure sgs)	Return the editor for a specific SongStructure.
Action[]	getActions()	Overridden to insert possible new actions from path "Actions/SS_EditorTopComponent".
static SS_EditorTopComponent	getActive()	Return the active (i.e. focused or ancestor of the focused component) SS_EditorTopComponent.
SS_Editor	getEditor()
org.openide.util.Lookup	getLookup()
Song	getSongModel()
org.openide.awt.UndoRedo	getUndoRedo()
static SS_EditorTopComponent	getVisible()	Return the visible SS_EditorTopComponent within its window mode.
void	propertyChange(PropertyChangeEvent evt)
void	setPairedTopComponent(org.openide.windows.TopComponent tc)	Bind this TopComponent to another TopComponent.

Methods inherited from class org.openide.windows.TopComponent

addNotify, availableModes, cancelRequestAttention, canClose, close, close, getAccessibleContext, getActivatedNodes, getCloseOperation, getDisplayName, getHelpCtx, getHtmlDisplayName, getIcon, getPersistenceType, getRegistry, getShortName, getSubComponents, getSystemActions, getTabPosition, isOpened, isOpened, makeBusy, open, open, openAction, openAtTabPosition, readExternal, requestActive, requestAttention, requestFocus, requestFocusInWindow, requestVisible, setActivatedNodes, setAttentionHighlight, setCloseOperation, setDisplayName, setHtmlDisplayName, setIcon, setName, setToolTipText, toFront, writeExternal

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, 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, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

MODE

public static final String MODE

See Also:

• Constant Field Values

Constructor Details

SS_EditorTopComponent

public SS_EditorTopComponent(Song song)

Create an editor.

Parameters:

song -

Method Details

getActions

public Action[] getActions()

Overridden to insert possible new actions from path "Actions/SS_EditorTopComponent".

Overrides:

getActions in class org.openide.windows.TopComponent

Returns:

The actions to be shown in the TopComponent popup menu.

getLookup

public org.openide.util.Lookup getLookup()

Specified by:

getLookup in interface org.openide.util.Lookup.Provider

Overrides:

getLookup in class org.openide.windows.TopComponent

getSongModel

public Song getSongModel()

setPairedTopComponent

public void setPairedTopComponent(org.openide.windows.TopComponent tc)

Bind this TopComponent to another TopComponent.

Show/Close operations initiated on this TopComponent will be replicated on the paired TopComponent.

Parameters:

tc -

getEditor

public SS_Editor getEditor()

getUndoRedo

public org.openide.awt.UndoRedo getUndoRedo()

Overrides:

getUndoRedo in class org.openide.windows.TopComponent

getActive

public static SS_EditorTopComponent getActive()

Return the active (i.e. focused or ancestor of the focused component) SS_EditorTopComponent.

Returns:

Can be null

getVisible

public static SS_EditorTopComponent getVisible()

Return the visible SS_EditorTopComponent within its window mode.

The visible SS_EditorTopComponent might not be the active one (for example if it's the corresponding CL_EditorTopComponent which is active).

Returns:

Can be null if no SS_EditorTopComponent within its window mode.

get

public static SS_EditorTopComponent get(SongStructure sgs)

Return the editor for a specific SongStructure.

Parameters:

sgs -

Returns:

Null if not found in the open SS_EditorTopComponent windows.

componentOpened

public void componentOpened()

closeSilent

public void closeSilent()

Close the TopComponent without asking for user confirmation.

canClose

public boolean canClose()

Overrides:

canClose in class org.openide.windows.TopComponent

componentClosed

public void componentClosed()

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener