net.rim.blackberry.api.bbm.platform.ui.chat
Interface ToggleFieldProvider

All Known Implementing Classes:
ToggleChatDisplayField, ChatField, BasicReplyFieldManager, BasicMessageListManager

public interface ToggleFieldProvider

Represents an object that supports a collapsed/not collapsed concept. Can be used to control the visibility of your chat fields if they require to be hidden/shown on some user action.

Since:
BBM SDK 1.0

Method Summary
 Field getToggleField()
          Returns the toggle field.
 boolean isCollapsed()
          Indicates whether the toggle field represents a collapsed state.
 void toggle()
          Toggles the value returned by isCollapsed().
 

Method Detail

getToggleField

public Field getToggleField()
Returns the toggle field.
Returns:
toggle field
Since:
BBM SDK 1.0

isCollapsed

public boolean isCollapsed()
Indicates whether the toggle field represents a collapsed state. May be called from a non-event thread.
Returns:
true if the toggle field represents a collapsed state
Since:
BBM SDK 1.0

toggle

public void toggle()
Toggles the value returned by isCollapsed(). Repaints the field. This must only be called from the event thread.
Since:
BBM SDK 1.0



Copyright 1999- 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.