net.rim.device.api.ui.extension.component
Class PictureScrollField.ScrollEntry

java.lang.Object
  extended by net.rim.device.api.ui.extension.component.PictureScrollField.ScrollEntry
Enclosing class:
PictureScrollField

public static class PictureScrollField.ScrollEntry
extends Object

An entry in the PictureScrollField. Allows an optional label and callout to be added to the image that will be displayed. Label text is displayed under the selected image. Callout text appears temporarily on top of the image upon selection.

Since:
BlackBerry API 5.0.0

Constructor Summary
PictureScrollField.ScrollEntry()
          Default constructor.
PictureScrollField.ScrollEntry(Bitmap picture, String label, String callout)
          Creates an entry in the PictureScrollField.
 
Method Summary
 String getCallout()
          Retrieves the callout text for this entry.
 String getLabel()
          Retrieves the label for this entry.
 Bitmap getPicture()
          Retrieves the picture for this ScrollEntry.
 void setCallout(String callout)
          Sets the callout text for this entry.
 void setLabel(String label)
          Sets the label for this entry.
 void setPicture(Bitmap picture)
          Sets the picture for this ScrollEntry.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

PictureScrollField.ScrollEntry

public PictureScrollField.ScrollEntry()
Default constructor.

Since:
BlackBerry API 5.0.0

PictureScrollField.ScrollEntry

public PictureScrollField.ScrollEntry(Bitmap picture,
                                      String label,
                                      String callout)
Creates an entry in the PictureScrollField.

Parameters:
picture - The picture to display.
label - The label for this picture.
callout - The optional callout for this picture. Specify null if you do not want a callout.
Since:
BlackBerry API 5.0.0


Method Detail

getPicture

public Bitmap getPicture()
Retrieves the picture for this ScrollEntry.

Returns:
The picture.
Since:
BlackBerry API 5.0.0

setPicture

public void setPicture(Bitmap picture)
Sets the picture for this ScrollEntry.

Parameters:
picture - The picture to display.
Since:
BlackBerry API 5.0.0

getLabel

public String getLabel()
Retrieves the label for this entry.

Returns:
The label text.
Since:
BlackBerry API 5.0.0

setLabel

public void setLabel(String label)
Sets the label for this entry. This text will appear below the image when it is selected.

Parameters:
label - The label text.
Since:
BlackBerry API 5.0.0

getCallout

public String getCallout()
Retrieves the callout text for this entry.

Returns:
The callout text.
Since:
BlackBerry API 5.0.0

setCallout

public void setCallout(String callout)
Sets the callout text for this entry. This text will appear temporarily as a tooltip over the image when it is selected.

Parameters:
callout - The callout text.
Since:
BlackBerry API 5.0.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.