001/*
002 * ============================================================================
003 *  Copyright © 2002-2024 by Thomas Thrien.
004 *  All Rights Reserved.
005 * ============================================================================
006 *  Licensed to the public under the agreements of the GNU Lesser General Public
007 *  License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *       http://www.gnu.org/licenses/lgpl.html
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 *  License for the specific language governing permissions and limitations
015 *  under the License.
016 */
017
018package org.tquadrat.foundation.fx.internal;
019
020import static org.apiguardian.api.API.Status.STABLE;
021import static org.tquadrat.foundation.lang.Objects.requireNonNullArgument;
022
023import org.apiguardian.api.API;
024import org.tquadrat.foundation.annotation.ClassVersion;
025import org.tquadrat.foundation.annotation.UtilityClass;
026import org.tquadrat.foundation.exception.PrivateConstructorForStaticClassCalledError;
027import javafx.scene.Node;
028
029/**
030 *  Helper functions for the implementation of
031 *  {@link javafx.scene.control.SkinBase Skin}s
032 *  and
033 *  {@link javafx.scene.control.Control Control}s.
034 *
035 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
036 *  @version $Id: ControlUtils.java 1112 2024-03-10 14:16:51Z tquadrat $
037 *  @since 0.4.6
038 *
039 *  @UMLGraph.link
040 */
041@ClassVersion( sourceVersion = "$Id: ControlUtils.java 1112 2024-03-10 14:16:51Z tquadrat $" )
042@API( status = STABLE, since = "0.4.6" )
043@UtilityClass
044public final class ControlUtils
045{
046        /*---------------*\
047    ====** Inner Classes **====================================================
048        \*---------------*/
049
050        /*-----------*\
051    ====** Constants **========================================================
052        \*-----------*/
053
054        /*------------*\
055    ====** Attributes **=======================================================
056        \*------------*/
057
058        /*------------------------*\
059    ====** Static Initialisations **===========================================
060        \*------------------------*/
061
062        /*--------------*\
063    ====** Constructors **=====================================================
064        \*--------------*/
065    /**
066     *  No instance allowed for this class!
067     */
068    private ControlUtils() { throw new PrivateConstructorForStaticClassCalledError( ControlUtils.class ); }
069
070        /*---------*\
071    ====** Methods **==========================================================
072        \*---------*/
073    /**
074     *  Moves the focus to the next node on the same hierarchy level.
075     *
076     *  @param  node    The node that currently has the focus.
077     */
078    public static final void focusNextSibling( final Node node )
079    {
080        final var children = requireNonNullArgument( node, "node" ).getParent().getChildrenUnmodifiable();
081        final var index = children.indexOf( node );
082        if( index < children.size() - 1 )
083        {
084            children.get( index + 1 ).requestFocus();
085        }
086        else
087        {
088            focusNextSibling( node.getParent() );
089        }
090    }   //  focusNextSibling()
091
092    /**
093     *  Moves the focus to the previous node on the same hierarchy level.
094     *
095     *  @param  node    The node that currently has the focus.
096     */
097    public static final void focusPreviousSibling( final Node node )
098    {
099        final var children = requireNonNullArgument( node, "node" ).getParent().getChildrenUnmodifiable();
100        final var index = children.indexOf( node );
101        if( index > 0 )
102        {
103            children.get( index - 1 ).requestFocus();
104        }
105        else
106        {
107            node.getParent().requestFocus();
108        }
109    }   //  focusPreviousSibling()
110}
111//  class ControlUtils
112
113/*
114 *  End of File
115 */