001: /*
002: *
003: *
004: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: */
026:
027: package com.sun.midp.lcdui;
028:
029: import javax.microedition.lcdui.Display;
030: import javax.microedition.lcdui.Image;
031: import javax.microedition.lcdui.Displayable;
032:
033: /**
034: * Public interface for an object that is used to provide internal access
035: * to a Display object, across package boundaries. The object implements
036: * this interface, and is created inside the same package as Display, so
037: * that it has access to private instance data of Display as necessary.
038: */
039: public interface DisplayAccess {
040: /**
041: * Get the Display object that is associated with this DisplayAccess.
042: * @return Display The Display object.
043: */
044: Display getDisplay();
045:
046: /**
047: * Called to get current display width.
048: * @return Display width.
049: */
050: public int getDisplayWidth();
051:
052: /**
053: * Called to get current display height.
054: * @return Display height.
055: */
056: public int getDisplayHeight();
057:
058: /** Called to get the display to request the foreground. */
059: public void requestForeground();
060:
061: // API's for accessing Display from Games Package
062:
063: /**
064: * Called to get key mask of all the keys that were pressed.
065: * @return keyMask The key mask of all the keys that were pressed.
066: */
067: int getKeyMask();
068:
069: /**
070: * Flushes the entire off-screen buffer to the display.
071: * @param screen The Displayable
072: * @param offscreen_buffer The image buffer
073: * @param x The left edge of the region to be flushed
074: * @param y The top edge of the region to be flushed
075: * @param width The width of the region to be flushed
076: * @param height The height of the region to be flushed
077: */
078: void flush(Displayable screen, Image offscreen_buffer, int x,
079: int y, int width, int height);
080:
081: /**
082: * Called when the system needs to temporarily prevent the application
083: * from painting the screen. The primary use of this method is to allow
084: * a system service to temporarily utilize the screen, e.g. to provide
085: * input method or abstract command processing.
086: *
087: * This method should prevent application-based paints (i.e. those
088: * generated by Canvas.repaint(), Canvas.serviceRepaints() or some
089: * internal paint method on another kind of Displayable) from changing
090: * the contents of the screen in any way.
091: */
092: // void suspendPainting();
093: /**
094: * Called when the system is ready to give up its control over the
095: * screen. The application should receive a request for a full
096: * repaint when this is called, and is subsequently free to process
097: * paint events from Canvas.repaint(), Canvas.serviceRepaints() or
098: * internal paint methods on Displayable.
099: */
100: // void resumePainting();
101: /**
102: * Get the class name of the MIDlet that owns this display.
103: * DisplayAccess I/F method.
104: *
105: * @return name of the MIDlet that owns this Display
106: */
107: public String getNameOfOwner();
108:
109: /**
110: * Get the ID of this display.
111: *
112: * @return Display ID
113: */
114: public int getDisplayId();
115:
116: /**
117: * Sets the ID of this display.
118: * Shall be called only from DisplayContainer.addDisplay() during
119: * Display construction and registration in the container.
120: *
121: * @param newId new ID for Display associated with this DisplayAccess
122: */
123: public void setDisplayId(int newId);
124:
125: /**
126: * Get the DisplayEventConsumer associated with this display.
127: *
128: * @return Consumer of midlet events that go through this display
129: */
130: public DisplayEventConsumer getDisplayEventConsumer();
131:
132: /**
133: * Get the ForegroundEventConsumer associated with this display.
134: *
135: * @return Consumer of foreground events that go through this display
136: */
137: public ForegroundEventConsumer getForegroundEventConsumer();
138: }
|