net.rim.device.api.input
Class LookupVariantIterator

java.lang.Object
  extended by net.rim.device.api.input.LookupVariantIterator

public class LookupVariantIterator
extends Object

Lookup variant iterator is created and owned by InputHelper and re-initialized by input method repeatedly every time when variants change, to point to the first element of new variant sequence.

Since:
BlackBerry API 6.0.0

Method Summary
 int getCount()
          Returns number of variants in the variant iteration sequence.
 boolean hasNext()
          States whether or not the variant iteration sequence has more elements.
 boolean next(StringBuffer aResult)
          Returns the next element in the variant iteration sequence.
 void reset()
          Resets this iterator to point to the first element of the variant sequence.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Method Detail

reset

public void reset()
Resets this iterator to point to the first element of the variant sequence.

Since:
BlackBerry API 6.0.0

hasNext

public boolean hasNext()
States whether or not the variant iteration sequence has more elements.

Returns:
true if the variant iteration sequence has more elements, else false.
Since:
BlackBerry API 6.0.0

next

public boolean next(StringBuffer aResult)
Returns the next element in the variant iteration sequence.

Parameters:
aResult - A buffer where the next element is to be added.
Returns:
true if the operation succeeded and a variant was written into the buffer, else false.
Since:
BlackBerry API 6.0.0

getCount

public int getCount()
Returns number of variants in the variant iteration sequence.

Returns:
number of variants in the variant iteration sequence.
Since:
BlackBerry API 6.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.