org.dominokit.domino.ui.richtext.commands.BoldCommand 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 org.dominokit.domino.ui.utils.Domino.*;

import elemental2.dom.HTMLElement;
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;
import org.dominokit.domino.ui.utils.DominoDom;

/**
 * A UI component for applying the bold text formatting command to a selected range within a rich
 * text editor.
 *
 * The BoldCommand extends {@link RichTextCommand} to provide the capability to bolden the
 * selected text in a rich text editable element. It incorporates a button with a bold icon to
 * represent and execute the bold command.
 *
 * 
Usage Example:
 *
 * 
{@code
 * DivElement editableDiv = DivElement.create();
 * BoldCommand boldCommand = BoldCommand.create(editableDiv);
 * }
 */
public class BoldCommand extends RichTextCommand {

  private Button button;

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

  /**
   * Constructs a new BoldCommand instance for the specified editable element.
   *
   * @param editableElement The div element where the rich text is edited.
   */
  public BoldCommand(DivElement editableElement) {
    super(editableElement);
    this.button =
        Button.create(Icons.format_bold())
            .setTooltip(getLabels().bold())
            .addClickListener(evt -> execute());
    init(this);
  }

  /**
   * @dominokit-site-ignore {@inheritDoc}
   *     Returns the main HTMLElement of this command, which is the button for boldening the
   *     text.
   * @return The HTMLElement of the bold button.
   */
  @Override
  public HTMLElement element() {
    return button.element();
  }

  /**
   * Executes the command, applying bold text formatting to the currently selected text within the
   * editable div element.
   */
  @Override
  protected void execute() {
    getSelectedRange()
        .ifPresent(
            range -> {
              DominoDom.document.execCommand("bold");
            });
  }
}