ObjectParamList (BlackBerry JDE 6.0.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.browser.field
Class ObjectParamList

java.lang.Object
  net.rim.device.api.browser.field.ObjectParamList

public final class ObjectParamList
extends Object
extends Object

A container class to hold the values from the HTML param elements nested inside an HTML object element. This container provides a static view of the param elements, and is not updated by the rendering engine after creation.

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 Summary
	`String`	`getParamName(int index)` Get the content of the `name` attribute of the `index`'th `param` element stored in the container.
	`String`	`getParamType(int index)` Get the content of the `type` attribute of the `index`'th `param` element stored in the container.
	`String`	`getParamValue(int index)` Get the content of the `value` attribute of the `index`'th `param` element stored in the container.
	`String`	`getParamValueType(int index)` Get the content of the `valueType` attribute of the `index`'th `param` element stored in the container.
	`int`	`size()` Get the number of parameters stored in this container.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

size

public int size()

Get the number of parameters stored in this container.

Returns:: The number of parameters stored in this container.
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

getParamName

public String getParamName(int index)
                    throws IllegalArgumentException

Get the content of the name attribute of the index'th param element stored in the container.

Parameters:: index - The index of the param element. This must be in the range 0 <= index < size().
Returns:: The content of the name attribute of the requested param element. This will not be null.
Throws:: IllegalArgumentException - If an index outside the allowed range is provided.
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

getParamValue

public String getParamValue(int index)
                     throws IllegalArgumentException

Get the content of the value attribute of the index'th param element stored in the container.

Parameters:: index - The index of the param element. This must be in the range 0 <= index < size().
Returns:: The content of the value attribute of the requested param element. This will not be null.
Throws:: IllegalArgumentException - If an index outside the allowed range is provided.
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

getParamValueType

public String getParamValueType(int index)
                         throws IllegalArgumentException

Get the content of the valueType attribute of the index'th param element stored in the container.

Parameters:: index - The index of the param element. This must be in the range 0 <= index < size().
Returns:: The content of the valueType attribute of the requested param element. This will not be null.
Throws:: IllegalArgumentException - If an index outside the allowed range is provided.
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

getParamType

public String getParamType(int index)
                    throws IllegalArgumentException

Get the content of the type attribute of the index'th param element stored in the container.

Parameters:: index - The index of the param element. This must be in the range 0 <= index < size().
Returns:: The content of the type attribute of the requested param element. This will not be null.
Throws:: IllegalArgumentException - If an index outside the allowed range is provided.
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