org.dominokit.domino.ui.richtext.commands.RemoveLinkCommand Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2019 Dominokit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.dominokit.domino.ui.richtext.commands;

import static java.util.Objects.nonNull;
import static org.dominokit.domino.ui.utils.Domino.*;

import elemental2.dom.DocumentFragment;
import elemental2.dom.Element;
import elemental2.dom.HTMLElement;
import elemental2.dom.NodeList;
import org.dominokit.domino.ui.button.Button;
import org.dominokit.domino.ui.elements.DivElement;
import org.dominokit.domino.ui.icons.lib.Icons;
import org.dominokit.domino.ui.richtext.RichTextCommand;

/**
 * Represents a UI command to remove formatting from the selected text in the rich text editor.
 *
 * The {@code RemoveFormatCommand} extends {@link RichTextCommand} and provides users with the
 * ability to remove any inline formatting (like bold, italic, underline, color, etc.) from the
 * selected text in the rich text editor. The command is visually represented by a button with a
 * format removal icon.
 *
 * 
Once clicked, the button will clear any formatting on the selected text, reverting it back to
 * the default style.
 *
 * 
Usage Example:
 *
 * 
{@code
 * DivElement editableDiv = DivElement.create();
 * RemoveFormatCommand removeFormatCommand = RemoveFormatCommand.create(editableDiv);
 * }
 */
public class RemoveLinkCommand extends RichTextCommand {

  private Button button;

  /**
   * Factory method to create a new instance of RemoveFormatCommand.
   *
   * @param editableElement The div element where the rich text is edited.
   * @return A new instance of RemoveFormatCommand.
   */
  public static RemoveLinkCommand create(DivElement editableElement) {
    return new RemoveLinkCommand(editableElement);
  }

  /**
   * Constructs a new RemoveFormatCommand instance for the specified editable div element.
   *
   * @param editableElement The div element where the rich text is edited.
   */
  public RemoveLinkCommand(DivElement editableElement) {
    super(editableElement);

    this.button =
        Button.create(Icons.link_off())
            .setTooltip(getLabels().removeLinks())
            .addClickListener(
                evt -> {
                  execute();
                });

    init(this);
  }

  /**
   * @dominokit-site-ignore {@inheritDoc}
   *     Returns the main HTMLElement of this command, which is the button used to trigger the
   *     format removal action.
   * @return The HTMLElement of the button.
   */
  @Override
  public HTMLElement element() {
    return button.element();
  }

  /**
   * Executes the remove format command, stripping the selected text in the rich text editor of its
   * formatting.
   */
  @Override
  protected void execute() {
    getSelectedRange()
        .ifPresent(
            range -> {
              DocumentFragment documentFragment = range.extractContents();
              NodeList anchors = documentFragment.querySelectorAll("a");
              anchors.forEach(
                  (currentValue, currentIndex, listObj) -> {
                    unwrap(currentValue, documentFragment);
                    return null;
                  });
              range.deleteContents();
              range.insertNode(documentFragment);
            });
  }

  private void unwrap(Element el, DocumentFragment documentFragment) {
    if (nonNull(el)) {
      while (nonNull(el.firstChild)) {
        if (nonNull(el.parentNode)) {
          el.parentNode.insertBefore(el.firstChild, el);
        } else {
          documentFragment.insertBefore(el.firstChild, el);
        }
      }
      el.remove();
    }
  }
}