org.htmlunit.html.impl.SelectableTextSelectionDelegate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation
XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.
The newest version!
/*
 * Copyright (c) 2002-2024 Gargoyle Software Inc.
 *
 * 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
 * https://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.htmlunit.html.impl;

import static org.htmlunit.BrowserVersionFeatures.JS_INPUT_IGNORE_NEGATIVE_SELECTION_START;

import org.htmlunit.html.DomNode;

/**
 * Contains standard selection-related functionality used by various input elements.
 *
 * From the HTML5 spec:
 *
 * 
Mostly for historical reasons, in addition to the browsing context's selection, each
 * textarea and input element has an independent selection. These are the text field selections.
 *
 * @author Daniel Gredler
 * @author Ronald Brill
 * @author Ahmed Ashour
 */
public class SelectableTextSelectionDelegate implements SelectionDelegate {

    /** The owner element. */
    private final SelectableTextInput element_;

    /** The field selection, which is independent of the browsing context's selection. */
    private final SimpleRange selection_;

    /**
     * Creates a new instance for the specified element.
     * @param element the owner element
     */
    public SelectableTextSelectionDelegate(final SelectableTextInput element) {
        element_ = element;
        selection_ = new SimpleRange((DomNode) element, 0);
    }

    /**
     * Focuses the owner element and selects all of its text.
     */
    public void select() {
        element_.focus();
        setSelectionStart(0);
        setSelectionEnd(element_.getText().length());
    }

    /**
     * Returns the selected text in the owner element, or {@code null} if there is no selected text.
     * @return the selected text in the owner element, or {@code null} if there is no selected text
     */
    public String getSelectedText() {
        return selection_.toString();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getSelectionStart() {
        return selection_.getStartOffset();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setSelectionStart(int selectionStart) {
        if (selectionStart < 0
                && element_.getPage().getEnclosingWindow().getWebClient()
                    .getBrowserVersion().hasFeature(JS_INPUT_IGNORE_NEGATIVE_SELECTION_START)) {
            return;
        }

        final int length = element_.getText().length();
        selectionStart = Math.max(0, Math.min(selectionStart, length));
        selection_.setStart((DomNode) element_, selectionStart);
        if (selection_.getEndOffset() < selectionStart) {
            selection_.setEnd((DomNode) element_, selectionStart);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getSelectionEnd() {
        return selection_.getEndOffset();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setSelectionEnd(int selectionEnd) {
        final int length = element_.getText().length();
        selectionEnd = Math.min(length, Math.max(selectionEnd, 0));
        selection_.setEnd((DomNode) element_, selectionEnd);
        if (selection_.getStartOffset() > selectionEnd) {
            selection_.setStart((DomNode) element_, selectionEnd);
        }
    }
}