66
|
1 |
/*
|
|
2 |
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description:
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef CMIDTOOLKIT_H
|
|
20 |
#define CMIDTOOLKIT_H
|
|
21 |
|
|
22 |
#include <mevents.h>
|
|
23 |
#include <coecntrl.h>
|
|
24 |
//
|
|
25 |
#include <Lcdglue.h>
|
|
26 |
#include "CMIDEnv.h"
|
|
27 |
#include "MIDUtils.h"
|
|
28 |
#include "lcdui.h"
|
|
29 |
#include "lcdgr.h"
|
|
30 |
|
|
31 |
//
|
|
32 |
class CApaWindowGroupName;
|
|
33 |
class CMIDToolkit;
|
|
34 |
class MMIDDisplayable;
|
|
35 |
|
|
36 |
/**
|
|
37 |
Utility class providing access to the MIDlet suite attributes.
|
|
38 |
*/
|
|
39 |
class CMIDletSuite : public CBase
|
|
40 |
{
|
|
41 |
public:
|
|
42 |
CMIDletSuite();
|
|
43 |
~CMIDletSuite();
|
|
44 |
|
|
45 |
void SetAttributesL(RPointerArray<HBufC>& aAttributes);
|
|
46 |
|
|
47 |
TInt GetAttribute(const TDesC& aName, TPtrC& aValue);
|
|
48 |
|
|
49 |
private:
|
|
50 |
RPointerArray<HBufC> iAttributes;
|
|
51 |
};
|
|
52 |
|
|
53 |
/**
|
|
54 |
*
|
|
55 |
* Main class in the framework, one per MIDlet
|
|
56 |
*
|
|
57 |
* CMIDToolkit isA java event source and as such has an extremely complicated lifecycle with
|
|
58 |
* several states:
|
|
59 |
*
|
|
60 |
* The source is constructed via a mechanism that ensures the first three phases of construction
|
|
61 |
* succeed fully or the object is fully destroyed. This is handled by the New() static method in
|
|
62 |
* CJavaEventSource<CMIDToolkit>.
|
|
63 |
*
|
|
64 |
* CMIDToolkit() // PHASE 1
|
|
65 |
* ConstructL() // PHASE 2
|
|
66 |
* SvrConstructL() // PHASE 3
|
|
67 |
*
|
|
68 |
* FinalizeSvr() // PHASE 3
|
|
69 |
* FinalizeJni() // PHASE 2
|
|
70 |
* ~CMIDToolkit() // PHASE 1
|
|
71 |
*
|
|
72 |
*/
|
|
73 |
class CMIDToolkit : public CJavaEventSource<CMIDToolkit>, public MMIDObserver
|
|
74 |
{
|
|
75 |
public:
|
|
76 |
TInt PostDisplayEvent(TEventType aEvent);
|
|
77 |
TInt PostDisplayableEvent(MMIDComponent& aDisplayable, TEventType aEvent, TInt aParam0, TInt aParam1);
|
|
78 |
TInt PostItemEvent(MMIDComponent& aItem, TEventType aEvent, TInt aParam0, TInt aParam1, TInt aParam2);
|
|
79 |
|
|
80 |
TInt PostCanvasGraphicsItemPainterEvent(MMIDComponent& aCanvasGraphicsItemPainter,
|
|
81 |
TEventType aEvent, TInt aParam0, TInt aParam1);
|
|
82 |
|
|
83 |
inline MMIDDisplayable* Current();
|
|
84 |
TPtrC MidletName() const;
|
|
85 |
inline TUid MidletUid() const;
|
|
86 |
inline TPtrC MidletHome() const;
|
|
87 |
|
|
88 |
/**
|
|
89 |
* Inform CMIDToolkit about deleting of object implementing MMIDDisplayable.
|
|
90 |
*
|
|
91 |
* @param displayable deleting displayble
|
|
92 |
* @since Java 2.0
|
|
93 |
*/
|
|
94 |
inline void DisplayableIsDestructed(const MMIDDisplayable* aDisplayable);
|
|
95 |
|
|
96 |
TInt MidletAttribute(const TDesC& aAttributeName, TPtrC& aAttributeValue);
|
|
97 |
|
|
98 |
public:
|
|
99 |
/**
|
|
100 |
* Other server side methods
|
|
101 |
*/
|
|
102 |
static void InvokeSvrConstructL(CMIDToolkit* aToolkit,const TDesC* aName);
|
|
103 |
void SetCurrentL(MMIDDisplayable* aDisplayable);
|
|
104 |
void ClearDisplayable();
|
|
105 |
TBool PostSerialEvent(jobject aRunnable);
|
|
106 |
void DisposeObject(MMIDComponent* aObject);
|
|
107 |
|
|
108 |
// Returns pointer to last fullscreen displayble.
|
|
109 |
inline const MMIDDisplayable* LastFullscreenDisplayable() const;
|
|
110 |
|
|
111 |
//
|
|
112 |
// Activate event sources
|
|
113 |
//
|
|
114 |
void ActivateL();
|
|
115 |
TInt RegisterComponentL(MMIDComponent* aComponent, TJavaPeer aPeer);
|
|
116 |
|
|
117 |
public:
|
|
118 |
// Factory
|
|
119 |
static TInt New
|
|
120 |
(
|
|
121 |
JNIEnv& aJni,
|
|
122 |
jobject aPeer,
|
|
123 |
TJavaEventServer aServer,
|
|
124 |
const TDesC& aAppName,
|
|
125 |
TInt aAppUid,
|
|
126 |
const TDesC& aAppHome,
|
|
127 |
RPointerArray<HBufC>* aAttributes // may be NULL
|
|
128 |
);
|
|
129 |
|
|
130 |
/**
|
|
131 |
* PHASE 1 Constructor.
|
|
132 |
*/
|
|
133 |
CMIDToolkit();
|
|
134 |
|
|
135 |
/**
|
|
136 |
* PHASE 1 Destructor
|
|
137 |
*/
|
|
138 |
~CMIDToolkit();
|
|
139 |
|
|
140 |
/**
|
|
141 |
* PHASE 2 Constructor
|
|
142 |
*/
|
|
143 |
void ConstructL(JNIEnv& aJni,
|
|
144 |
jobject aPeer,
|
|
145 |
TJavaEventServer aServer,
|
|
146 |
const TDesC& aAppName,
|
|
147 |
TInt aAppUid,
|
|
148 |
const TDesC& aHomeDir,
|
|
149 |
RPointerArray<HBufC>* aAttributes // may be NULL
|
|
150 |
);
|
|
151 |
|
|
152 |
inline MMIDComponentFactory* CMIDToolkit::ComponentFactory() const;
|
|
153 |
inline MMIDUtils* Utils() const;
|
|
154 |
inline MMIDEnv* Env() const;
|
|
155 |
inline CApaWindowGroupName* WgName() const; // _APIEXT_SASF_
|
|
156 |
|
|
157 |
public:
|
|
158 |
inline MMIDGraphicsFactory& GraphicsFactory() const;
|
|
159 |
inline static TJavaPeer ComponentPeer(MMIDComponent& aComponent);
|
|
160 |
|
|
161 |
void BringToForeground();
|
|
162 |
void SendToBackground();
|
|
163 |
|
|
164 |
public:
|
|
165 |
/*
|
|
166 |
* From MMIDObserver
|
|
167 |
*/
|
|
168 |
void HandleExitL();
|
|
169 |
void HandleForegroundL(TBool aForeground);
|
|
170 |
void HandleSwitchOnEventL();
|
|
171 |
void HandleResourceChangeL(TInt aType);
|
|
172 |
#ifdef RD_JAVA_NGA_ENABLED
|
|
173 |
void HandleFullOrPartialForegroundL(TBool aFullOrPartialFg);
|
|
174 |
void HandleFreeGraphicsMemory();
|
|
175 |
#endif
|
|
176 |
|
|
177 |
private:
|
|
178 |
/**
|
|
179 |
* Resets user inactivity timers
|
|
180 |
*/
|
|
181 |
void ResetInactivityTimeL();
|
|
182 |
|
|
183 |
static TInt CreateToolkitL
|
|
184 |
(
|
|
185 |
JNIEnv& aJni,
|
|
186 |
jobject aPeer,
|
|
187 |
TJavaEventServer aServer,
|
|
188 |
const TDesC& aAppName,
|
|
189 |
TInt aAppUid,
|
|
190 |
const TDesC& aAppHome,
|
|
191 |
RPointerArray<HBufC>* aAttributes // may be NULL
|
|
192 |
);
|
|
193 |
|
|
194 |
/**
|
|
195 |
* Phase 3 constructor.
|
|
196 |
*/
|
|
197 |
void SvrConstructL(const TDesC& aName);
|
|
198 |
|
|
199 |
void CreateTaskListEntryL(const TDesC& aName);
|
|
200 |
void SetTaskListEntry(TBool);
|
|
201 |
|
|
202 |
/**
|
|
203 |
* Phase 3 destructor
|
|
204 |
*/
|
|
205 |
void FinalizeSvr();
|
|
206 |
|
|
207 |
/**
|
|
208 |
* Phase 2 destructor
|
|
209 |
*/
|
|
210 |
void FinalizeJni(JNIEnv& aJni);
|
|
211 |
|
|
212 |
/**
|
|
213 |
* Cleanup an object
|
|
214 |
*/
|
|
215 |
void DisposeEntry(TInt aIndex, TBool aPostEvent);
|
|
216 |
|
|
217 |
/**
|
|
218 |
* Set window group ordinal position.
|
|
219 |
*/
|
|
220 |
void SetOrdinalPosition(TInt aOrdinal);
|
|
221 |
|
|
222 |
/**
|
|
223 |
* Filter events - actually more of an on/off tap
|
|
224 |
*/
|
|
225 |
TBool CheckEvent(CJavaEventBase*);
|
|
226 |
|
|
227 |
void LoadLibrariesL();
|
|
228 |
|
|
229 |
/**
|
|
230 |
* If current displayable is canvas,
|
|
231 |
* returns pointer to it.
|
|
232 |
*
|
|
233 |
* @return pointer to the current canvas, if current displayable is canvas.
|
|
234 |
* NULL, if current displayable is not canvas.
|
|
235 |
*/
|
|
236 |
MMIDCanvas* GetCurrentCanvas() const;
|
|
237 |
|
|
238 |
public:
|
|
239 |
/*@ deprecated */
|
|
240 |
jmethodID iHandleNotifyMethod;
|
|
241 |
|
|
242 |
private:
|
|
243 |
jmethodID iHandleItemEvent;
|
|
244 |
jmethodID iHandleDisplayableEvent;
|
|
245 |
jmethodID iHandleDisplayEvent;
|
|
246 |
jmethodID iHandleCanavsGraphicsItemPainterEvent;
|
|
247 |
|
|
248 |
private:
|
|
249 |
enum {EGranularity=4};
|
|
250 |
|
|
251 |
private:
|
|
252 |
enum TPhase
|
|
253 |
{
|
|
254 |
ENone,
|
|
255 |
EPhase1,
|
|
256 |
EPhase2,
|
|
257 |
EPhase3
|
|
258 |
};
|
|
259 |
|
|
260 |
struct TObjectEntry
|
|
261 |
{
|
|
262 |
public:
|
|
263 |
TObjectEntry(MMIDComponent* aComponent);
|
|
264 |
union
|
|
265 |
{
|
|
266 |
MMIDComponent* iComponent;
|
|
267 |
TObjectEntry* iNextEntry;
|
|
268 |
};
|
|
269 |
TJavaPeer iDisposed;
|
|
270 |
};
|
|
271 |
|
|
272 |
private:
|
|
273 |
friend class CMIDFinalizeEvent;
|
|
274 |
|
|
275 |
/**
|
|
276 |
* Delete weak refs - called from CMIDDisposeEvent only..
|
|
277 |
*/
|
|
278 |
void FinalizeReferences(JNIEnv& aEnv);
|
|
279 |
|
|
280 |
void DestroyUi();
|
|
281 |
|
|
282 |
private:
|
|
283 |
TPhase iPhase;
|
|
284 |
TUid iAppUid;
|
|
285 |
HBufC* iHomeDir;
|
|
286 |
CMIDletSuite* iMidletSuite;
|
|
287 |
TObjectEntry* iFinalizeQueue; // finalization queue of weak ref entries
|
|
288 |
TInt iFinalizeCount;
|
|
289 |
RCriticalSection iFinalizeMutex;
|
|
290 |
|
|
291 |
private:
|
|
292 |
/**
|
|
293 |
* Server fields
|
|
294 |
*/
|
|
295 |
TObjectEntry* iDisposedQueue; // Disposed entry queue - pending finalization
|
|
296 |
TInt iDisposedCount;
|
|
297 |
|
|
298 |
CCoeEnv* iCoeEnv; // Not Owned.
|
|
299 |
MMIDDisplayable* iCurrentDisplayable; // Not Owned.
|
|
300 |
MMIDDisplayable* iOldFullScreenDisplayable; // Not Owned.
|
|
301 |
|
|
302 |
CApaWindowGroupName* iWgName;
|
|
303 |
CMIDEnv* iEnv;
|
|
304 |
|
|
305 |
RArray<TObjectEntry*> iObjects;
|
|
306 |
|
|
307 |
MMIDComponentFactory* iUiFactory;
|
|
308 |
MMIDUtils* iUtils;
|
|
309 |
|
|
310 |
RLibrary iGrLibrary;
|
|
311 |
MMIDGraphicsFactory* iGrFactory;
|
|
312 |
|
|
313 |
TBool iOpen;
|
|
314 |
TBool iMidletRequestedBg; // indicates if MIDlet itself has requested sending to background
|
|
315 |
TTime iSentToBgTime; // timestamp when MIDlet was sent to background
|
|
316 |
TBool mFirst;
|
|
317 |
};
|
|
318 |
|
|
319 |
/**
|
|
320 |
* Useful functions:
|
|
321 |
*/
|
|
322 |
inline void CleanupDisposePushL(MMIDComponent* aComponent);
|
|
323 |
inline void CleanupPopComponent(MMIDComponent* aComponent);
|
|
324 |
|
|
325 |
inline MMIDDisplayable* CMIDToolkit::Current()
|
|
326 |
{
|
|
327 |
return iCurrentDisplayable;
|
|
328 |
}
|
|
329 |
|
|
330 |
inline TUid CMIDToolkit::MidletUid() const
|
|
331 |
{
|
|
332 |
return iAppUid;
|
|
333 |
}
|
|
334 |
|
|
335 |
inline TPtrC CMIDToolkit::MidletHome() const
|
|
336 |
{
|
|
337 |
return *iHomeDir;
|
|
338 |
}
|
|
339 |
|
|
340 |
inline MMIDComponentFactory* CMIDToolkit::ComponentFactory() const
|
|
341 |
{
|
|
342 |
return iUiFactory;
|
|
343 |
}
|
|
344 |
|
|
345 |
inline MMIDUtils* CMIDToolkit::Utils() const
|
|
346 |
{
|
|
347 |
return iUtils;
|
|
348 |
}
|
|
349 |
|
|
350 |
inline MMIDEnv* CMIDToolkit::Env() const
|
|
351 |
{
|
|
352 |
return iEnv;
|
|
353 |
}
|
|
354 |
|
|
355 |
// --> _APIEXT_SASF_
|
|
356 |
inline CApaWindowGroupName* CMIDToolkit::WgName() const
|
|
357 |
{
|
|
358 |
return iWgName;
|
|
359 |
}
|
|
360 |
// <-- _APIEXT_SASF_
|
|
361 |
|
|
362 |
inline MMIDGraphicsFactory& CMIDToolkit::GraphicsFactory() const
|
|
363 |
{
|
|
364 |
return *iGrFactory;
|
|
365 |
}
|
|
366 |
|
|
367 |
inline TJavaPeer CMIDToolkit::ComponentPeer(MMIDComponent& aComponent)
|
|
368 |
{
|
|
369 |
return aComponent.iPeer;
|
|
370 |
}
|
|
371 |
|
|
372 |
inline void DisposeComponent(TAny* aPtr)
|
|
373 |
{
|
|
374 |
MMIDComponent* component = static_cast<MMIDComponent*>(aPtr);
|
|
375 |
component->Dispose();
|
|
376 |
}
|
|
377 |
|
|
378 |
inline void CleanupDisposePushL(MMIDComponent* aComponent)
|
|
379 |
{
|
|
380 |
CleanupStack::PushL(TCleanupItem(DisposeComponent, aComponent));
|
|
381 |
}
|
|
382 |
|
|
383 |
inline void CleanupPopComponent(MMIDComponent* aComponent)
|
|
384 |
{
|
|
385 |
CleanupStack::Pop(aComponent);
|
|
386 |
}
|
|
387 |
|
|
388 |
inline void CMIDToolkit::DisplayableIsDestructed(const MMIDDisplayable* aDisplayable)
|
|
389 |
{
|
|
390 |
// If this is set as iOldFullScreenDisplayable, we need set this to NULL.
|
|
391 |
if (aDisplayable == iOldFullScreenDisplayable)
|
|
392 |
{
|
|
393 |
iOldFullScreenDisplayable = NULL;
|
|
394 |
|
|
395 |
// We need to inform current Displayable about destroying
|
|
396 |
// old full screen Displayable.
|
|
397 |
if (iCurrentDisplayable)
|
|
398 |
{
|
|
399 |
iCurrentDisplayable->DisplayableBehindPopupIsDestroyed();
|
|
400 |
}
|
|
401 |
}
|
|
402 |
}
|
|
403 |
|
|
404 |
inline const MMIDDisplayable* CMIDToolkit::LastFullscreenDisplayable() const
|
|
405 |
{
|
|
406 |
return iOldFullScreenDisplayable;
|
|
407 |
}
|
|
408 |
|
|
409 |
#endif // CMIDTOOLKIT_H
|