+Show TOC
×Hide TOC

LocationUtil

Kind of class:	public class
Package:	org.casalib.util
Inherits from:	none
Version:	03/03/08
Author:	Aaron Clinger
Classpath:	org.casalib.util.LocationUtil
File last modified:	Thursday, 19 February 2009, 11:33:37

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2009, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/
package org.casalib.util {
    import flash.display.DisplayObject;
    import flash.system.Capabilities;
    
    /**
        Utilities for determining the location of the SWF and the type of runtime environment.
        
        @author Aaron Clinger
        @version 03/03/08
    */
    public class LocationUtil {
        
        
        /**
            Determines if the SWF is being served on the internet.
            
            @param location: DisplayObject to get location of.
            @return Returns <code>true</code> if SWF is being served on the internet; otherwise <code>false</code>.
            @usage
                <code>
                    trace(LocationUtil.isWeb(_root));
                </code>
        */
        public static function isWeb(location:DisplayObject):Boolean {
            return location.loaderInfo.url.substr(0, 4) == 'http';
        }
        
        /**
            Detects if MovieClip's embed location matches passed domain.
            
            @param location: MovieClip to compare location of.
            @param domain: Web domain.
            @return Returns <code>true</code> if file's embed location matched passed domain; otherwise <code>false</code>.
            @usage
                To check for domain:
                <code>
                    trace(LocationUtil.isDomain(_root, "google.com"));
                    trace(LocationUtil.isDomain(_root, "bbc.co.uk"));
                </code>
                
                You can even check for subdomains:
                <code>
                    trace(LocationUtil.isDomain(_root, "subdomain.aaronclinger.com"))
                </code>
        */
        public static function isDomain(location:DisplayObject, domain:String):Boolean {
            return LocationUtil.getDomain(location).slice(-domain.length) == domain;
        }
        
        /**
            Detects MovieClip's domain location.
            
            @param location: MovieClip to get location of.
            @return Returns full domain (including sub-domains) of MovieClip's location.
            @usage
                <code>
                    trace(LocationUtil.getDomain(_root));
                </code>
            @usageNote Function does not return folder path or file name. The method also treats "www" and sans "www" as the same; if "www" is present method does not return it.
        */
        public static function getDomain(location:DisplayObject):String {
            var baseUrl:String = location.loaderInfo.url.split('://')[1].split('/')[0];
            return (baseUrl.substr(0, 4) == 'www.') ? baseUrl.substr(4) : baseUrl;
        }
        
        /**
            Determines if the SWF is running in a browser plug-in.
            
            @return Returns <code>true</code> if SWF is running in the Flash Player browser plug-in; otherwise <code>false</code>.
        */
        public static function isPlugin():Boolean {
            return Capabilities.playerType == 'PlugIn' || Capabilities.playerType == 'ActiveX';
        }
        
        /**
            Determines if the SWF is running in the IDE.
            
            @return Returns <code>true</code> if SWF is running in the Flash Player version used by the external player or test movie mode; otherwise <code>false</code>.
        */
        public static function isIde():Boolean {
            return Capabilities.playerType == 'External';
        }
        
        /**
            Determines if the SWF is running in the StandAlone player.
            
            @return Returns <code>true</code> if SWF is running in the Flash StandAlone Player; otherwise <code>false</code>.
        */
        public static function isStandAlone():Boolean {
            return Capabilities.playerType == 'StandAlone';
        }
        
        /**
            Determines if the runtime environment is an Air application.
            
            @return Returns <code>true</code> if the runtime environment is an Air application; otherwise <code>false</code>.
        */
        public static function isAirApplication():Boolean {
            return Capabilities.playerType == 'Desktop';
        }
    }
}

Utilities for determining the location of the SWF and the type of runtime environment.

Summary

Class methods

isWeb (location:DisplayObject) : Boolean
- Determines if the SWF is being served on the internet.
isDomain (location:DisplayObject, domain:String) : Boolean
- Detects if MovieClip's embed location matches passed domain.
getDomain (location:DisplayObject) : String
- Detects MovieClip's domain location.
isPlugin : Boolean
- Determines if the SWF is running in a browser plug-in.
isIde : Boolean
- Determines if the SWF is running in the IDE.
isStandAlone : Boolean
- Determines if the SWF is running in the StandAlone player.
isAirApplication : Boolean
- Determines if the runtime environment is an Air application.

Class methods

getDomain

public static function getDomain (

location:DisplayObject) : String

Detects MovieClip's domain location.

Parameters:

location:

MovieClip to get location of.

Returns:

Returns full domain (including sub-domains) of MovieClip's location.

Usage:

```
trace(LocationUtil.getDomain(_root));
```

Usage note:

Function does not return folder path or file name. The method also treats "www" and sans "www" as the same; if "www" is present method does not return it.

isAirApplication

public static function isAirApplication (

) : Boolean

Determines if the runtime environment is an Air application.

Returns:

Returns true if the runtime environment is an Air application; otherwise false.

isDomain

public static function isDomain (

location:DisplayObject, domain:String) : Boolean

Detects if MovieClip's embed location matches passed domain.

Parameters:

location:

MovieClip to compare location of.

domain :

Web domain.

Returns:

Returns true if file's embed location matched passed domain; otherwise false.

Usage:

To check for domain:

trace(LocationUtil.isDomain(_root, "google.com"));
trace(LocationUtil.isDomain(_root, "bbc.co.uk"));

You can even check for subdomains:

trace(LocationUtil.isDomain(_root, "subdomain.aaronclinger.com"))

isIde

public static function isIde (

) : Boolean

Determines if the SWF is running in the IDE.

Returns:

Returns true if SWF is running in the Flash Player version used by the external player or test movie mode; otherwise false.

isPlugin

public static function isPlugin (

) : Boolean

Determines if the SWF is running in a browser plug-in.

Returns:

Returns true if SWF is running in the Flash Player browser plug-in; otherwise false.

isStandAlone

public static function isStandAlone (

) : Boolean

Determines if the SWF is running in the StandAlone player.

Returns:

Returns true if SWF is running in the Flash StandAlone Player; otherwise false.

isWeb

public static function isWeb (

location:DisplayObject) : Boolean

Determines if the SWF is being served on the internet.

Parameters:

location:

DisplayObject to get location of.

Returns:

Returns true if SWF is being served on the internet; otherwise false.

Usage:

```
trace(LocationUtil.isWeb(_root));
```