Класс JFrame

Расширенная версия java.awt.Frame, которая добавляет поддержку архитектуры компонентов JFC/Swing. Подробную информацию о работе с JFrame см. в разделе Как создать фреймы руководства по Java.

Класс JFrame немного несовместим с Frame. Как и все другие контейнеры верхнего уровня JFC/Swing, JFrame содержит в качестве единственного дочернего элемента JRootPane. Панель содержимого (contentPane), предоставляемая корневой панелью, как правило, должна содержать все компоненты, кроме меню, отображаемые JFrame. Это отличается от случая с AWT Frame. Для удобства методы add, remove, и setLayout этого класса переопределены таким образом, что они делегируют вызовы соответствующим методам ContentPane. Например, вы можете добавить дочерний компонент к фрейму следующим образом:

frame.add(child);

В отличие от Frame, JFrame имеет определённое представление о том, как реагировать, когда пользователь пытается закрыть окно. По умолчанию JFrame просто скрывается при закрытии окна. Чтобы изменить это поведение, вызывайте метод setDefaultCloseOperation(int). Чтобы сделать JFrame таким же, как экземпляр Frame, используйте setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE).

Дополнительную информацию о панелях содержимого и других функциях, предоставляемых корневыми панелями, см. в разделе Использование контейнеров верхнего уровня руководства по Java.

В многоэкранной среде вы можете создать JFrame на другом экране. Подробнее см. в Frame.

Предупреждение: Swing не потокобезопасен. Дополнительную информацию см. в Политике многопоточности Swing.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для кратковременного хранения или RMI между приложениями, работающими с той же версией Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans™ добавлена в пакет java.beans. См. XMLEncoder.

Поля

EXIT_ON_CLOSE

public static final int EXIT_ON_CLOSE

Since:

1.3

См. также:

Значения константных полей

rootPane

protected JRootPane rootPane

Экземпляр, управляющий панелью contentPane и, по желанию, menuBar для этой рамки, а также glassPane.

См. также:

JRootPane, RootPaneContainer

rootPaneCheckingEnabled

protected boolean rootPaneCheckingEnabled

Если true, то вызовы add и setLayout будут перенаправлены на contentPane. По умолчанию false, но устанавливается в true при создании JFrame.

См. также:

isRootPaneCheckingEnabled(), setRootPaneCheckingEnabled(boolean), RootPaneContainer

accessibleContext

protected AccessibleContext accessibleContext

Свойство контекста доступности.

Конструкторы

JFrame

public JFrame()
       throws HeadlessException

Исключения:

HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.

См. также:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean), JComponent.getDefaultLocale()

JFrame

public JFrame(GraphicsConfiguration gc)

Параметры:

gc - GraphicsConfiguration используемый для создания нового Frame; если gc является null, используется системный GraphicsConfiguration

Исключения:

IllegalArgumentException - если gc не относится к устройству экрана. Это исключение всегда выбрасывается, когда GraphicsEnvironment.isHeadless() возвращает true.

Since:

1.3

См. также:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JFrame

public JFrame(String title)
       throws HeadlessException

Параметры:

title - заголовок для рамки

Исключения:

HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.

См. также:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean), JComponent.getDefaultLocale()

JFrame

public JFrame(String title,
              GraphicsConfiguration gc)

Параметры:

title - заголовок, отображаемый в рамке. Значение null обрабатывается как пустая строка, "".

gc - GraphicsConfiguration используемый для создания новой JFrame; если gc является null, используется системный GraphicsConfiguration

Исключения:

IllegalArgumentException - если gc не относится к устройству экрана. Это исключение всегда выбрасывается, когда GraphicsEnvironment.isHeadless() возвращает true.

Since:

1.3

См. также:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

Методы

frameInit

protected void frameInit()

Вызывается конструкторами для правильной инициализации JFrame.

createRootPane

protected JRootPane createRootPane()

Вызывается методами-конструкторами для создания стандартной rootPane.

processWindowEvent

protected void processWindowEvent(WindowEvent e)

Обрабатывает события окна, происходящие на этом компоненте. Скрывает окно или удаляет его в соответствии с настройкой свойства defaultCloseOperation.

Переопределяет:

processWindowEvent в классе Window

Параметры:

e - событие окна

См. также:

setDefaultCloseOperation(int), Window.processWindowEvent(java.awt.event.WindowEvent)

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

Параметры:

operation - операция, которая должна быть выполнена при закрытии рамки пользователем

Исключения:

IllegalArgumentException - если значение defaultCloseOperation не является одним из указанных выше допустимых значений

SecurityException - если EXIT_ON_CLOSE указано, и SecurityManager не позволит вызывающей стороне вызвать System.exit

См. также:

Window.addWindowListener(java.awt.event.WindowListener), getDefaultCloseOperation(), WindowConstants, Runtime.exit(int)

getDefaultCloseOperation

public int getDefaultCloseOperation()

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

Возвращает:

целое число, обозначающее операцию закрытия окна

См. также:

setDefaultCloseOperation(int)

setTransferHandler

public void setTransferHandler(TransferHandler newHandler)

Параметры:

newHandler - новое значение TransferHandler

Since:

1.6

См. также:

TransferHandler, getTransferHandler(), Component.setDropTarget(java.awt.dnd.DropTarget)

getTransferHandler

public TransferHandler getTransferHandler()

Возвращает свойство transferHandler.

Возвращает:

значение свойства transferHandler

Since:

1.6

См. также:

TransferHandler, setTransferHandler(javax.swing.TransferHandler)

update

public void update(Graphics g)

Просто вызывает paint(g). Этот метод был переопределён, чтобы предотвратить ненужный вызов очистки фона.

Переопределяет:

update в классе Container

Параметры:

g - контекст графики для отрисовки

См. также:

Component.update(Graphics)

setJMenuBar

public void setJMenuBar(JMenuBar menubar)

Устанавливает строку меню для этого фрейма.

Параметры:

menubar - строка меню, размещаемая во фрейме

См. также:

getJMenuBar()

getJMenuBar

public JMenuBar getJMenuBar()

Возвращает строку меню, установленную для этого фрейма.

Возвращает:

строка меню для этого фрейма

См. также:

setJMenuBar(javax.swing.JMenuBar)

isRootPaneCheckingEnabled

protected boolean isRootPaneCheckingEnabled()

Возвращает, пересылаются ли вызовы add и setLayout в contentPane.

Возвращает:

true, если вызовы add и setLayout пересылаются; false в противном случае

См. также:

addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), setRootPaneCheckingEnabled(boolean), RootPaneContainer

setRootPaneCheckingEnabled

protected void setRootPaneCheckingEnabled(boolean enabled)

Устанавливает, пересылаются ли вызовы add и setLayout в contentPane.

Параметры:

enabled - true, если вызовы add и setLayout пересылаются, false — если они должны выполняться напрямую на JFrame.

См. также:

addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), isRootPaneCheckingEnabled(), RootPaneContainer

addImpl

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

Добавляет указанного дочернего Component. Этот метод переопределен для условной пересылки вызовов в contentPane. По умолчанию, дети добавляются в contentPane вместо фрейма, см. RootPaneContainer для подробностей.

Переопределяет:

addImpl в классе Container

Параметры:

comp - компонент для улучшения

constraints - ограничения для соблюдения

index - индекс

Исключения:

IllegalArgumentException - если index недействителен

IllegalArgumentException - если родитель контейнера добавляется в себя

IllegalArgumentException - если окно добавляется в контейнер

См. также:

setRootPaneCheckingEnabled(boolean), RootPaneContainer

remove

public void remove(Component comp)

Удаляет указанный компонент из контейнера. Если comp не является rootPane, вызов пересылается в contentPane. Это ничего не сделает, если comp не является дочерним элементом JFrame или contentPane.

Переопределяет:

remove в классе Container

Параметры:

comp - компонент для удаления

Исключения:

NullPointerException - если comp равно null

См. также:

Container.add(java.awt.Component), RootPaneContainer

setLayout

public void setLayout(LayoutManager manager)

Устанавливает LayoutManager. Переопределено для условной пересылки вызова в contentPane. Дополнительную информацию см. в RootPaneContainer.

Переопределяет:

setLayout в классе Container

Параметры:

manager - LayoutManager

См. также:

setRootPaneCheckingEnabled(boolean), RootPaneContainer

getRootPane

public JRootPane getRootPane()

Возвращает объект rootPane для этого фрейма.

Определяет:

getRootPane в интерфейсе RootPaneContainer

Возвращает:

свойство rootPane

См. также:

setRootPane(javax.swing.JRootPane), RootPaneContainer.getRootPane()

setRootPane

protected void setRootPane(JRootPane root)

Устанавливает свойство rootPane. Этот метод вызывается конструктором.

Параметры:

root - объект rootPane для этого фрейма

См. также:

getRootPane()

setIconImage

public void setIconImage(Image image)

setIconImage(image);

ArrayList<Image> imageList = new ArrayList<Image>();
     imageList.add(image);
     setIconImages(imageList);

Переопределяет:

setIconImage в классе Frame

Параметры:

image - изображение значка для отображения.

См. также:

Window.setIconImages(java.util.List<? extends java.awt.Image>), Window.getIconImages()

getContentPane

public Container getContentPane()

Возвращает объект contentPane для этого фрейма.

Определяет:

getContentPane в интерфейсе RootPaneContainer

Возвращает:

свойство contentPane

См. также:

setContentPane(java.awt.Container), RootPaneContainer.getContentPane()

setContentPane

public void setContentPane(Container contentPane)

Определяет:

setContentPane в интерфейсе RootPaneContainer

Параметры:

contentPane - объект contentPane для этого фрейма

Исключения:

IllegalComponentStateException - (исключение времени выполнения) если параметр панели содержимого null

См. также:

getContentPane(), RootPaneContainer.setContentPane(java.awt.Container), JRootPane

getLayeredPane

public JLayeredPane getLayeredPane()

Возвращает объект layeredPane для этого фрейма.

Определяет:

getLayeredPane в интерфейсе RootPaneContainer

Возвращает:

свойство layeredPane

См. также:

setLayeredPane(javax.swing.JLayeredPane), RootPaneContainer.getLayeredPane()

setLayeredPane

public void setLayeredPane(JLayeredPane layeredPane)

Устанавливает свойство layeredPane. Этот метод вызывается конструктором.

Определяет:

setLayeredPane в интерфейсе RootPaneContainer

Параметры:

layeredPane - объект layeredPane для этого фрейма

Исключения:

IllegalComponentStateException - (исключение времени выполнения) если параметр панели слоёв null

См. также:

getLayeredPane(), RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)

getGlassPane

public Component getGlassPane()

Возвращает объект glassPane для этого фрейма.

Определяет:

getGlassPane в интерфейсе RootPaneContainer

Возвращает:

свойство glassPane

См. также:

setGlassPane(java.awt.Component), RootPaneContainer.getGlassPane()

setGlassPane

public void setGlassPane(Component glassPane)

Устанавливает свойство glassPane. Этот метод вызывается конструктором.

Определяет:

setGlassPane в интерфейсе RootPaneContainer

Параметры:

glassPane - объект glassPane для этого фрейма

См. также:

getGlassPane(), RootPaneContainer.setGlassPane(java.awt.Component)

getGraphics

public Graphics getGraphics()

Создаёт контекст графики для этого компонента. Этот метод вернёт null если этот компонент в настоящее время недоступен для отображения.

Переопределяет:

getGraphics в классе Component

Возвращает:

контекст графики для этого компонента, или null если его нет

С тех пор:

1.6

См. также:

Component.paint(java.awt.Graphics)

repaint

public void repaint(long time,
                    int x,
                    int y,
                    int width,
                    int height)

Перерисовывает указанный прямоугольник этого компонента в течение time миллисекунд. Подробнее о том, как обрабатывается перерисовка, см. RepaintManager.

Overrides:

repaint в классе Component

Parameters:

time — максимальное время в миллисекундах до обновления

x — координата x

y — координата y

width — ширина

height — высота

Since:

1.6

See Also:

RepaintManager

setDefaultLookAndFeelDecorated

public static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated)

JFrame frame = new JFrame();
    frame.setUndecorated(true);
    frame.getRootPane().setWindowDecorationStyle(JRootPane.FRAME);

Parameters:

defaultLookAndFeelDecorated — подсказка о том, следует ли текущей внешности предоставлять декорации окна

Since:

1.4

See Also:

LookAndFeel.getSupportsWindowDecorations()

isDefaultLookAndFeelDecorated

public static boolean isDefaultLookAndFeelDecorated()

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

Returns:

true, если внешность должна предоставлять декорации окна.

Since:

1.4

paramString

protected String paramString()

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

Overrides:

paramString в классе Frame

Returns:

строковое представление этого JFrame

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext, связанный с этим JFrame. Для JFrames AccessibleContext принимает форму AccessibleJFrame. Новый экземпляр AccessibleJFrame создается при необходимости.

Specified by:

getAccessibleContext в интерфейсе Accessible

Overrides:

getAccessibleContext в классе Frame

Returns:

AccessibleJFrame, который служит AccessibleContext для этого JFrame