Package com.intellij.application.options.schemes

Class AbstractSchemesPanel<T extends Scheme,InfoComponent extends javax.swing.JComponent>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.intellij.application.options.schemes.AbstractSchemesPanel<T,InfoComponent>

Type Parameters:

T - The actual scheme type.

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

AbstractDescriptionAwareSchemesPanel, SimpleSchemesPanel

public abstract class AbstractSchemesPanel<T extends Scheme,InfoComponent extends javax.swing.JComponent>
extends javax.swing.JPanel

Base panel for schemes combo box and related actions. When settings change, updateOnCurrentSettingsChange() method must be called to reflect the change in schemes panel. The method should be added to settings model listener.

See Also:

AbstractSchemeActions, SchemesModel, Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

Modifier and Type	Field and Description
protected static int	DEFAULT_VGAP

Fields inherited from class javax.swing.JComponent

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

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

Method Summary

Modifier and Type	Method and Description
void	cancelEdit()
protected abstract void	clearMessage()
protected javax.swing.JComponent	createBottomComponent()
protected abstract InfoComponent	createInfoComponent()
protected abstract AbstractSchemeActions<T>	createSchemeActions() Creates schemes actions.
protected javax.swing.JComponent	createTopComponent()
void	disposeUIResources()
void	editNewSchemeName(java.lang.String preferredName, boolean isProjectScheme, java.util.function.Consumer<? super java.lang.String> nameConsumer)
AbstractSchemeActions<T>	getActions()
protected java.lang.String	getComboBoxLabel()
protected int	getIndent(T scheme) Returns an indent to calculate a left margin for the scheme name in the combo box.
abstract SchemesModel<T>	getModel()
protected java.lang.String	getSchemeTypeName()
T	getSelectedScheme()
javax.swing.JComponent	getToolbar()
protected boolean	hideDeleteActionIfUnavailable()
protected abstract boolean	highlightNonDefaultSchemes()
void	resetSchemes(java.util.Collection<? extends T> schemes)
void	selectScheme(T scheme)
void	setSeparatorVisible(boolean visible)
void	showInfo(java.lang.String message, MessageType messageType)
protected abstract void	showMessage(java.lang.String message, MessageType messageType)
protected static void	showMessage(java.lang.String message, MessageType messageType, javax.swing.JLabel infoComponent)
void	showStatus(java.lang.String message, MessageType messageType)
protected abstract boolean	supportsProjectSchemes()
void	updateOnCurrentSettingsChange() Must be called when any settings are changed.
abstract boolean	useBoldForNonRemovableSchemes()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, 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

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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VGAP

protected static final int DEFAULT_VGAP

See Also:

Constant Field Values

Method Detail

setSeparatorVisible

public void setSeparatorVisible(boolean visible)

createTopComponent

protected javax.swing.JComponent createTopComponent()

createBottomComponent

protected javax.swing.JComponent createBottomComponent()

getToolbar

public final javax.swing.JComponent getToolbar()

createSchemeActions

protected abstract AbstractSchemeActions<T> createSchemeActions()

Creates schemes actions. Used when panel UI components are created.

Returns:

Scheme actions associated with the panel.

See Also:

AbstractSchemeActions

getSelectedScheme

public final T getSelectedScheme()

selectScheme

public void selectScheme(T scheme)

resetSchemes

public final void resetSchemes(java.util.Collection<? extends T> schemes)

disposeUIResources

public void disposeUIResources()

editNewSchemeName

public final void editNewSchemeName(java.lang.String preferredName,
                                    boolean isProjectScheme,
                                    java.util.function.Consumer<? super java.lang.String> nameConsumer)

cancelEdit

public final void cancelEdit()

showInfo

public final void showInfo(java.lang.String message,
                           MessageType messageType)

showMessage

protected abstract void showMessage(java.lang.String message,
                                    MessageType messageType)

clearMessage

protected abstract void clearMessage()

getActions

public final AbstractSchemeActions<T> getActions()

createInfoComponent

protected abstract InfoComponent createInfoComponent()

getComboBoxLabel

protected java.lang.String getComboBoxLabel()

Returns:

a string label to place before the combobox or null if it is not needed

getSchemeTypeName

protected java.lang.String getSchemeTypeName()

getModel

public abstract SchemesModel<T> getModel()

Returns:

Schemes model implementation.

See Also:

SchemesModel

updateOnCurrentSettingsChange

public final void updateOnCurrentSettingsChange()

Must be called when any settings are changed.

getIndent

protected int getIndent(T scheme)

Returns an indent to calculate a left margin for the scheme name in the combo box. By default, all names are aligned to the left.

Parameters:

scheme - the scheme to calculate its indent

Returns:

an indent that shows a nesting level for the specified scheme

supportsProjectSchemes

protected abstract boolean supportsProjectSchemes()

Returns:

True if the panel supports project-level schemes along with IDE ones. In this case there will be additional "Copy to Project" and "Copy to IDE" actions for IDE and project schemes respectively and Project/IDE schemes separators.

highlightNonDefaultSchemes

protected abstract boolean highlightNonDefaultSchemes()

hideDeleteActionIfUnavailable

protected boolean hideDeleteActionIfUnavailable()

useBoldForNonRemovableSchemes

public abstract boolean useBoldForNonRemovableSchemes()

showStatus

public void showStatus(java.lang.String message,
                       MessageType messageType)

showMessage

protected static void showMessage(java.lang.String message,
                                  MessageType messageType,
                                  javax.swing.JLabel infoComponent)