org.dominokit.domino.ui.richtext.commands.SubscriptCommand Maven / Gradle / Ivy
/*
* 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;
/**
* Represents a UI command to apply subscript formatting to the selected text in the rich text
* editor.
*
* The {@code SubscriptCommand} extends {@link RichTextCommand} and provides users with the
* ability to apply a subscript style to the selected text in the rich text editor. The command is
* visually represented by a button with a subscript icon.
*
*
Once clicked, the button will toggle the subscript style on the selected text, allowing users
* to either apply or remove the subscript formatting.
*
*
Usage Example:
*
*
{@code
* DivElement editableDiv = DivElement.create();
* SubscriptCommand subscriptCommand = SubscriptCommand.create(editableDiv);
* }
*/
public class SubscriptCommand extends RichTextCommand {
private Button button;
/**
* Factory method to create a new instance of SubscriptCommand.
*
* @param editableElement The div element where the rich text is edited.
* @return A new instance of SubscriptCommand.
*/
public static SubscriptCommand create(DivElement editableElement) {
return new SubscriptCommand(editableElement);
}
/**
* Constructs a new SubscriptCommand instance for the specified editable div element.
*
* @param editableElement The div element where the rich text is edited.
*/
public SubscriptCommand(DivElement editableElement) {
super(editableElement);
this.button =
Button.create(Icons.format_subscript())
.setTooltip(getLabels().subscript())
.addClickListener(evt -> execute());
init(this);
}
/**
* @dominokit-site-ignore {@inheritDoc}
* Returns the main HTMLElement of this command, which is the button used to trigger the
* subscript action.
* @return The HTMLElement of the button.
*/
@Override
public HTMLElement element() {
return button.element();
}
/**
* Executes the subscript command, toggling the subscript style on the selected text in the rich
* text editor.
*/
@Override
protected void execute() {
getSelectedRange()
.ifPresent(
range -> {
DominoDom.document.execCommand("subscript");
});
}
}