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

java.lang.Object
  extended by net.rim.device.api.browser.field.Event
      extended by net.rim.device.api.browser.field.ContentReadEvent

public final class ContentReadEvent
extends Event

Event indicating the progress of loading the content.

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 4.2.0

Field Summary
 
Fields inherited from class net.rim.device.api.browser.field.Event
EVENT_BROWSER_CONTENT_CHANGED, EVENT_CANCEL_REQUEST_RESOURCE, EVENT_CLOSE, EVENT_ERROR_DISPLAY, EVENT_EXECUTING_SCRIPT, EVENT_FULL_WINDOW, EVENT_HISTORY, EVENT_REDIRECT, EVENT_SET_HEADER, EVENT_SET_HTTP_COOKIE, EVENT_STOP, EVENT_TICK_CONTENT_READ, EVENT_UI_DIRECTION_REQUEST, EVENT_URL_REQUESTED, PUBLIC_EVENT_THRESHOLD
 
Constructor Summary
Category: Signed ContentReadEvent(Object src)
          Creates a new event for indicating the progress of loading.
 
Method Summary
Category: Signed  int getItemsRead()
          Returns the items read so far.
Category: Signed  int getItemsToRead()
          Returns the expected number of items to be read.
Category: Signed  boolean getItemsToReadInBytes()
          Gets whether the items to read are in bytes.
Category: Signed  void setItemsRead(int amountRead)
          Sets the items read so far.
Category: Signed  void setItemsToRead(int amountToRead)
          Sets the number of items expected to be read.
Category: Signed  void setItemsToReadInBytes(boolean value)
          Sets whether the items to read are in bytes.
 
Methods inherited from class net.rim.device.api.browser.field.Event
getSource, getSourceURL, getUID, resolveUrl
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

ContentReadEvent

public ContentReadEvent(Object src)
Creates a new event for indicating the progress of loading.

Parameters:
src - Source that triggered this event (typically a BrowserContent object or an HttpConnection).
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 4.2.0


Method Detail

getItemsRead

public int getItemsRead()
Returns the items read so far.

Returns:
Exact number items read so far.
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 4.2.0

setItemsRead

public void setItemsRead(int amountRead)
Sets the items read so far.

Parameters:
amountRead - The value to be set.
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 4.2.0

getItemsToRead

public int getItemsToRead()
Returns the expected number of items to be read.

Returns:
Number of bytes to read.
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 4.2.0

setItemsToRead

public void setItemsToRead(int amountToRead)
Sets the number of items expected to be read.

Parameters:
amountToRead - The value to be set.
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 4.2.0

setItemsToReadInBytes

public void setItemsToReadInBytes(boolean value)
Sets whether the items to read are in bytes.

Parameters:
value - If items to read is in bytes.
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 4.2.0

getItemsToReadInBytes

public boolean getItemsToReadInBytes()
Gets whether the items to read are in bytes.

Returns:
If items are in bytes.
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 4.2.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.