The Windows and Tabs API
SafariBrowserTab classes, whose methods and properties allow you to work with windows and tabs.
Safari generates events:
When a window or tab is opened
Before a window or tab is closed
When a window or tab is activated
Before a window or tab is deactivated
Before a search is performed from the Smart Search Field
Before navigating to a new URL
After navigating to a new URL (when the main frame is loaded)
Navigation occurs whenever the user loads a new page in any manner—clicking a link in a tab or window, opening a bookmark, entering a URL in the address field, or typing a query in the web search field.
There is one instance of the
SafariApplication instance has a method for opening browser windows:
var myWin = safari.application.openBrowserWindow();
All open browser windows can be accessed as properties of the
safari.application.browserWindows is an array of all open windows, and
safari.application.activeBrowserWindow is the currently active browser window.
Each open browser window is an instance of the
SafariBrowserWindow class, which has methods to activate windows, close them, and determine if a window is visible onscreen. The
SafariBrowserWindow class also gives direct access to tabs.
browserWindow.tabs—returns an array of all the tabs in the window, in left-to-right order.
browserWindow.openTab()—creates a new tab at any point in the array. The tab can be hidden.
browserWindow.insertTab()—inserts an existing tab at any point in the array.
browserWindow.activeTab—returns the currently selected tab in the window.
A browser window is commonly accessed as a property of the Safari app instance:
SafariBrowserTab class allows you to identify a tab’s parent browser window, get and set the URL associated with a tab, make a tab active, close a tab, and extract a
data:// URL containing a snapshot image of what is rendered in the tab as a base-64 encoded PNG.
For example, this opens a window and returns the active tab:
var newTab = safari.application.openBrowserWindow().activeTab;
And this opens a new tab in the window containing the extension bar:
var newTab = safari.self.browserWindow.openTab();
You can listen for and respond to the following window and tab events:
Open—Safari sends an
"open"event to a window or tab when it is first opened.
Close—Safari sends a
"close"event to a window or tab when it is about to close.
Activate—Safari sends an
"activate"event to a window or tab whenever it is activated.
Deactivate—Safari sends a
"deactivate"event to a window or tab when it is about to be deactivated.
Before Navigate—Safari sends a
"beforeNavigate"event to a tab whenever a new URL is about to load there. You can prevent Safari from loading the URL by calling
preventDefault()on the event. The event has a
urlproperty that you can inspect to see where the navigation event leads.
Navigate—Safari sends a
"navigate"event to a tab when the main frame of the new URL has loaded.
Before Search—Safari sends a
"beforeSearch"event to a tab whenever Safari is about to start a search and show the results in that tab. You can intercept the query and execute an alternate task.
You can listen for these events on the
application object from an extension bar or your global HTML page. You can also listen on a specific window or tab in the app.