File	Doc	Category	Size	Date	Package
DisplayableLF.java	API Doc	phoneME MR2 API (J2ME)	8373	Wed May 02 18:00:22 BST 2007	javax.microedition.lcdui

DisplayableLF

Fields Summary

Constructors Summary

Methods Summary
public int	getVerticalScrollPosition() Get the current vertical scroll position return int The vertical scroll position on a scale of 0-100
public int	getVerticalScrollProportion() Get the current vertical scroll proportion return ing The vertical scroll proportion on a scale of 0-100
public void	lAddCommand(Command cmd, int i) Notifies look&feel object of a command addition to the Displayable. param cmd the command that was added param i the index of the added command in Displayable.commands[] array
public void	lCommitPendingInteraction() Called to commit any pending user interaction for the current item before an abstract command is fired. Caller should hold LCDUILock around this call.
public Display	lGetCurrentDisplay() Return in which Display instance the LF is visible. return the current display.
public Displayable	lGetDisplayable() Return the associated Displayable object. return the Displayable object.
public int	lGetHeight() Returns the height of the area available to the application. return height of the area available to the application
public int	lGetWidth() Returns the width of the area available to the application. return width of the area available to the application
public boolean	lIsShown() Implement the public API isShown(). return true if the DisplayableLF is interactive with user.
public void	lRemoveCommand(Command cmd, int i) Notifies look&feel object of a command removal from the Displayable. param cmd the command that was removed param i the index of the removed command in Displayable.commands[] array
public void	lSetDisplay(Display d) Set the display instance the Displayable is associated with. Caller should hold LCDUILock around this call. param d Display instance in which this DisplayableLF is visible. null if this DisplayableLF is no longer visible.
public void	lSetTicker(Ticker oldTicker, Ticker newTicker) Notifies Displayable's look & feel object of a ticker change. param oldTicker the old ticker, or null for no ticker param newTicker the new ticker, or null for no ticker
public void	lSetTitle(java.lang.String oldTitle, java.lang.String newTitle) Notifies Displayable's look & feel object of a title change. param oldTitle the old title, or null for no title param newTitle the new title, or null for no title
public void	uCallFreeze() While UI resources of this LF are created and visible already, stop any further updates to physical screen because some "system modal dialog" takes over physical screen buffer and user input now. Repaint and invalidate requests from this DisplayableLF will be really scheduled into event queue. Instead, only dirty flag is set. After a LF enters "freeze" mode, it can be resumed of visibility or directly replaced by a new Displayable.
public void	uCallHide() Remove this displayable from physical screen. The displayable should unload any resource that was allocated. It's not required to clean the physical screen before this function returns. This function could be called while a LF is in "freeze" mode.
public void	uCallInvalidate() Relayout and repaint now. Called by the event handler to perform an invalidation of this Displayable.
public void	uCallKeyEvent(int type, int keyCode) Handle key events. param type defined in EventConstants. param keyCode the key involved in this event.
public void	uCallPaint(Graphics g, java.lang.Object target) Repaint now. Display calls this method on it's current Displayable. Displayable uses this opportunity to do necessary stuff on the Graphics context, this includes, paint Ticker, paint Title, translate as necessary. The target Object of this repaint may be some Object initially set by this Displayable when the repaint was requested - allowing this Displayable to know exactly which Object it needs to call to service this repaint, rather than potentially querying all of its Objects to determine the one(s) which need painting. SYNC NOTE: The caller of this method handles synchronization. param g the graphics context to paint into. param target the target Object of this repaint
public void	uCallPointerEvent(int type, int x, int y) Handle pointer events. param type kind of event, defined in EventConstants. param x x-coordinate of pointer event param y y-coordinate of pointer event
public void	uCallScrollContent(int scrollType, int thumbPosition) This method notify displayable to scroll its content param scrollType scrollType param thumbPosition
public void	uCallShow() Prepare to show this LF on physical screen. This is the internal version of showNotify() function as defined in MIDP spec. It is called immediately prior to this LF being made visible on the display. The LF should load any resource that is needed, layout. App's paint() should NOT be called in this function. Instead, it should be in the dsPaint() that will be called on this LF shortly after.
public void	uCallSizeChanged(int w, int h) This method calls Displayable.sizeChanged method. param w the new width param h the new height
public boolean	uIsScrollNative() This method is used int repaint, int order to determine the translation of the draw coordinates. return true if the scroll responsibility is of the native platform. false - if the scroll is done in the Java level.
public void	uSetFullScreenMode(boolean fullScreenMode) Notify the full screen mode of this LF. If true, this DisplayableLF will take up as much screen real estate as possible. Any subclass of Displayable should be prepared to do their job to accommodate the change. Note that it can call into the app code. param fullScreenMode true if full screen mode should be turned on
public boolean	uSetRotatedStatus(boolean newStatus)
public void	updateCommandSet() Notifies look&feel object of commandset being updated.