org.eclipse.swt.browser.VisibilityWindowListener Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2003, 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.swt.browser;
import org.eclipse.swt.internal.SWTEventListener;
/**
* This listener interface may be implemented in order to receive
* a {@link WindowEvent} notification when a window hosting a
* {@link Browser} needs to be displayed or hidden.
*
* @see Browser#addVisibilityWindowListener(VisibilityWindowListener)
* @see Browser#removeVisibilityWindowListener(VisibilityWindowListener)
* @see OpenWindowListener
* @see CloseWindowListener
*
* @since 3.0
*/
public interface VisibilityWindowListener extends SWTEventListener {
/**
* This method is called when the window hosting a Browser
* is requested to be hidden. Application would typically hide the
* {@link org.eclipse.swt.widgets.Shell} that hosts the Browser
.
*
*
*
The following fields in the WindowEvent
apply:
*
* - (in) widget the
Browser
that needs to be hidden
*
*
* @param event the WindowEvent
that specifies the
* Browser
that needs to be hidden
*
* @see org.eclipse.swt.widgets.Shell#setVisible(boolean)
*
* @since 3.0
*/
public void hide(WindowEvent event);
/**
* This method is called when the window hosting a Browser
* is requested to be displayed. Application would typically set the
* location and the size of the {@link org.eclipse.swt.widgets.Shell}
* that hosts the Browser
, if a particular location and size
* are specified. The application would then open that Shell
.
*
*
*
The following fields in the WindowEvent
apply:
*
* - (in) widget the
Browser
to display
* - (in) location the requested location for the
Shell
* hosting the browser. It is null
if no location is set.
* - (in) size the requested size for the
Browser
.
* The client area of the Shell
hosting the
* Browser
should be large enough to accommodate that size.
* It is null
if no size is set.
* - (in) addressBar
true
if the Shell
* hosting the Browser
should display an address bar or
* false
otherwise
* - (in) menuBar
true
if the Shell
* hosting the Browser
should display a menu bar or
* false
otherwise
* - (in) statusBar
true
if the Shell
* hosting the Browser
should display a status bar or
* false
otherwise
* - (in) toolBar
true
if the Shell
* hosting the Browser
should display a tool bar or
* false
otherwise
*
*
* @param event the WindowEvent
that specifies the
* Browser
that needs to be displayed
*
* @see org.eclipse.swt.widgets.Control#setLocation(org.eclipse.swt.graphics.Point)
* @see org.eclipse.swt.widgets.Control#setSize(org.eclipse.swt.graphics.Point)
* @see org.eclipse.swt.widgets.Shell#open()
*
* @since 3.0
*/
public void show(WindowEvent event);
}