com.xmlmind.xmleditapp.desktop.toolbar

Class TextStyleToggle

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.xmlmind.xmleditapp.desktop.toolbar.TextStyleToggle

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public final class TextStyleToggle
extends JComponent

Another, more advanced, custom component which invokes the toggleTextStyle command.

See Also:

TextStyleMenu, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ComboToggle.RowLayout
protected static class	ComboToggle.ToggleButton

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

Modifier and Type	Field and Description
int	current
protected JButton	menuButton
protected ToolPosition	position
protected JToggleButton	toggleButton

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

Constructor Summary

Constructors

Constructor and Description
TextStyleToggle()

Method Summary

Modifier and Type	Method and Description
void	activeEditorChanged() Invoked after the active editor has changed or when there is no active editor at all (generally because all documents have been closed).
void	applyPreferences() If this part supports user preferences, this part should update its state after reading its settings from the object returned by AppBase.getPreferences().
TextStyleToggle	copyTool() Returns a copy of this custom component.
void	destroyApp() Invoked when the component is detached from the App.
void	editingContextChanged() Invoked when the editing context (text node containing caret, node selection, etc) changes in active editor.
void	flushPreferences() If this part supports user preferences, this part should store its current settings in the object returned by AppBase.getPreferences().
App	getApp() Returns the App containing this part.
String	getCustomizationId()
String	getHelpId() Returns the online help ID of this component.
String	getId() Returns the ID this part within the App.
JButton	getMenuButton()
ToolPosition	getPosition()
JToggleButton	getToggleButton()
boolean	getToggleShowsActiveTextStyle()
boolean	getToggleShowsLabel()
void	initApp(App app, String id) Specifies the App containing this part and the unique ID of this part within the App.
void	initMenuButton(boolean hasMenuButton, ToolPosition position)
void	initTool(ToolBarInfo.ButtonSpec spec, Configuration config, ToolPosition pos, CommandEnv commandEnv) Initialize this custom component.
boolean	isEditingContextSensitive() This method must return true if this part is intrinsically context sensitive and it must return false if this part is intrinsically not context sensitive.
void	menuCustomized()
void	namespacePrefixesChanged() Invoked after the namespace/prefix map has been modified for the active document.
void	saveStateChanged() Invoked after active document has been saved or, on the contrary, when its has been modified and thus needs to be saved.
void	setCustomizationId(String propName)
void	setFocusable(boolean focusable)
void	setHelpId(String helpId) Specifies the online help ID of this component.
void	setPosition(ToolPosition position)
void	setToggleShowsActiveTextStyle(boolean showActiveTextStyle)
void	setToggleShowsLabel(boolean showLabel)
void	toggleActionFailed(ActionEvent e)
void	undoStateChanged() Invoked after it becomes possible to undo or redo a command in active document or, on the contrary, when it becomes impossible to undo or redo a command.
void	validityStateChanged() Invoked after active document has been checked for validity.

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, getAccessibleContext, 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, 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, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

current

public int current

position

protected ToolPosition position

toggleButton

protected JToggleButton toggleButton

menuButton

protected JButton menuButton

Constructor Detail

TextStyleToggle

public TextStyleToggle()

Method Detail

copyTool

public TextStyleToggle copyTool()

Description copied from interface: ToolBarTool

Returns a copy of this custom component.

setToggleShowsActiveTextStyle

public void setToggleShowsActiveTextStyle(boolean showActiveTextStyle)

getToggleShowsActiveTextStyle

public boolean getToggleShowsActiveTextStyle()

setToggleShowsLabel

public void setToggleShowsLabel(boolean showLabel)

getToggleShowsLabel

public boolean getToggleShowsLabel()

setCustomizationId

public void setCustomizationId(String propName)

getCustomizationId

public String getCustomizationId()

initTool

public void initTool(ToolBarInfo.ButtonSpec spec,
                     Configuration config,
                     ToolPosition pos,
                     CommandEnv commandEnv)

Description copied from interface: ToolBarTool

Initialize this custom component.

Parameters:

spec - a specification of the contents of the custom component.

The custom component is free to interpret this specification as it wishes.

config - the configuration from which spec comes

pos - position of the custom component relatively to sibling custom components of the same class.

commandEnv - may be useful to initialize this custom component.

This allows to nicely group similar custom components.

toggleActionFailed

public void toggleActionFailed(ActionEvent e)

menuCustomized

public void menuCustomized()

setHelpId

public void setHelpId(String helpId)

Description copied from interface: AppTool

Specifies the online help ID of this component.

This ID is almost always obtained from the declaration of this AppTool found in the .xxe_gui GUI specification file of the App.

getHelpId

public String getHelpId()

Description copied from interface: AppTool

Returns the online help ID of this component.

initApp

public void initApp(App app,
                    String id)

Description copied from interface: AppPart

Specifies the App containing this part and the unique ID of this part within the App. Invoked when the component is attached to the App.

See Also:

AppPart.getApp(), AppPart.getId(), App.getPart(java.lang.String)

getApp

public App getApp()

Description copied from interface: AppPart

Returns the App containing this part.

getId

public String getId()

Description copied from interface: AppPart

Returns the ID this part within the App.

See Also:

App.getPart(java.lang.String)

editingContextChanged

public void editingContextChanged()

Description copied from interface: AppPart

Invoked when the editing context (text node containing caret, node selection, etc) changes in active editor.

This method is never invoked if AppPart.isEditingContextSensitive() returned false when the App has registered this part (just before invoking AppPart.initApp(com.xmlmind.xmleditapp.desktop.App, java.lang.String)).

See Also:

AppPart.isEditingContextSensitive(), App.getLastContextChangeReason(), App.getActiveEditor()

applyPreferences

public void applyPreferences()

Description copied from interface: AppPart

If this part supports user preferences, this part should update its state after reading its settings from the object returned by AppBase.getPreferences().

See Also:

Preferences

flushPreferences

public void flushPreferences()

Description copied from interface: AppPart

If this part supports user preferences, this part should store its current settings in the object returned by AppBase.getPreferences().

See Also:

Preferences

validityStateChanged

public void validityStateChanged()

Description copied from interface: AppPart

Invoked after active document has been checked for validity.

See Also:

App.getActiveOpenedDocument(), OpenedDocument.getDiagnostics(), OpenedDocument.getDiagnosticSeverity()

activeEditorChanged

public void activeEditorChanged()

Description copied from interface: AppPart

Invoked after the active editor has changed or when there is no active editor at all (generally because all documents have been closed).

See Also:

App.getActiveEditor()

namespacePrefixesChanged

public void namespacePrefixesChanged()

Description copied from interface: AppPart

Invoked after the namespace/prefix map has been modified for the active document.

See Also:

App.getActiveOpenedDocument()

saveStateChanged

public void saveStateChanged()

Description copied from interface: AppPart

Invoked after active document has been saved or, on the contrary, when its has been modified and thus needs to be saved.

See Also:

App.getActiveOpenedDocument(), OpenedDocument.isSaveNeeded()

undoStateChanged

public void undoStateChanged()

Description copied from interface: AppPart

Invoked after it becomes possible to undo or redo a command in active document or, on the contrary, when it becomes impossible to undo or redo a command.

See Also:

App.getActiveOpenedDocument()

isEditingContextSensitive

public boolean isEditingContextSensitive()

Description copied from interface: AppPart

This method must return true if this part is intrinsically context sensitive and it must return false if this part is intrinsically not context sensitive.

This method is invoked once: when the App registers this part (just before invoking AppPart.initApp(com.xmlmind.xmleditapp.desktop.App, java.lang.String)). Therefore, it is useless to sometimes return true and other times to return false.

See Also:

AppPart.editingContextChanged()

destroyApp

public void destroyApp()

Description copied from interface: AppPart

Invoked when the component is detached from the App. Allows the component to perform some cleanup.

initMenuButton

public void initMenuButton(boolean hasMenuButton,
                           ToolPosition position)

setPosition

public void setPosition(ToolPosition position)

getPosition

public ToolPosition getPosition()

getToggleButton

public JToggleButton getToggleButton()

getMenuButton

public JButton getMenuButton()

setFocusable

public void setFocusable(boolean focusable)

Overrides:

setFocusable in class Component