Класс SortingFocusTraversalPolicy

javax.swing.SortingFocusTraversalPolicy

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

public class SortingFocusTraversalPolicy extends InternalFrameFocusTraversalPolicy

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

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

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

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

С момента:

1.4

См. также:

Comparator

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

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

См. также:

getFirstComponent(java.awt.Container)

setImplicitDownCycleTraversal

public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)

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

Параметры:

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

См. также:

getImplicitDownCycleTraversal()
getFirstComponent(java.awt.Container)

getImplicitDownCycleTraversal

public boolean getImplicitDownCycleTraversal()

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

Возвращает:

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

См. также:

setImplicitDownCycleTraversal(boolean)
getFirstComponent(java.awt.Container)

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, 2021, 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/17/docs/api/java.desktop/javax/swing/SortingFocusTraversalPolicy.html