Next Previous

ConfigurePrefsReminder.safariextension/global.html

<!--

    File: global.html

Abstract: Global page HTML file.

 Version: 1.0

Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple

Inc. ("Apple") in consideration of your agreement to the following

terms, and your use, installation, modification or redistribution of

this Apple software constitutes acceptance of these terms.  If you do

not agree with these terms, please do not use, install, modify or

redistribute this Apple software.

In consideration of your agreement to abide by the following terms, and

subject to these terms, Apple grants you a personal, non-exclusive

license, under Apple's copyrights in this original Apple software (the

"Apple Software"), to use, reproduce, modify and redistribute the Apple

Software, with or without modifications, in source and/or binary forms;

provided that if you redistribute the Apple Software in its entirety and

without modifications, you must retain this notice and the following

text and disclaimers in all such redistributions of the Apple Software.

Neither the name, trademarks, service marks or logos of Apple Inc. may

be used to endorse or promote products derived from the Apple Software

without specific prior written permission from Apple.  Except as

expressly stated in this notice, no other rights or licenses, express or

implied, are granted by Apple herein, including but not limited to any

patent rights that may be infringed by your derivative works or by other

works in which the Apple Software may be incorporated.

The Apple Software is provided by Apple on an "AS IS" basis.  APPLE

MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION

THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS

FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND

OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL

OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,

MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED

AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),

STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

Copyright (C) 2011 Apple Inc. All Rights Reserved.

-->

<!DOCTYPE HTML>

<script>

var reminderPopover;

safari.application.addEventListener("command", commandHandler, false);

safari.extension.settings.addEventListener("change", settingsChangeHandler, false);

function commandHandler(event)

    if (event.command !== "doSomething")

        return;

    var favoriteColor = safari.extension.settings.favoriteColor;

    if (favoriteColor && favoriteColor.length > 0) {

        alert(favoriteColor + " is my favorite color too! (this is where we do stuff now that the user has populated the preferences).");

        return;

    // The user still hasn't configured their preferences. Let them know that this Extension will

    // not work until they do.

    showReminderPopover(event.target);

function settingsChangeHandler(event)

    // Once the user has actually configured their settings, remove the popover.

    if (event.key === "favoriteColor" && event.newValue.length > 0 && reminderPopover) {

        // A popover that is currently showing cannot be removed, so hide the popover before

        // removing it.

        reminderPopover.hide();

        safari.extension.removePopover("reminderPopover");

        reminderPopover = null;

// The Global Page is being loaded, which means that the Extension is being

// installed or that Safari is being launched.

var favoriteColor = safari.extension.settings.favoriteColor;

var userSetPreferences = favoriteColor && favoriteColor.length > 0;

if (!userSetPreferences && safari.extension.settings.doNotShowReminder === "true") {

    // If the user has already said not to show the reminder, then don't pop it up unless the user

    // attempts to use the Extension by doing something like clicking on the toolbar item.

    var toolbarItem = findActiveWindowToolbarItem();

    // The user might have removed the toolbar item.

    if (toolbarItem)

        toolbarItem.popover = createReminderPopoverIfNecessary();

} else if (!userSetPreferences)

    showReminderPopover(findActiveWindowToolbarItem());

function findActiveWindowToolbarItem()

    // Find the toolbar item for the window that is currently being shown to the user.

    var toolbarItemCurrentlyShowing;

    var toolbarItems = safari.extension.toolbarItems;

    for (var i = 0; i < toolbarItems.length; ++i) {

        if (toolbarItems[i].browserWindow === safari.application.activeBrowserWindow)

            return toolbarItems[i];

    return null;

function createReminderPopoverIfNecessary()

    if (!reminderPopover)

        reminderPopover = safari.extension.createPopover("reminderPopover", safari.extension.baseURI + "popover.html", 200, 300);

    return reminderPopover;

function showReminderPopover(toolbarItem)

    if (!toolbarItem)

        return;

    // Associate the popover with the toolbar item.

    toolbarItem.popover = createReminderPopoverIfNecessary();

    // Tell the toolbar item to show the popover.

    toolbarItem.showPopover();

function doNotShowReminderAgain()

    // Do not show the reminder the next time Safari is launched.

    safari.extension.settings.doNotShowReminder = "true";

    // Hide the popover, but leave it on the toolbar item so that it gets shown when the user clicks

    // on the toolbar item and reminds them that their Extension won't work until it is properly

    // configured.

    reminderPopover.hide();

</script>

Next Previous