+ * This action appears as a checkbox menu item under the View menu. It + * allows users to enable or disable line wrapping dynamically for the current + * file without changing the global or MIME-type settings configured in + * {@code Tools/Options/Editor/Formatting}. + *
+ *+ * Word wrapping behavior relies on the {@link LineWrapType} enumeration, which + * defines three values: {@code NONE}, {@code WORD_BOUND}, and + * {@code CHARACTER_BOUND}. This action specifically toggles between + * {@code NONE} and {@code WORD_BOUND}. If the editor is currently configured to + * use {@code CHARACTER_BOUND}, it will be treated as {@code NONE} by this + * action. + *
+ *+ * The action is automatically disabled when it cannot be applied to the current + * context. It is bound to the {@code ALT-Z} keyboard shortcut by default, which + * can be reconfigured via {@code Tools/Options/Keymap}. + *
+ * + * @author Alejandro L. Belhafi + */ +@Messages({"wordWrapAction.displayName=&Word Wrap"}) +@ActionID(category = "View", id = "org.netbeans.modules.editor.WordWrapAction") +@ActionReferences({ + @ActionReference(path = "Menu/View", position = 215), + @ActionReference(path = "Shortcuts", name = "O-Z")}) +@ActionRegistration(lazy = false, iconInMenu = false, displayName = "#wordWrapAction.displayName") +public class WordWrapAction extends AbstractAction + implements PropertyChangeListener, Runnable, DynamicMenuContent { + + /** + * Constant representing no line wrapping, mapping to + * {@link LineWrapType#NONE}. This is also used as the fallback treatment for + * {@link LineWrapType#CHARACTER_BOUND}. + */ + private static final String NONE = "none"; //NOI18N + + /** + * Constant representing standard word wrapping, mapping to + * {@link LineWrapType#WORD_BOUND}. + */ + private static final String WORDS = "words"; //NOI18N + + private JCheckBoxMenuItem menu; + + public WordWrapAction() { + super(Bundle.wordWrapAction_displayName()); + putValue(SELECTED_KEY, false); + + TopComponent.getRegistry().addPropertyChangeListener( + WeakListeners.propertyChange(this, TopComponent.getRegistry())); + } + + /** + * Toggles the word wrap state for the currently active editor and updates + * the checkbox selection status of the action accordingly. + * + * @param event the action event triggered by the user (e.g., clicking the + * View menu item or pressing the keyboard shortcut) + * @see DocumentViewOp#updateLineWrapType() + */ + @Override + public void actionPerformed(ActionEvent event) { + + final JTextComponent editor = Utilities.getLastActiveComponent(); + + if (editor == null) { + return; + } + + boolean newSelection = !(isWordWrapActive(editor)); + + putValue(SELECTED_KEY, newSelection); + + editor.putClientProperty(SimpleValueNames.TEXT_LINE_WRAP, newSelection ? WORDS : NONE); + } + + private String getLineWrapType(JTextComponent editor) { + String lineWrapType = (String) editor.getClientProperty(SimpleValueNames.TEXT_LINE_WRAP); + + if (lineWrapType == null) { + lineWrapType = CodeStylePreferences.get(editor.getDocument()) + .getPreferences() + .get(SimpleValueNames.TEXT_LINE_WRAP, NONE); + } + + return lineWrapType; + } + + @Override + public JComponent[] getMenuPresenters() { + createMenu(); + updateState(); + return new JCheckBoxMenuItem[]{menu}; + } + + private void createMenu() { + menu = new JCheckBoxMenuItem(); + Actions.connect(menu, this, true); + } + + private void updateState() { + if (EventQueue.isDispatchThread()) { + run(); + } else { + SwingUtilities.invokeLater(this); + } + } + + @Override + public JComponent[] synchMenuPresenters(JComponent[] items) { + updateState(); + return items; + } + + @Override + public void propertyChange(PropertyChangeEvent evt) { + if (TopComponent.Registry.PROP_ACTIVATED.equals(evt.getPropertyName())) { + updateState(); + } + } + + @Override + public void run() { + boolean isDocumentActive = false; + TopComponent tc = TopComponent.getRegistry().getActivated(); + if (tc != null) { + isDocumentActive = WindowManager.getDefault().isEditorTopComponent(tc); + } + synchronized (this) { + setEnabled(isDocumentActive); + updateSelection(); + } + } + + private void updateSelection() { + if (!isEnabled()) { + putValue(SELECTED_KEY, false); + return; + } + + final JTextComponent editor = Utilities.getLastActiveComponent(); + if (editor == null) { + putValue(SELECTED_KEY, false); + return; + } + + putValue(SELECTED_KEY, isWordWrapActive(editor)); + } + + private boolean isWordWrapActive(JTextComponent editor) { + return WORDS.equals(getLineWrapType(editor)); + } + +}