Skip to content

Removed unused images from the developer guide #4063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shai-almog merged 1 commit into from
Oct 24, 2025
Merged

Removed unused images from the developer guide #4063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
74 changes: 37 additions & 37 deletions docs/developer-guide/Advanced-Theming.asciidoc
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions docs/developer-guide/Advanced-Topics-Under-The-Hood.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ These hints are often referred to as "build hints" or "build arguments", they ar
You can set these hints by right clicking the project in the IDE and selecting #Codename One# -> #Codename One Settings# -> #Build Hints#. The hints use the `key=value` style of data.

.The build hints UI in Codename One Settings
image::img/developer-guide/build-hints-codenameone-settings.png[The build hints UI in Codename One Settings,scaledwidth=50%]
image::img/build-hints-codenameone-settings.png[The build hints UI in Codename One Settings,scaledwidth=50%]

You can set the build hints in the `codenameone_settings.properties` file directly notice that when you do that all settings need to start with the `codename1.arg.` prefix. When editing the properties file directly we would need to define something like `android.debug=true` as `codename1.arg.android.debug=true`.

Expand Down Expand Up @@ -545,30 +545,30 @@ f.show();
If you explicitly lower the target SDK (e.g. `android.targetSDKVersion=21`) and install this app on an Android 6 device you will still see the legacy install prompt with all permissions listed up front:

.Install UI when using the old permissions system
image::img/developer-guide/marshmallow-permissions-level21.png[Install UI when using the old permissions system,scaledwidth=20%]
image::img/marshmallow-permissions-level21.png[Install UI when using the old permissions system,scaledwidth=20%]

When you keep the default target (API 33+) the installer defers to the runtime permission flow and the install UI looks like this instead:

.Install UI when using the new permissions system
image::img/developer-guide/marshmallow-permissions-level23.png[Install UI when using the new permissions system,scaledwidth=20%]
image::img/marshmallow-permissions-level23.png[Install UI when using the new permissions system,scaledwidth=20%]

When we launch the UI under the old permissions system we see the contacts instantly. In the new system we are presented with this UI:

.Native permission prompt first time
image::img/developer-guide/marshmallow-permissions-first-request.png[Native permission prompt first time,scaledwidth=20%]
image::img/marshmallow-permissions-first-request.png[Native permission prompt first time,scaledwidth=20%]

If we accept and allow all is good and the app loads as usual but if we deny then Codename One gives the user another chance to request the permission. Notice that in this case you can customize the prompt string as explained below.

.Codename One permission prompt
image::img/developer-guide/marshmallow-permissions-codenameone-prompt.png[Codename One permission prompt,scaledwidth=20%]
image::img/marshmallow-permissions-codenameone-prompt.png[Codename One permission prompt,scaledwidth=20%]

If we select don't ask then you will get a blank screen since the contacts will return as a 0 length array. This makes
sense as the user is aware he denied permission and the app will still function as expected on a device where
no contacts are available. However, if the user realizes his mistake he can double back and ask to re-prompt for
permission in which case he will see this native prompt:

.Native permission prompt second time
image::img/developer-guide/marshmallow-permissions-second-request.png[Native permission prompt second time,scaledwidth=20%]
image::img/marshmallow-permissions-second-request.png[Native permission prompt second time,scaledwidth=20%]

Notice that denying this second request will not trigger another Codename One prompt.

Expand Down Expand Up @@ -600,7 +600,7 @@ The following permission keys are supported: "android.permission.READ_PHONE_STAT
You can simulate permission prompts by checking that option in the simulator menu.

.Simulate permission prompts menu item in the simulator
image::img/developer-guide/simulate-permission-prompts.png[Simulate permission prompts menu item in the simulator,scaledwidth=10%]
image::img/simulate-permission-prompts.png[Simulate permission prompts menu item in the simulator,scaledwidth=10%]

This will produce a dialog to the user whenever this happens in Android and will try to act in a similar way to the device. Notice that you can test it in the iOS simulator too.

Expand Down Expand Up @@ -640,7 +640,7 @@ With Android Studio this is sometimes as very easy task as it is possible to act
By default you should be able to open the gradle project in Android Studio and just run it. To get this to work open the Android Studio #Setting# and select gradle *2.11*.

.Gradle settings UI in Android Studio (notice you need gradle 2.11 and not 2.8 as pictured here)
image::img/developer-guide/gradle-settings.png[Gradle settings UI in Android Studio,scaledwidth=50%]
image::img/gradle-settings.png[Gradle settings UI in Android Studio,scaledwidth=50%]

If this works for you then you can ignore the section below.

Expand Down Expand Up @@ -702,22 +702,22 @@ public interface MyNative extends NativeInterface {
We now need to right click the class in the IDE and select the #Generate Native Access# menu item:

.Generating the native code
image::img/developer-guide/native-interfaces-generate-menu.png[Generating the native code,scaledwidth=20%]
image::img/native-interfaces-generate-menu.png[Generating the native code,scaledwidth=20%]

.Once generated we are prompted that the native code is in the "native" directory
image::img/developer-guide/native-interfaces-generated.png[Once generated we are prompted that the native code is in the "native" directory,scaledwidth=40%]
image::img/native-interfaces-generated.png[Once generated we are prompted that the native code is in the "native" directory,scaledwidth=40%]

We can now look int the #native# directory in the project root (in NetBeans you can see that in the #Files# tab) and you can see something that looks like this:

.Native directory structure containing stubs for the various platforms
image::img/developer-guide/native-interfaces-native-hierarchy.png[Native directory structure containing stubs for the various platforms,scaledwidth=30%]
image::img/native-interfaces-native-hierarchy.png[Native directory structure containing stubs for the various platforms,scaledwidth=30%]

These are effectively stubs you can edit to implement the methods in native code.

TIP: If you re-run the #Generate Native Access# tool you will get this dialog, if you answer yes all the files will be overwritten, if you answer no only files you deleted/renamed will be recreated

.Running "Generate Native Access" when some/all of the native files exist already
image::img/developer-guide/native-interfaces-generated-existing.png[Running "Generate Native Access" when some/all of the native files exist already,scaledwidth=40%]
image::img/native-interfaces-generated-existing.png[Running "Generate Native Access" when some/all of the native files exist already,scaledwidth=40%]

For now lets leave the stubs and come back to them soon. From the Codename One Java code we can call the implementation of this native interface using:

Expand Down Expand Up @@ -1686,7 +1686,7 @@ Support for JAR files in Codename One has been a source of confusion so its prob
The first source of confusion is changing the classpath. You should NEVER change the classpath or add an external JAR via the IDE classpath UI. The reasoning here is very simple, these IDE's don't package the JAR's into the final executable and even if they did these JAR's would probably use features unavailable or inappropriate for the device (e.g. `java.io.File` etc.).

.Don't change the classpath, this is how it should look for a typical Java 8 Codename One application
image::img/developer-guide/cn1libs-dont-change-classpath.png[Don't change the classpath, this is how it should look for a typical Java 8 Codename One application,scaledwidth=40%]
image::img/cn1libs-dont-change-classpath.png[Don't change the classpath, this is how it should look for a typical Java 8 Codename One application,scaledwidth=40%]

Cn1libs are Codename One's file format for 3rd party extensions. It's physicially a zip file containing other zip files and some meta-data.

Expand All @@ -1711,7 +1711,7 @@ Cn1lib’s address the modularity aspect allowing you to break that down. Existi
Codename One has a large repository of https://www.codenameone.com/cn1libs.html[3rd party cn1libs], you can install a cn1lib by placing it in the lib directory of your project then right clicking the project and selecting #Codename One# -> #Refresh cn1lib files#.

.Refresh cn1lib files menu option
image::img/developer-guide/cn1libs-refresh.png[Refresh cn1lib files menu option,scaledwidth=40%]
image::img/cn1libs-refresh.png[Refresh cn1lib files menu option,scaledwidth=40%]

Once refreshed the content of the cn1lib will be available to code completion and you could just use it.

Expand All @@ -1731,10 +1731,10 @@ The native files are extracted to `lib/impl/native`. The classpath for the main
Creating a cn1lib is trivial, we will get into more elaborate uses soon enough but for a hello world cn1lib we can just use this 2 step process:

.Select the CodenameOne Library Option
image::img/developer-guide/cn1lib-create-step1.png[Select the CodenameOne Library Option,scaledwidth=30%]
image::img/cn1lib-create-step1.png[Select the CodenameOne Library Option,scaledwidth=30%]

.Select the file name/destination. Notice that a Java 8 cn1lib requires Java 8 support in the parent project!
image::img/developer-guide/cn1lib-create-step2.png[Select the file name/destination. Notice that a Java 8 cn1lib requires Java 8 support in the parent project!,scaledwidth=30%]
image::img/cn1lib-create-step2.png[Select the file name/destination. Notice that a Java 8 cn1lib requires Java 8 support in the parent project!,scaledwidth=30%]

Once we go thru these steps we can define any source file within the library and it will be accessible to the users of the library.

Expand Down Expand Up @@ -1964,7 +1964,7 @@ hi.show();
----

.Drag and drop demo
image::img/developer-guide/draganddrop-rearrange-game.png[Drag and drop demo,scaledwidth=20%]
image::img/draganddrop-rearrange-game.png[Drag and drop demo,scaledwidth=20%]


To enable dragging a component it must be flagged as draggable using `setDraggable(true)`, to allow dropping the component onto another component you must first enable the drop target with `setDropTarget(true)` and override some methods (more on that later).
Expand Down Expand Up @@ -2178,13 +2178,13 @@ The following diagram shows the dependencies in a native library:

[[fc8a77d2-61e0-11e5-9ecf-bf381d4ac966]]
.Relationship between native & Codename One API UML Diagram
image::img/developer-guide/fc8a77d2-61e0-11e5-9ecf-bf381d4ac966.png[Relationship between native and Codename One API UML Diagram,scaledwidth=50%]
image::img/fc8a77d2-61e0-11e5-9ecf-bf381d4ac966.png[Relationship between native and Codename One API UML Diagram,scaledwidth=50%]

In the specific case of our FreshDesk API, the public API and classes will look like:

[[a5fe88406-61e4-11e5-951e-e09bd28a93c9]]
.Freshdesk API Integration
image::img/developer-guide/5fe88406-61e4-11e5-951e-e09bd28a93c9.png[Freshdesk API Integration,scaledwidth=30%]
image::img/5fe88406-61e4-11e5-951e-e09bd28a93c9.png[Freshdesk API Integration,scaledwidth=30%]

===== Things to Notice

Expand Down Expand Up @@ -2692,13 +2692,13 @@ Now that we have set up our public API and our native interface, it is time to w

[[c9d4b9cc-61f6-11e5-8b67-4691600188cd]]
.Generate Native Access Menu Item
image::img/developer-guide/c9d4b9cc-61f6-11e5-8b67-4691600188cd.png[Generate Native Access Menu Item,scaledwidth=20%]
image::img/c9d4b9cc-61f6-11e5-8b67-4691600188cd.png[Generate Native Access Menu Item,scaledwidth=20%]

This will generate a separate directory for each platform inside your project's `native` directory:

[[eef6d078-61f6-11e5-91cd-2e1836916359]]
.Native generated sources directory view
image::img/developer-guide/eef6d078-61f6-11e5-91cd-2e1836916359.png[Native generated sources directory view,scaledwidth=15%]
image::img/eef6d078-61f6-11e5-91cd-2e1836916359.png[Native generated sources directory view,scaledwidth=15%]

Inside the `android` directory, this generates a `com/codename1/freshdesk/MobihelpNativeImpl` class with stubs for each method.

Expand Down Expand Up @@ -3074,13 +3074,13 @@ The iOS integration guide for the FreshDesk SDK lists the following core framewo

[[IOSlinkoptions]]
.IOS link options
image::img/developer-guide/12c5303e-620c-11e5-9dbb-bcb4bebc0c87.png[iOS link options,scaledwidth=35%]
image::img/12c5303e-620c-11e5-9dbb-bcb4bebc0c87.png[iOS link options,scaledwidth=35%]

We can add these dependencies to our project using the `ios.add_libs` build hint. E.g.

[[a65e31df8-620c-11e5-87ff-6b926a3f2090]]
.iOS's "add libs" build hint
image::img/developer-guide/65e31df8-620c-11e5-87ff-6b926a3f2090.png[iOS's "add libs" build hint,scaledwidth=30%]
image::img/65e31df8-620c-11e5-87ff-6b926a3f2090.png[iOS's "add libs" build hint,scaledwidth=30%]

I.e. we just list the framework names separated by semicolons. Notice that my list in the above image doesn't include all of the frameworks that they list because many of the frameworks are already included by default (I obtained the default list by simply building the project with "include sources" checked, then looked at the frameworks that were included).

Expand Down Expand Up @@ -3168,7 +3168,7 @@ hi.show();
----

.Center layout staircase effect with margin
image::img/developer-guide/center-layout.png[Center layout staircase effect with margin,scaledwidth=20%]
image::img/center-layout.png[Center layout staircase effect with margin,scaledwidth=20%]

==== Porting a Swing/AWT Layout Manager

Expand Down
32 changes: 16 additions & 16 deletions docs/developer-guide/Animations.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ There are a couple of things that you should notice about this example:

This results in:

image:img/developer-guide/layout-animation-1.png[Frame 1]
image:img/developer-guide/layout-animation-2.png[Frame 2]
image:img/developer-guide/layout-animation-3.png[Frame 3]
image:img/developer-guide/layout-animation-4.png[Frame 4]
image:img/developer-guide/layout-animation-5.png[Frame 5]
image:img/developer-guide/layout-animation-6.png[Frame 6]
image:img/developer-guide/layout-animation-7.png[Frame 7]
image:img/layout-animation-1.png[Frame 1]
image:img/layout-animation-2.png[Frame 2]
image:img/layout-animation-3.png[Frame 3]
image:img/layout-animation-4.png[Frame 4]
image:img/layout-animation-5.png[Frame 5]
image:img/layout-animation-6.png[Frame 6]
image:img/layout-animation-7.png[Frame 7]


==== Unlayout Animations
Expand Down Expand Up @@ -456,36 +456,36 @@ hi.show();


.The slide transition moves both incoming and outgoing forms together
image::img/developer-guide/transition-slide.jpg[The slide transition moves both incoming and outgoing forms together,scaledwidth=70%]
image::img/transition-slide.jpg[The slide transition moves both incoming and outgoing forms together,scaledwidth=70%]

.The slide transition can be applied vertically as well
image::img/developer-guide/transition-slide-vertical.jpg[The slide transition can be applied vertically as well,scaledwidth=70%]
image::img/transition-slide-vertical.jpg[The slide transition can be applied vertically as well,scaledwidth=70%]

.Slide fade fades in the destination title while sliding the content pane it is the default on iOS
image::img/developer-guide/transition-slide-fade.jpg[Slide fade fades in the destination title while sliding the content pane its the default on iOS,scaledwidth=70%]
image::img/transition-slide-fade.jpg[Slide fade fades in the destination title while sliding the content pane its the default on iOS,scaledwidth=70%]

TIP: `SlideFade` is problematic without a title area. If you have a `Form` that lacks a title area we would recommend to disable `SlideFade` at least for that `Form`.

.With cover transitions the source form stays in place as it is covered by the destination. This transition can be played both horizontally and vertically
image::img/developer-guide/transition-cover.jpg[With cover transitions the source form stays in place as it is covered by the destination. This transition can be played both horizontally and vertically,scaledwidth=70%]
image::img/transition-cover.jpg[With cover transitions the source form stays in place as it is covered by the destination. This transition can be played both horizontally and vertically,scaledwidth=70%]


.Uncover is the inverse of cover. The destination form stays in place while the departing form moves away
image::img/developer-guide/transition-uncover.jpg[Uncover is the inverse of cover. The destination form stays in place while the departing form moves away,scaledwidth=70%]
image::img/transition-uncover.jpg[Uncover is the inverse of cover. The destination form stays in place while the departing form moves away,scaledwidth=70%]

==== Fade and Flip Transitions

The fade transition is pretty trivial and only accepts a time value since it has no directional context.

.Fade transition is probably the simplest one around
image::img/developer-guide/transition-fade.jpg[Fade transition is probably the simplest one around,scaledwidth=70%]
image::img/transition-fade.jpg[Fade transition is probably the simplest one around,scaledwidth=70%]

The https://www.codenameone.com/javadoc/com/codename1/ui/animations/FlipTransition.html[FlipTransition] is also pretty simple but unlike the others it isn't a part of the `CommonTransitions`. It has its own `FlipTransition` class.

IMPORTANT: This transition looks very different on devices as it uses native perspective transforms available only there

.Fade transition is probably the simplest one around
image::img/developer-guide/transition-flip.jpg[Fade transition is probably the simplest one around,scaledwidth=70%]
image::img/transition-flip.jpg[Fade transition is probably the simplest one around,scaledwidth=70%]

==== Bubble Transition

Expand Down Expand Up @@ -546,7 +546,7 @@ hi.show();
----

.Bubble transition converting a circular button to a Dialog
image::img/developer-guide/transition-bubble.png[Bubble transition converting a circular button to a Dialog,scaledwidth=12%]
image::img/transition-bubble.png[Bubble transition converting a circular button to a Dialog,scaledwidth=12%]



Expand All @@ -561,7 +561,7 @@ once.

[[mighty-morphing-components-1]]
.Morph Transition
image::img/developer-guide/mighty-morphing-components-1.png[Morph Transition,scaledwidth=15%]
image::img/mighty-morphing-components-1.png[Morph Transition,scaledwidth=15%]

To support this behavior we have the https://www.codenameone.com/javadoc/com/codename1/ui/animations/MorphTransition.html[MorphTransition] class that provides this same effect coupled with a fade to
the rest of the UI (see <<mighty-morphing-components-1>>).
Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/Casual-Game-Programming.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The first step is creating the splash animation as you can see in the screenshot

[[game-figure-2]]
.Animation stages for the splash screen opening animation
image::img/developer-guide/gaming-fig2.png[Figure 2,scaledwidth=40%]
image::img/gaming-fig2.png[Figure 2,scaledwidth=40%]

The animation in the splash screen and most of the following animations are achieved using the simple tool of layout animations. In Codename One components are automatically arranged into position using layout managers, however this isn’t implicit unless the device is rotated. A layout animation relies on this fact, it allows you to place components in a position (whether by using a layout manager or by using `setX`/`setY`) then invoke the layout animation code so they will slide into their “proper” position based on the layout manager rules.

Expand All @@ -66,7 +66,7 @@ Initially when entering the game form we have another animation where all the ca

[[game-figure-3]]
.Game form startup animation and deal animation
image::img/developer-guide/game-figure-3.png[Game UI,scaledwidth=40%]
image::img/game-figure-3.png[Game UI,scaledwidth=40%]


This animation is really easy to accomplish although it does have several stages. In the first stage we layout the cards within a grid layout (13x4), then when the animation starts (see the https://www.codenameone.com/javadoc/com/codename1/ui/util/UITimer.html[UITimer] code within `showGameUI()`) we just change the layout to a layered layout, add the back card (so it will come out on top based on z-ordering) and invoke animate layout.
Expand Down
Loading