net.rim.blackberry.api.phone.phonegui
Class PhoneScreenVerticalManager

java.lang.Object
  net.rim.device.api.ui.Field
      net.rim.device.api.ui.ScrollView
          net.rim.device.api.ui.Manager
              net.rim.device.api.ui.container.VerticalFieldManager
                  net.rim.blackberry.api.phone.phonegui.PhoneScreenVerticalManager

All Implemented Interfaces:

AdjustmentListener

public class PhoneScreenVerticalManager
extends VerticalFieldManager

Manager used to organize data vertically onto the phone screen. For more information, see the package overview.

See Also:

ScreenModel, PhoneScreen, PhoneScreenHorizontalManager

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

Field Summary

Fields inherited from class net.rim.device.api.ui.Manager

BOTTOMMOST, DOWNWARD, HORIZONTAL_SCROLL, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_MASK, HORIZONTAL_SCROLL_MASK, LEAVE_BLANK_SPACE, LEFTMOST, LEFTWARD, NO_HORIZONTAL_SCROLL, NO_HORIZONTAL_SCROLLBAR, NO_SCROLL_RESET, NO_VERTICAL_SCROLL, NO_VERTICAL_SCROLLBAR, QUANTA_FONT, RIGHTMOST, RIGHTWARD, TOPMOST, UPWARD, VERTICAL_SCROLL, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_MASK, VERTICAL_SCROLL_MASK

Fields inherited from class net.rim.device.api.ui.Field

ACTION_INVOKE, AXIS_HORIZONTAL, AXIS_SEQUENTIAL, AXIS_VERTICAL, EDITABLE, EDITABLE_MASK, FIELD_BOTTOM, FIELD_HALIGN_MASK, FIELD_HCENTER, FIELD_LEADING, FIELD_LEFT, FIELD_RIGHT, FIELD_TOP, FIELD_TRAILING, FIELD_VALIGN_MASK, FIELD_VCENTER, FOCUSABLE, FOCUSABLE_MASK, HIGHLIGHT_FOCUS, HIGHLIGHT_SELECT, NON_FOCUSABLE, NON_SPELLCHECKABLE, READONLY, SPELLCHECKABLE, SPELLCHECKABLE_MASK, STATUS_MOVE_FOCUS_HORIZONTALLY, STATUS_MOVE_FOCUS_VERTICALLY, USE_ALL_HEIGHT, USE_ALL_WIDTH, VISUAL_STATE_ACTIVE, VISUAL_STATE_DISABLED, VISUAL_STATE_DISABLED_FOCUS, VISUAL_STATE_FOCUS, VISUAL_STATE_NORMAL

Constructor Summary
	PhoneScreenVerticalManager() Constructor to create a PhoneScreenVerticalManager instance.

Method Summary
	void	add(Field field) Add a field object.
	int	addImage(Bitmap bitmap) Add a bitmap object to the field.
	int	addImage(EncodedImage image) Add an encoded image to the field.
	void	delete(Field field) Delete a field object.
	void	deleteRange(int start, int count) Delete a range of field objects.
	Field	getField(int index) Retrieve the field from an index.
	int	getFieldCount() Retrieves the number of fields.
	void	insert(Field field, int index) Insert a field object at a specified index.
	void	replace(Field oldField, Field newField) Replace a field object.
	void	setPadding(int top, int right, int bottom, int left) Set the padding.
	void	setPadding(XYEdges padding) Set the padding.

Methods inherited from class net.rim.device.api.ui.container.VerticalFieldManager

getFieldAtLocation, getPreferredHeight, getPreferredWidth, nextFocus, sublayout, subpaint

Methods inherited from class net.rim.device.api.ui.Manager

addAll, deleteAll, getAccessibleContext, getFieldWithFocus, getFieldWithFocusIndex, getFocusRect, getHorizontalScroll, getLeafFieldWithFocus, getPreferredHeightOfChild, getPreferredWidthOfChild, getVerticalScroll, getVirtualHeight, getVirtualWidth, insertAll, invalidate, invalidate, invalidateFieldRange, invokeAction, isDataValid, isDirty, isDownArrowShown, isFocusable, isMuddy, isSelecting, isUpArrowShown, isValidLayout, keyChar, keyControl, keyDown, keyRepeat, keyStatus, keyUp, layout, layoutChild, makeMenu, moveFocus, moveFocus, navigationClick, navigationMovement, navigationUnclick, nextFocus, onFocus, onUnfocus, paint, paintChild, setDirty, setFocus, setHorizontalQuantization, setPositionChild, setScrollingInertial, setVerticalQuantization, setVirtualExtent, touchEvent, trackwheelClick, trackwheelUnclick

Methods inherited from class net.rim.device.api.ui.ScrollView

configurationChanged, getHorizontalAdjustment, getVerticalAdjustment, getVisibleHeight, getVisibleWidth, onDisplay, onUndisplay, setCurrentLocation, setExtent, setHorizontalAdjustment, setHorizontalScroll, setHorizontalScroll, setScrollListener, setVerticalAdjustment, setVerticalScroll, setVerticalScroll, valueChanged, waitForScrolling

Methods inherited from class net.rim.device.api.ui.Field

drawFocus, drawHighlightRegion, fieldChangeNotify, focusAdd, focusRemove, getBackground, getBackground, getBorder, getBorder, getBorder, getChangeListener, getCommandItemProvider, getContentHeight, getContentLeft, getContentRect, getContentRect, getContentTop, getContentWidth, getContextMenu, getCookie, getExtent, getExtent, getFieldStyle, getFocusListener, getFont, getHeight, getIndex, getLeft, getManager, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getOriginal, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getScreen, getStyle, getTop, getVisualState, getWidth, invalidateAll, isEditable, isEnabled, isFocus, isPasteable, isScrollCopyable, isSelectable, isSelectionCopyable, isSelectionCutable, isSelectionDeleteable, isSpellCheckable, isStyle, isVisible, makeContextMenu, onExposed, onMenuDismissed, onMenuDismissed, onObscured, onVisibilityChange, paste, select, selectionCopy, selectionCut, selectionDelete, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCommandItemProvider, setCookie, setEditable, setEnabled, setFocus, setFocusListener, setFont, setMargin, setMargin, setMuddy, setNonSpellCheckable, setPosition, setVisualState, updateLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneScreenVerticalManager

public PhoneScreenVerticalManager()

Constructor to create a PhoneScreenVerticalManager instance.

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

setPadding

public void setPadding(int top,
                       int right,
                       int bottom,
                       int left)

Set the padding.

Overrides:

setPadding in class Field

Parameters:

top - Top-most padding coordinate.

right - Right-most padding coordinate.

bottom - Bottom-most padding coordinate.

left - Left-most padding coordinate.

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

setPadding

public void setPadding(XYEdges padding)

Set the padding.

Overrides:

setPadding in class Field

Parameters:

padding - Padding coordinates.

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

addImage

public int addImage(EncodedImage image)

Add an encoded image to the field.

Parameters:

image - The encoded image to be added.

Returns:

int index of the image in this manager.

Throws:

NullPointerException - if image is null.

RuntimeException - if the number of field exceeds the maximum limit. and/or the device doesn't support the phone screen display feature.

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

addImage

public int addImage(Bitmap bitmap)

Add a bitmap object to the field.

Parameters:

bitmap - The bitmap object to be added.

Returns:

int index of the image in this manager.

Throws:

NullPointerException - if bitmap is null.

RuntimeException - if the number of field exceeds the maximum limit. and/or the device doesn't support the phone screen display feature.

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

add

public void add(Field field)

Add a field object.

Overrides:

add in class Manager

Parameters:

field - The field object to be added.

Throws:

NullPointerException - if the field is null.

IllegalArgumentException - if the field already has a manager or it is an instance of Screen.

RuntimeException - if the number of field exceeds the maximum limit. and/or the device doesn't support the phone screen display feature.

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

deleteRange

public void deleteRange(int start,
                        int count)

Delete a range of field objects.

Overrides:

deleteRange in class Manager

Parameters:

start - The start index.

count - The number of field objects to be deleted.

Throws:

RuntimeException - if Manager is empty and/or the device doesn't support the phone screen display feature.

IndexOutOfBoundsException - if the start index does not fall into valid range or the range to be deleted exceeds the valid boundary.

IllegalArgumentException - if the the count argument is less than 1.

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

delete

public void delete(Field field)

Delete a field object.

Overrides:

delete in class Manager

Parameters:

field - The field object to be deleted.

Throws:

NullPointerException - if the field is null.

IllegalArgumentException - if the field does not have a manager or the field's manager is not the current manager instance.

RuntimeException - if the device doesn't support the phone screen display feature.

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

replace

public void replace(Field oldField,
                    Field newField)

Replace a field object.

Overrides:

replace in class Manager

Parameters:

oldField - The field object to be replaced.

newField - The new field object to be added.

Throws:

NullPointerException - if the old/newField is null.

IllegalArgumentException - if the new field already has a manager, the old field does not have a manager or the old field's manager is not the current manager instance, or any of the fields are an instance of Screen.

RuntimeException - if the device doesn't support the phone screen display feature.

See Also:

Manager.delete(Field), Manager.insert(Field, int), Field.getIndex(), Field.getManager(), Field.setFocus()

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

insert

public void insert(Field field,
                   int index)

Insert a field object at a specified index.

Overrides:

insert in class Manager

Parameters:

field - The field object to be inserted.

index - The index where the field object is to be inserted.

Throws:

NullPointerException - if the field is null.

RuntimeException - if the device doesn't support the phone screen display feature.

IllegalArgumentException - if the field already has a manager or it is an instance of Screen.

IndexOutOfBoundsException - if index is not in the valid range.

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

getField

public Field getField(int index)

Retrieve the field from an index.

Overrides:

getField in class Manager

Parameters:

index - Index of the field.

Returns:

Field Field object at the position specified by the index. Return null if the device doesn't support the phone screen display feature and (or) index is not in the valid range.

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

getFieldCount

public int getFieldCount()

Retrieves the number of fields.

Overrides:

getFieldCount in class Manager

Returns:

Number of fields. Return 0 if the device doesn't support the phone screen display feature or the Manager is empty.

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