org.dominokit.domino.ui.richtext.commands.OutdentCommand 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 reduce the indent of the selected text or paragraph within a rich text
* editor.
*
* The {@code OutdentCommand} extends {@link RichTextCommand} and provides users with the ability
* to decrease the indent level of the selected text or paragraphs. The command is represented by a
* button with an indent decrease icon. When this button is clicked, it reduces the indentation of
* the currently selected text or paragraphs.
*
*
Usage Example:
*
*
{@code
* DivElement editableDiv = DivElement.create();
* OutdentCommand outdentCommand = OutdentCommand.create(editableDiv);
* }
*/
public class OutdentCommand extends RichTextCommand {
private Button button;
/**
* Factory method to create a new instance of OutdentCommand.
*
* @param editableElement The div element where the rich text is edited.
* @return A new instance of OutdentCommand.
*/
public static OutdentCommand create(DivElement editableElement) {
return new OutdentCommand(editableElement);
}
/**
* Constructs a new OutdentCommand instance for the specified editable div element.
*
* @param editableElement The div element where the rich text is edited.
*/
public OutdentCommand(DivElement editableElement) {
super(editableElement);
this.button =
Button.create(Icons.format_indent_decrease())
.setTooltip(getLabels().reduceIndent())
.addClickListener(evt -> execute());
init(this);
}
/**
* @dominokit-site-ignore {@inheritDoc}
* Returns the main HTMLElement of this command, which is the button used to decrease the
* indent level.
* @return The HTMLElement of the button.
*/
@Override
public HTMLElement element() {
return button.element();
}
/**
* Executes the command, reducing the indent level of the selected text or paragraph in the
* editable div element.
*/
@Override
protected void execute() {
getSelectedRange()
.ifPresent(
range -> {
DominoDom.document.execCommand("outdent");
});
}
}