Skip to content

Commit ec05ede

Browse files
authored
Cleanup developer guide content (#4735)
* Removed unused images and fixed asciidoc * Removed old references to blackberry/J2ME
1 parent 0b7d3b3 commit ec05ede

38 files changed

Lines changed: 16 additions & 30 deletions

docs/developer-guide/Advanced-Topics-Under-The-Hood.asciidoc

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -349,19 +349,9 @@ Currently only supported for App Store builds. See https://www.codenameone.com/
349349
| (Optional) The version of TeaVM to use for the build. *Use caution*, only use this property if you know what you are doing!
350350

351351

352-
|rim.askPermissions
353-
|true/false defaults to true. Indicates whether the user is prompted for permissions on Blackberry devices.
354-
355352
|google.adUnitId
356353
|Allows integrating Admob/Google Play ads into the application see link:https://www.codenameone.com/blog/adding-google-play-ads.html[this]
357354

358-
|rim.ignor_legacy
359-
|true/false defaults to false. When set to true the Blackberry build targets only 5.0 devices and newer and doesn’t build the 4.x version.
360-
rim.nativeBrowser true/false defaults to false. Enables the native blackberry browser on OS 5 or higher. It is disabled by default since it might casue crashes on some cases.
361-
362-
|rim.obfuscation
363-
|true/false defaults to false. Obfuscate the JAR before invoking the rimc compiler.
364-
365355
|ios.entitlementsInject
366356
|Content to inject into the iOS entitlements file. This should be in the Plist XML format. See https://developer.apple.com/documentation/bundleresources/entitlements?language=objc[Apple Entitlements Documentation].
367357

@@ -488,8 +478,6 @@ rim.nativeBrowser true/false defaults to false. Enables the native blackberry br
488478
|noExtraResources
489479
|true/false (defaults to false). Blocks codename one from injecting its own resources when set to true, the only effect this has is in slightly reducing archive size. This might have adverse effects on some features of Codename One so it isn't recommended.
490480

491-
|j2me.iconSize
492-
|Defaults to 48x48. The size of the icon in the format of width x height (without the spacing).
493481
|===
494482

495483
=== Android Permissions
@@ -768,7 +756,7 @@ Codename One doesn't include the native platforms in its bundle e.g. the full An
768756

769757
TIP: When implementing a non-trivial native interface, send a server build with the "Include Source" option checked. Implement the native interface in the native IDE then copy and paste the native code back into Codename One
770758

771-
The implementation of this interface is nearly identical for Android (Java/Kotlin), J2ME & Java SE.
759+
The implementation of this interface is nearly identical for Android (Java/Kotlin) & Java SE.
772760

773761
===== Swift (iOS) and Kotlin (Android) options
774762

@@ -1335,7 +1323,7 @@ include::../demos/android/src/main/java/com/codename1/sms/intercept/NativeSMSInt
13351323
Native interfaces standardize the invocation of native code from Codename One, but it doesn't standardize the reverse of callbacks into Codename One Java code. The reverse is naturally more complicated since its platform specific and more error prone.
13361324

13371325
A common "trick" for calling back is to just define a static method and then trigger it from native code. This works
1338-
nicely for Android, Java SE, Blackberry & Java ME since those platforms use Java for their "native code". Mapping this to iOS requires some basic understanding of how the iOS VM works.
1326+
nicely for Android & Java SE since those platforms use Java for their "native code". Mapping this to iOS requires some basic understanding of how the iOS VM works.
13391327

13401328
For the purpose of this explanation lets pretend we have a class called NativeCallback in the src hierarchy under
13411329
the package `com.mycompany` that has the method: `public static void callback()`.
@@ -1647,7 +1635,6 @@ javascript.minifying
16471635
javascript.proxy.url
16481636
javascript.sourceFilesCopied
16491637
javascript.teavm.version
1650-
rim.askPermissions
16511638
google.adUnitId
16521639
ios.includePush
16531640
ios.headphoneCallback
@@ -1669,7 +1656,6 @@ desktop.themeMac
16691656
desktop.themeWin
16701657
desktop.windowsOutput
16711658
noExtraResources
1672-
j2me.iconSize
16731659
android.permission.<PERMISSION_NAME>
16741660
----
16751661

@@ -1723,7 +1709,6 @@ The table below covers the files that can/should be a part of a cn1lib file:
17231709
| nativeios.zip | &#215; | Native iOS sources if applicable
17241710
| nativeand.zip | &#215; | Native Android sources if applicable
17251711
| nativejavascript.zip | &#215; | Native JavaScript sources if applicable
1726-
| nativerim.zip | &#215; | Native RIM sources if applicable
17271712
| nativese.zip | &#215; | Native JavaSE sources if applicable
17281713
| nativewin.zip | &#215; | Native Windows sources if applicable
17291714
| nativeme.zip | &#215; | Native Java ME sources if applicable

docs/developer-guide/Index.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ E.g.: Since building native iOS applications requires a Mac OS X machine with a
4545

4646
Subscribers can receive the C source code back using the include sources feature of Codename One and use those sources for benchmarking, debugging on devices etc.
4747

48-
The same is true for most other platforms. For the Android, J2ME & Blackberry the standard Java code is executed as is.
48+
The same is true for most other platforms. For the Android and Java SE the standard Java code is executed as is.
4949

50-
Java 8 syntax is supported thru https://github.com/orfjackal/retrolambda[retrolambda] installed on the Codename One servers. This is used to convert bytecode seamlessly down to Java 5 syntax levels. Java 5 syntax is translated to the JDK 1.3 cldc subset on J2ME/Blackberry to provide those language capabilities and API's across all devices. This is done using a server based bytecode processor based on retroweaver and a great deal of custom code. Notice that this architecture is transparent to developers as the build servers abstract most of the painful differences between devices.
50+
Java 8 syntax is supported through https://github.com/orfjackal/retrolambda[retrolambda] installed on the Codename One servers. This is used to convert bytecode seamlessly down to Java 5 syntax levels. This is done using a server based bytecode processor based on retroweaver and a great deal of custom code. Notice that this architecture is transparent to developers as the build servers abstract most of the painful differences between devices.
5151

5252
==== How does Codename One Work?
5353

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<module type="JAVA_MODULE" version="4">
3+
<component name="NewModuleRootManager" inherit-compiler-output="true">
4+
<exclude-output />
5+
<content url="file://$MODULE_DIR$">
6+
<sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
7+
</content>
8+
<orderEntry type="inheritedJdk" />
9+
<orderEntry type="sourceFolder" forTests="false" />
10+
</component>
11+
</module>

docs/developer-guide/graphics.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,6 @@ you need a fallback path.
373373
| JavaScript
374374
| Yes
375375

376-
| Yes
377376
|===
378377

379378

@@ -1324,8 +1323,7 @@ to the image itself (e.g. the `scaled` method) it will generate a new image whic
13241323
image.
13251324

13261325
TIP: Since https://www.codenameone.com/javadoc/com/codename1/ui/util/ImageIO.html[ImageIO] is used to perform the operations of the adapter interface its required that `ImageIO` will work.
1327-
It is currently working in JavaSE, Android, iOS & Windows Phone. It doesn't work on J2ME/Blackberry devices so if you
1328-
pass an adapter instance on those platforms it will probably fail to perform its task.
1326+
It is currently working in JavaSE, Android, iOS & Windows Phone.
13291327

13301328
If the file in the URL contains an image that is too big it will scale it to match the size of the placeholder precisely! +
13311329
There is also an option to fail if the sizes don't match. Notice that the image that will be saved is the scaled
-236 KB
Binary file not shown.
-9.43 KB
Binary file not shown.
Binary file not shown.
-1.03 KB
Binary file not shown.
-36.4 KB
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)