Класс SortingFocusTraversalPolicy

javax.swing.SortingFocusTraversalPolicy

Прямые известные подклассы:: LayoutFocusTraversalPolicy

public class SortingFocusTraversalPolicy extends InternalFrameFocusTraversalPolicy

Политика FocusTraversalPolicy, определяющая порядок обхода, сортируя компоненты цикла обхода по фокусу на основе заданного компаратора. Части иерархии компонентов, которые не видны и не отображаются, не будут включены.

По умолчанию SortingFocusTraversalPolicy неявно передает фокус по циклу вниз. То есть, во время обычного перемещения фокуса, компонент, обходимый после корня цикла фокуса, будет компонентом по умолчанию корня цикла фокуса. Это поведение можно отключить, используя метод setImplicitDownCycleTraversal.

По умолчанию методы этого класса возвращают компонент только в том случае, если он видим, отображается, активен и фокусируется. Подклассы могут изменить это поведение, переопределив метод accept.

Данная политика учитывает поставщиков политики обхода фокуса. При поиске первого/последнего/следующего/предыдущего компонента, если встречается поставщик политики обхода фокуса, используется его политика обхода фокуса для выполнения операции поиска.

С момента:

1.4

См. также:

Краткое описание конструкторов

SortingFocusTraversalPolicy()

SortingFocusTraversalPolicy(Comparator<? super Component> comparator)

Модификатор	Конструктор	Описание
`protected`	Создаёт SortingFocusTraversalPolicy без компаратора.
	Создаёт SortingFocusTraversalPolicy со заданным компаратором.

Краткое описание методов

Модификатор и тип	Метод	Описание
`protected boolean`	`accept(Component aComponent)`	Определяет, является ли компонент приемлемым выбором в качестве нового владельца фокуса.
`protected Comparator<? super Component>`	`getComparator()`	Возвращает компаратор, который будет использоваться для сортировки компонентов в цикле обхода фокуса.
`Component`	`getComponentAfter(Container aContainer, Component aComponent)`	Возвращает компонент, которому должен быть передан фокус после aComponent.
`Component`	`getComponentBefore(Container aContainer, Component aComponent)`	Возвращает компонент, которому должен быть передан фокус перед aComponent.
`Component`	`getDefaultComponent(Container aContainer)`	Возвращает компонент по умолчанию для фокуса.
`Component`	`getFirstComponent(Container aContainer)`	Возвращает первый компонент в цикле обхода.
`boolean`	`getImplicitDownCycleTraversal()`	Возвращает, передает ли эта SortingFocusTraversalPolicy фокус по циклу неявно вниз.
`Component`	`getLastComponent(Container aContainer)`	Возвращает последний компонент в цикле обхода.
`protected void`	`setComparator(Comparator<? super Component> comparator)`	Устанавливает компаратор, который будет использоваться для сортировки компонентов в цикле обхода фокуса.
`void`	`setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)`	Устанавливает, передает ли эта SortingFocusTraversalPolicy фокус по циклу неявно вниз.

Методы, объявленные в классе javax.swing.InternalFrameFocusTraversalPolicy

getInitialComponent

Методы, объявленные в классе java.awt.FocusTraversalPolicy

getInitialComponent

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

SortingFocusTraversalPolicy

protected SortingFocusTraversalPolicy()

Создаёт SortingFocusTraversalPolicy без компаратора. Подклассы должны установить компаратор с помощью setComparator перед установкой этой FocusTraversalPolicy на корень цикла фокуса или KeyboardFocusManager.

SortingFocusTraversalPolicy

public SortingFocusTraversalPolicy(Comparator<? super Component> comparator)

Создаёт SortingFocusTraversalPolicy со заданным компаратором.

Параметры:: comparator - компаратор для сортировки

Подробное описание методов

getComponentAfter

public Component getComponentAfter(Container aContainer, Component aComponent)

Возвращает компонент, который должен получить фокус после aComponent. aContainer должен быть корнем цикла фокуса для aComponent или поставщиком политики прохода фокуса.

По умолчанию, SortingFocusTraversalPolicy неявно передаёт фокус вниз по циклу. То есть, во время обычного прохода фокуса, компонент, пройденный после корня цикла фокуса, будет стандартным компонентом для получения фокуса корнем цикла фокуса. Это поведение можно отключить, используя метод setImplicitDownCycleTraversal.

Если aContainer является поставщиком политики прохода фокуса, фокус всегда передаётся вниз по циклу.

Унаследованно от:: getComponentAfter в классе FocusTraversalPolicy
Параметры:: aContainer - корень цикла фокуса для aComponent или поставщик политики прохода фокуса; aComponent - (возможно, косвенный) дочерний элемент aContainer или сам aContainer
Возвращает:: Компонент, который должен получить фокус после aComponent, или null, если подходящий компонент не найден
Исключения:: IllegalArgumentException - если aContainer не является корнем цикла фокуса для aComponent или поставщиком политики прохода фокуса, или если aContainer или aComponent равны null

getComponentBefore

public Component getComponentBefore(Container aContainer, Component aComponent)

Возвращает компонент, который должен получить фокус перед aComponent. aContainer должен быть корнем цикла фокуса для aComponent или поставщиком политики прохода фокуса.

Если aContainer является поставщиком политики прохода фокуса, фокус всегда передаётся вниз по циклу.

Унаследованно от:: getComponentBefore в классе FocusTraversalPolicy
Параметры:: aContainer - корень цикла фокуса для aComponent или поставщик политики прохода фокуса; aComponent - (возможно, косвенный) дочерний элемент aContainer или сам aContainer
Возвращает:: Компонент, который должен получить фокус перед aComponent, или null, если подходящий компонент не найден
Исключения:: IllegalArgumentException - если aContainer не является корнем цикла фокуса для aComponent или поставщиком политики прохода фокуса, или если aContainer или aComponent равны null

getFirstComponent

public Component getFirstComponent(Container aContainer)

Возвращает первый компонент в цикле прохода. Этот метод используется для определения следующего компонента для фокуса при обходе цикла в прямом направлении.

Унаследованно от:: getFirstComponent в классе FocusTraversalPolicy
Параметры:: aContainer - корень цикла фокуса для aComponent или поставщик политики прохода фокуса, первый компонент которого должен быть возвращён
Возвращает:: Первый компонент в цикле прохода aContainer, или null, если подходящий компонент не найден
Исключения:: IllegalArgumentException - если aContainer равен null

getLastComponent

public Component getLastComponent(Container aContainer)

Возвращает последний компонент в цикле прохода. Этот метод используется для определения следующего компонента для фокуса при обходе цикла в обратном направлении.

Унаследованно от:: getLastComponent в классе FocusTraversalPolicy
Параметры:: aContainer - корень цикла фокуса для aComponent или поставщик политики прохода фокуса, последний компонент которого должен быть возвращён
Возвращает:: Последний компонент в цикле прохода aContainer, или null, если подходящий компонент не найден
Исключения:: IllegalArgumentException - если aContainer равен null

getDefaultComponent

public Component getDefaultComponent(Container aContainer)

Возвращает стандартный компонент для фокуса. Этот компонент будет первым, который получит фокус при проходе вниз по новому циклу прохода фокуса, укоренённому в aContainer. Стандартная реализация этого метода возвращает тот же компонент, что и getFirstComponent.

Унаследованно от:

getDefaultComponent в классе FocusTraversalPolicy

Параметры:

aContainer - корень цикла фокуса для aComponent или поставщик политики прохода фокуса, стандартный компонент которого должен быть возвращён

Возвращает:

стандартный компонент в цикле прохода aContainer, или null, если подходящий компонент не найден

Исключения:

IllegalArgumentException - если aContainer равен null

См. также:

setImplicitDownCycleTraversal

public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)

Устанавливает, неявно ли SortingFocusTraversalPolicy передаёт фокус вниз по циклу. Если true, во время обычного прохода фокуса, компонент, пройденный после корня цикла фокуса, будет стандартным компонентом для получения фокуса корнем цикла фокуса. Если false, следующий компонент в цикле прохода фокуса, укоренённом в указанном корне цикла фокуса, будет пройден вместо этого. Значение по умолчанию для этого свойства - true.

Параметры:

implicitDownCycleTraversal - неявно ли SortingFocusTraversalPolicy передаёт фокус вниз по циклу

См. также:

getImplicitDownCycleTraversal

public boolean getImplicitDownCycleTraversal()

Возвращает, неявно ли SortingFocusTraversalPolicy передаёт фокус вниз по циклу. Если true, во время обычного прохода фокуса, компонент, пройденный после корня цикла фокуса, будет стандартным компонентом для получения фокуса корнем цикла фокуса. Если false, следующий компонент в цикле прохода фокуса, укоренённом в указанном корне цикла фокуса, будет пройден вместо этого.

Возвращает:

неявно ли SortingFocusTraversalPolicy передаёт фокус вниз по циклу

См. также:

setComparator

protected void setComparator(Comparator<? super Component> comparator)

Устанавливает компаратор, который будет использоваться для сортировки компонентов в цикле прохода фокуса.

Параметры:: comparator - компаратор, который будет использоваться для сортировки

getComparator

protected Comparator<? super Component> getComparator()

Возвращает компаратор, который будет использоваться для сортировки компонентов в цикле прохода фокуса.

Возвращает:: компаратор, который будет использоваться для сортировки

accept

protected boolean accept(Component aComponent)

Определяет, является ли компонент приемлемым выбором в качестве нового владельца фокуса. По умолчанию, этот метод будет принимать компонент, если и только если он видим, отображаем, активен и фокусируем.

Параметры:: aComponent - компонент, чья пригодность в качестве владельца фокуса подлежит проверке
Возвращает:: true если aComponent видим, отображаем, активен и фокусируем; false в противном случае

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/SortingFocusTraversalPolicy.html