net.rim.device.api.web
Class WidgetAccess

java.lang.Object
  net.rim.device.api.web.WidgetAccess

public class WidgetAccess
extends Object

The WidgetAccess class represents the information stored in the access tags of a Widget's config.xml file.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Constructor Summary
	WidgetAccess(String uri, boolean allowSubDomain, WidgetFeature[] features) The constructor will create a WidgetAccess object with the informaiton passed in.

Method Summary
	boolean	allowSubDomain() Returns true if this access tag applies to sub domains of the URI; false otherwise.
	WidgetFeature[]	getFeatures() Retrieves an array of the features that can be used by the URI.
	URI	getURI() Returns the URI.
	boolean	isLocal() Returns true if this WidgetAccess object represents the global local domain.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WidgetAccess

public WidgetAccess(String uri,
                    boolean allowSubDomain,
                    WidgetFeature[] features)
             throws MalformedURIException

The constructor will create a WidgetAccess object with the informaiton passed in.

Throws:

MalformedURIException

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Method Detail

getURI

public URI getURI()

Returns the URI.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

allowSubDomain

public boolean allowSubDomain()

Returns true if this access tag applies to sub domains of the URI; false otherwise.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

getFeatures

public WidgetFeature[] getFeatures()

Retrieves an array of the features that can be used by the URI.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

isLocal

public boolean isLocal()

Returns true if this WidgetAccess object represents the global local domain.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0