er.extensions.appserver
Class ERXBrowser

java.lang.Object
  er.extensions.appserver.ERXBrowser

All Implemented Interfaces:

com.webobjects.foundation.NSKeyValueCoding

Direct Known Subclasses:

ERXBasicBrowser

public abstract class ERXBrowser
extends java.lang.Object
implements com.webobjects.foundation.NSKeyValueCoding

ERXBrowser is an abstract class that defines browser object. A browser object represents the web browser that the current request-response loop is dealing with. It holds the information retrieved from HTTP request's "user-agent" header, and such information includes web browser's name, version, Mozilla compatible version and platform (OS). Also, a browser object can answer boolean questions such as isIE, isOmniWeb, isVersion5 and isMozilla40Compatible.
ERXBrowser is immutable and shared by different sessions and direct actions. The shared instances are managed by ERXBrowserFactory which is also responsible to parse "user-agent" header in a WORequest object and to get an appropriate browser object.
One concrete browser, ERXBasicBrowser, is defined in the ERExtensions framework. It not only implements the basic questions defined by ERXBrowser, but also more specific questions like isIFrameSupported and willRenderNestedTablesFast.
You can extend ERXBrowser or its concrete subclass ERXBasicBrowser to implement more specific questions for your application. One good example will be to have a question isSupportedBrowser that checks if the client is using one of the supported browsers for your application.
ERXSession holds a browser object that represent the web browser for that session and browser method returns the object. To access ERXBrowser's boolean questions from WOConditionals on a web component, set the key path like "session.brower.isIFrameSupported" to their condition bindings.
ERXDirectAction also holds a browser object for the current request. Use its browser method to access the object from a session-less direct action.

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.DefaultImplementation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.Null, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.Utility, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Field Summary

static java.lang.String	CHROME
static java.lang.String	FIREFOX
static java.lang.String	ICAB
static java.lang.String	IE
static java.lang.String	IPHONE
static java.lang.String	LINUX
static java.lang.String	MACOS
static java.lang.String	MOZILLA
static java.lang.String	NETSCAPE
static java.lang.String	NO_GECKO
static java.lang.String	OMNIWEB
static java.lang.String	OPERA
static java.lang.String	POWER_PC
static java.lang.String	ROBOT
static java.lang.String	SAFARI
static java.lang.String	UNKNOWN_BROWSER
static java.lang.String	UNKNOWN_CPU
static java.lang.String	UNKNOWN_PLATFORM
static java.lang.String	UNKNOWN_VERSION
static java.lang.String	WINDOWS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

_CLASS, NullValue

Constructor Summary

ERXBrowser()

Method Summary

abstract java.lang.String	browserName() Browser name string
java.lang.String	formValueEncoding() If using ERXRequest objects allows one to override on a per browser basis what form value encoding to use.
abstract java.lang.String	geckoRevision() The revision of the gecko rendering engine.
abstract boolean	isChrome() Browser is Chrome?
abstract boolean	isFirefox() Browser is Firefox?
abstract boolean	isICab() Browser is iCab?
abstract boolean	isIE() Browser is Ineternet Explorer?
abstract boolean	isIPhone()
abstract boolean	isLinux()
abstract boolean	isMacOS()
abstract boolean	isMozilla40Compatible()
abstract boolean	isMozilla45Compatible()
abstract boolean	isMozilla50Compatible()
abstract boolean	isNetscape() Browser is Netscape?
abstract boolean	isNotNetscape() Browser is not Netscape?
abstract boolean	isOmniWeb() Browser is OmniWeb?
abstract boolean	isOpera() Browser is Opera?
abstract boolean	isRobot() Browser is isRobot?
abstract boolean	isSafari() Browser is Safari?
abstract boolean	isUnknownBrowser()
abstract boolean	isUnknownPlatform()
abstract boolean	isVersion2()
abstract boolean	isVersion3()
abstract boolean	isVersion4()
abstract boolean	isVersion40()
abstract boolean	isVersion41()
abstract boolean	isVersion45()
abstract boolean	isVersion5()
abstract boolean	isVersion51()
abstract boolean	isVersion6()
abstract boolean	isVersion7()
abstract boolean	isVersion8()
abstract boolean	isVersion9()
abstract boolean	isWindows()
ERXMessageEncoding	messageEncodingForLanguage(java.lang.String language) Gets the message encoding for a given language.
ERXMessageEncoding	messageEncodingForLanguages(com.webobjects.foundation.NSArray languages) Gets the message encoding for a given array of languages.
ERXMessageEncoding	messageEncodingForRequest(com.webobjects.appserver.WORequest request) Gets the message encoding for a given request.
abstract java.lang.String	mozillaVersion() MozillaVersion string
abstract java.lang.String	platform() Platform string
void	takeValueForKey(java.lang.Object value, java.lang.String key)
java.lang.String	toString()
abstract com.webobjects.foundation.NSDictionary	userInfo() UserInfo dictionary
java.lang.Object	valueForKey(java.lang.String key)
abstract java.lang.String	version() Version string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN_BROWSER

public static final java.lang.String UNKNOWN_BROWSER

See Also:

Constant Field Values

ROBOT

public static final java.lang.String ROBOT

See Also:

Constant Field Values

ICAB

public static final java.lang.String ICAB

See Also:

Constant Field Values

IE

public static final java.lang.String IE

See Also:

Constant Field Values

NETSCAPE

public static final java.lang.String NETSCAPE

See Also:

Constant Field Values

OMNIWEB

public static final java.lang.String OMNIWEB

See Also:

Constant Field Values

OPERA

public static final java.lang.String OPERA

See Also:

Constant Field Values

SAFARI

public static final java.lang.String SAFARI

See Also:

Constant Field Values

MOZILLA

public static final java.lang.String MOZILLA

See Also:

Constant Field Values

CHROME

public static final java.lang.String CHROME

See Also:

Constant Field Values

FIREFOX

public static final java.lang.String FIREFOX

See Also:

Constant Field Values

UNKNOWN_VERSION

public static final java.lang.String UNKNOWN_VERSION

See Also:

Constant Field Values

UNKNOWN_PLATFORM

public static final java.lang.String UNKNOWN_PLATFORM

See Also:

Constant Field Values

MACOS

public static final java.lang.String MACOS

See Also:

Constant Field Values

WINDOWS

public static final java.lang.String WINDOWS

See Also:

Constant Field Values

LINUX

public static final java.lang.String LINUX

See Also:

Constant Field Values

IPHONE

public static final java.lang.String IPHONE

See Also:

Constant Field Values

POWER_PC

public static final java.lang.String POWER_PC

See Also:

Constant Field Values

UNKNOWN_CPU

public static final java.lang.String UNKNOWN_CPU

See Also:

Constant Field Values

NO_GECKO

public static final java.lang.String NO_GECKO

See Also:

Constant Field Values

Constructor Detail

ERXBrowser

public ERXBrowser()

Method Detail

browserName

public abstract java.lang.String browserName()

Browser name string

Returns:

what type of browser

version

public abstract java.lang.String version()

Version string

Returns:

what version of browser

mozillaVersion

public abstract java.lang.String mozillaVersion()

MozillaVersion string

Returns:

what Mozilla version equivement to the browser's version

geckoRevision

public abstract java.lang.String geckoRevision()

The revision of the gecko rendering engine. 1.0.2 and up support xslt.

Returns:

what gecko revision equivement to the browser's version

platform

public abstract java.lang.String platform()

Platform string

Returns:

what platform that the browser is running on

userInfo

public abstract com.webobjects.foundation.NSDictionary userInfo()

UserInfo dictionary

Returns:

what type of browser

isUnknownBrowser

public abstract boolean isUnknownBrowser()

isRobot

public abstract boolean isRobot()

Browser is isRobot?

Returns:

true if browser is robot.

isICab

public abstract boolean isICab()

Browser is iCab?

Returns:

true if browser is iCab.

isIE

public abstract boolean isIE()

Browser is Ineternet Explorer?

Returns:

true if browser is IE.

isNetscape

public abstract boolean isNetscape()

Browser is Netscape?

Returns:

true if browser is Netscape.

isNotNetscape

public abstract boolean isNotNetscape()

Browser is not Netscape?

Returns:

true if browser is not Netscape.

isOmniWeb

public abstract boolean isOmniWeb()

Browser is OmniWeb?

Returns:

true if browser is OmniWeb.

isOpera

public abstract boolean isOpera()

Browser is Opera?

Returns:

true if browser is Opera.

isSafari

public abstract boolean isSafari()

Browser is Safari?

Returns:

true if browser is Safari.

isFirefox

public abstract boolean isFirefox()

Browser is Firefox?

Returns:

true if browser is Firefox.

isChrome

public abstract boolean isChrome()

Browser is Chrome?

Returns:

true if browser is Chrome.

isMozilla50Compatible

public abstract boolean isMozilla50Compatible()

isMozilla45Compatible

public abstract boolean isMozilla45Compatible()

isMozilla40Compatible

public abstract boolean isMozilla40Compatible()

isVersion9

public abstract boolean isVersion9()

isVersion8

public abstract boolean isVersion8()

isVersion7

public abstract boolean isVersion7()

isVersion6

public abstract boolean isVersion6()

isVersion5

public abstract boolean isVersion5()

isVersion51

public abstract boolean isVersion51()

isVersion45

public abstract boolean isVersion45()

isVersion41

public abstract boolean isVersion41()

isVersion40

public abstract boolean isVersion40()

isVersion4

public abstract boolean isVersion4()

isVersion3

public abstract boolean isVersion3()

isVersion2

public abstract boolean isVersion2()

isUnknownPlatform

public abstract boolean isUnknownPlatform()

isMacOS

public abstract boolean isMacOS()

isWindows

public abstract boolean isWindows()

isLinux

public abstract boolean isLinux()

isIPhone

public abstract boolean isIPhone()

messageEncodingForRequest

public ERXMessageEncoding messageEncodingForRequest(com.webobjects.appserver.WORequest request)

Gets the message encoding for a given request. Default implementation gets the message encoding for all of the browserLanguages off of the request.

Parameters:

request - to get the message encoding for

Returns:

message encoding

messageEncodingForLanguages

public ERXMessageEncoding messageEncodingForLanguages(com.webobjects.foundation.NSArray languages)

Gets the message encoding for a given array of languages.

Parameters:

languages - array to get the correct encoding for

Returns:

message encoding

messageEncodingForLanguage

public ERXMessageEncoding messageEncodingForLanguage(java.lang.String language)

Gets the message encoding for a given language.

Parameters:

language - to get the encoding for

Returns:

message encoding

formValueEncoding

public java.lang.String formValueEncoding()

If using ERXRequest objects allows one to override on a per browser basis what form value encoding to use. Default implementation defaults to null Note that you will need to enable the property: er.extensions.ERXRequest.BrowserFormValueEncodingOverrideEnabled=true in order for the actual over ride to happen.

Returns:

form value encoding to use for this particular user-agent.

valueForKey

public java.lang.Object valueForKey(java.lang.String key)

Specified by:

valueForKey in interface com.webobjects.foundation.NSKeyValueCoding

takeValueForKey

public void takeValueForKey(java.lang.Object value,
                            java.lang.String key)

Specified by:

takeValueForKey in interface com.webobjects.foundation.NSKeyValueCoding

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object