public class CN

Known subtypesFont

This is a global context static class designed for static import, this class allows us to write more terse code. However, its chief purpose is simplification by hiding some of the more esoteric methods of these underlying classes and bringing to the front the commonly used important methods. This class includes code from Display, NetworkManager, Log and other important classes

Fields

`public static final` `String NATIVE_MAIN_THIN = "native:MainThin"`	Constant for the name of the main thin native font.
`public static final` `String NATIVE_MAIN_LIGHT = "native:MainLight"`	Constant for the main light native font.
`public static final` `String NATIVE_MAIN_REGULAR = "native:MainRegular"`	Constant for the main regular native font.
`public static final` `String NATIVE_MAIN_BOLD = "native:MainBold"`	Constant for the main bold native font.
`public static final` `String NATIVE_MAIN_BLACK = "native:MainBlack"`	Constant for the main black native font.
`public static final` `String NATIVE_ITALIC_THIN = "native:ItalicThin"`	Constant for the italic thin native font.
`public static final` `String NATIVE_ITALIC_LIGHT = "native:ItalicLight"`	Constant for the italic light native font.
`public static final` `String NATIVE_ITALIC_REGULAR = "native:ItalicRegular"`	Constant for the italic regular native font.
`public static final` `String NATIVE_ITALIC_BOLD = "native:ItalicBold"`	Constant for the italic bold native font.
`public static final` `String NATIVE_ITALIC_BLACK = "native:ItalicBlack"`	Constant for the italic black native font.
`public static final int FACE_MONOSPACE = 32`	Constant allowing us to author portable system fonts
`public static final int FACE_PROPORTIONAL = 64`	Constant allowing us to author portable system fonts
`public static final int FACE_SYSTEM = 0`	Constant allowing us to author portable system fonts
`public static final int SIZE_LARGE = 16`	Constant allowing us to author portable system fonts
`public static final int SIZE_MEDIUM = 0`	Constant allowing us to author portable system fonts
`public static final int SIZE_SMALL = 8`	Constant allowing us to author portable system fonts
`public static final int STYLE_BOLD = 1`	Constant allowing us to author portable system fonts
`public static final int STYLE_ITALIC = 2`	Constant allowing us to author portable system fonts
`public static final int STYLE_UNDERLINED = 4`	Constant allowing us to author portable system fonts
`public static final int STYLE_PLAIN = 0`	Constant allowing us to author portable system fonts
`public static final` `String NORTH = "North"`	The north layout constraint (top of container).
`public static final` `String SOUTH = "South"`	The south layout constraint (bottom of container).
`public static final` `String WEST = "West"`	The west layout constraint (left of container).
`public static final` `String EAST = "East"`	The east layout constraint (right of container).
`public static final int CENTER = 4`	Indicates a Component center alignment
`public static final int TOP = 0`	Box-orientation constant used to specify the top of a box.
`public static final int LEFT = 1`	Box-orientation constant used to specify the left side of a box.
`public static final int BOTTOM = 2`	Box-orientation constant used to specify the bottom of a box.
`public static final int RIGHT = 3`	Box-orientation constant used to specify the right side of a box.
`public static final int BASELINE = 5`	Alignment to the baseline constraint
`public static final int CENTER_BEHAVIOR_SCALE = 0`	Defines the behavior of the component placed in the center position of the layout, by default it is scaled to the available space
`public static final int CENTER_BEHAVIOR_CENTER = 1`	Defines the behavior of the component placed in the center position of the layout, places the component in the center of the space available to the center component.
`public static final int CENTER_BEHAVIOR_CENTER_ABSOLUTE = 2`	Defines the behavior of the component placed in the center position of the layout, places the component in the center of the surrounding container
`public static final int CENTER_BEHAVIOR_TOTAL_BELOW = 3`	The center component takes up the entire screens and the sides are automatically placed on top of it thus creating a layered effect

Methods

`public static void setBookmark(Runnable bookmark)`	Sets a bookmark that can restore the app to a particular state.
`public static void restoreToBookmark()`	Runs the last bookmark that was set using `#setBookmark(java.lang.Runnable)`
`public static int getDragStartPercentage()`	This method allows us to manipulate the drag started detection logic.
`public static void setDragStartPercentage(int dragStartPercentage)`	This method allows us to manipulate the drag started detection logic.
`public static` `Object createSoftWeakRef(Object o)`	Creates a soft/weak reference to an object that allows it to be collected yet caches it.
`public static` `Object extractHardRef(Object o)`	Extracts the hard reference from the soft/weak reference given
`public static boolean isEnableAsyncStackTraces()`	Checks if async stack traces are enabled.
`public static void setEnableAsyncStackTraces(boolean enable)`	Enables or disables async stack traces.
`public static void vibrate(int duration)`	Vibrates the device for the given length of time, notice that this might ignore the time value completely on some OS’s where this level of control isn’t supported e.g. iOS see: https://github.com/codenameone/CodenameOne/issues/1904
`public static void announceForAccessibility(Component cmp, String text)`	Manually announces text to native accessibility services, optionally associating the announcement with a specific component.
`public static void announceForAccessibility(String text)`	Convenience overload to announce text without specifying a component.
`public static boolean isEdt()`	Returns true if we are currently in the event dispatch thread.
`public static void callSerially(Runnable r)`	Causes the runnable to be invoked on the event dispatch thread.
`public static void callSeriallyOnIdle(Runnable r)`	Causes the runnable to be invoked on the event dispatch thread when the event dispatch thread is idle.
`public static void scheduleBackgroundTask(Runnable r)`	Allows executing a background task in a separate low priority thread.
`public static void callSeriallyAndWait(Runnable r)`	Identical to callSerially with the added benefit of waiting for the Runnable method to complete.
`public static void callSeriallyAndWait(Runnable r, int timeout)`	Identical to callSerially with the added benefit of waiting for the Runnable method to complete.
`public static void invokeAndBlock(Runnable r)`	Invokes runnable and blocks the current thread, if the current thread is the EDT it will still be blocked in a way that doesn’t break event dispatch . Important: calling this method spawns a new thread that shouldn’t access the UI!
`public static void invokeWithoutBlocking(Runnable r)`	Invokes a Runnable with blocking disabled.
`public static <T> T invokeWithoutBlockingWithResultSync(RunnableWithResultSync<T> r)`	Invokes a RunnableWithResultSync with blocking disabled.
`public static boolean minimizeApplication()`	Minimizes the current application if minimization is supported by the platform (may fail).
`public static boolean isMinimized()`	Indicates whether an application is minimized
`public static void restoreMinimizedApplication()`	Restore the minimized application if minimization is supported by the platform
`public static` `Form getCurrentForm()`	Return the form currently displayed on the screen or null if no form is currently displayed.
`public static` `TopLevelContainer getCurrentTopLevel()`	The top level the user is currently working in, which may be a `Window`.
`public static int getDisplayWidth()`	Return the width of the display
`public static int getDisplayHeight()`	Return the height of the display
`public static int convertToPixels(int dipCount, boolean horizontal)`	Converts the dips count to pixels, dips are roughly 1mm in length.
`public static int convertToPixels(float value, byte unitType, boolean horizontal)`	Converts from specified unit to pixels.
`public static int convertToPixels(float value, byte unitType)`	Converts from specified unit to pixels.
`public static int convertToPixels(float dipCount)`	Converts the dips count to pixels, dips are roughly 1mm in length.
`public static` `InputStream getResourceAsStream(String resource)`	This method is essentially equivalent to cls.getResourceAsStream(String) however some platforms might define unique ways in which to load resources within the implementation.
`public static void addEdtErrorHandler(ActionListener e)`	An error handler will receive an action event with the source exception from the EDT once an error handler is installed the default Codename One error dialog will no longer appear
`public static void removeEdtErrorHandler(ActionListener e)`	An error handler will receive an action event with the source exception from the EDT once an error handler is installed the default Codename One error dialog will no longer appear
`public static void exitApplication()`	Exits the application…
`public static void exitAndClearTask()`	Exits the application and removes it from the platform’s list of recent tasks, so the user cannot bring it back by picking it out of the task switcher.
`public static boolean isExitAndClearTaskSupported()`	Indicates whether this platform can remove the application from its list of recent tasks on exit.
`public static` `String getProperty(String key, String defaultValue)`	Returns the property from the underlying platform deployment or the default value if no deployment values are supported.
`public static void setProperty(String key, String value)`	Sets a local property to the application, this method has no effect on the implementation code and only allows the user to override the logic of getProperty for internal application purposes.
`public static` `Boolean canExecute(String url)`	Returns true if executing this URL should work, returns false if it will not and null if this is unknown.
`public static void execute(String url)`	Executes the given URL on the native platform
`public static boolean downloadBytesAsFile(String fileName, byte[] bytes)`	Offers the given in-memory bytes to the user as a downloadable file, bypassing local storage.
`public static int getDeviceDensity()`	Returns one of the density variables appropriate for this device, notice that density doesn’t always correspond to resolution and an implementation might decide to change the density based on DPI constraints.
`public static boolean isPortrait()`	Returns true if the device is currently in portrait mode
`public static boolean requestFullScreen()`	Try to enter full-screen mode if the platform supports it.
`public static boolean exitFullScreen()`	Try to exit full-screen mode if the platform supports it.
`public static boolean isInFullScreenMode()`	Checks if the app is currently running in full-screen mode.
`public static boolean isFullScreenSupported()`	Checks if this platform supports full-screen mode.
`public static boolean canForceOrientation()`	Returns true if the device allows forcing the orientation via code, feature phones do not allow this although some include a jad property allowing for this feature
`public static void lockOrientation(boolean portrait)`	On devices that return true for canForceOrientation() this method can lock the device orientation either to portrait or landscape mode
`public static boolean isLockOrientation()`	Returns true if orientation was locked using #lockOrientation(boolean) and not yet unlocked via #unlockOrientation().
`public static void unlockOrientation()`	This is the reverse method for lock orientation allowing orientation lock to be disabled
`public static boolean isTablet()`	Indicates whether the device is a tablet, notice that this is often a guess
`public static boolean isDesktop()`	Returns true if this is a desktop application
`public static boolean isMultiWindowSupported()`	Indicates whether this platform can open desktop windows, so an application can offer them where they exist and stay on one surface where they do not.
`public static boolean isWatch()`	Indicates whether the application is running on a smartwatch form factor (Apple Watch / Wear OS).
`public static boolean isTV()`	Indicates whether the application is running on a television form factor (Apple TV / Android TV / Google TV).
`public static boolean isCarConnected()`	Indicates whether a head unit (Apple CarPlay / Google Android Auto) is currently connected and projecting the `com.codename1.car` experience.
`public static` `PointerEvent getCurrentPointerEvent()`	Returns a snapshot of the rich detail for the pointer event currently being dispatched such as the mouse button, pointer type (finger/mouse/stylus), pressure and stylus tilt.
`public static int getPointerButton()`	The mouse button associated with the current pointer event, one of the `com.codename1.ui.events.PointerEvent` `BUTTON_*` constants.
`public static int getPressedButtonMask()`	A bitmask of the mouse buttons currently held down, built from the `com.codename1.ui.events.PointerEvent` `MASK_*` constants.
`public static int getPointerType()`	The current pointing device type, one of the `com.codename1.ui.events.PointerEvent` `TYPE_*` constants (finger, mouse, stylus or eraser).
`public static float getPointerPressure()`	The normalized pressure of the current pointer event between `0.0` and `1.0`.
`public static float getPointerTiltX()`	The stylus tilt across the x axis of the current pointer event in degrees, or `0` when not reported.
`public static float getPointerTiltY()`	The stylus tilt across the y axis of the current pointer event in degrees, or `0` when not reported.
`public static float getPointerContactSize()`	The normalized contact size of the current pointer event between `0.0` and `1.0`, or `0` when not reported.
`public static boolean isStylusPointer()`	True if the current pointer is a stylus or pen (Apple Pencil, S-Pen and similar).
`public static boolean isFoldable()`	True if the device is a foldable or dual screen device.
`public static` `DevicePosture getDevicePosture()`	Returns the live device fold posture.
`public static void addPostureListener(ActionListener l)`	Adds a listener that is notified when the device is folded, unfolded or changes posture.
`public static void removePostureListener(ActionListener l)`	Removes a posture listener.
`public static boolean isDesktopMode()`	True if the application is currently running in a desktop windowing mode such as Samsung DeX, Android desktop windowing or iPad Stage Manager.
`public static int getDisplayCount()`	Returns the number of displays (monitors or external screens) currently attached.
`public static boolean isExternalDisplayConnected()`	True if an external or secondary display is currently attached.
`public static` `Dimension getDesktopSize()`	Returns the size of the desktop hosting the application window when running on a desktop platform.
`public static` `Rectangle getWindowBounds()`	Returns the number of monitors attached to the desktop environment when available.
`public static void setWindowSize(int width, int height)`	Requests a resize of the application window when supported by the platform.
`public static` `Dimension getInitialWindowSizeHintPercent()`	Returns the initial desktop window size hint provided by the first shown form, when available.
`public static void setInitialWindowSizeHintPercent(Dimension hint)`	Sets the initial desktop window size hint (percent of the desktop) that should be used when the first form is shown.
`public static void addWindowListener(ActionListener<WindowEvent> l)`	Adds a listener for window events such as resize or move.
`public static void removeWindowListener(ActionListener<WindowEvent> l)`	Removes a previously registered window listener.
`public static boolean canDial()`	Returns true if the device has dialing capabilities
`public static` `Boolean isDarkMode()`	Returns true if the platform is in dark mode, null is returned for unknown status
`public static boolean isHighContrastEnabled()`	Returns true when the user requests stronger foreground/background contrast.
`public static boolean isDifferentiateWithoutColorEnabled()`	Returns true when the user requests that information isn’t conveyed by color alone.
`public static` `AccessibilityColorVisionDeficiency getColorVisionDeficiency()`	Returns the selected color-vision correction mode.
`public static boolean isReduceMotionEnabled()`	Returns true when the user requests reduced or disabled nonessential motion.
`public static boolean isReduceTransparencyEnabled()`	Returns true when the user requests reduced transparency and blur effects.
`public static boolean isBoldTextEnabled()`	Returns true when the user requests heavier text weight.
`public static boolean isInvertColorsEnabled()`	Returns true when the operating system is inverting displayed colors.
`public static boolean isGrayscaleEnabled()`	Returns true when the operating system requests a grayscale presentation.
`public static boolean isOnOffSwitchLabelsEnabled()`	Returns true when switches should include visible on/off labels.
`public static boolean isScreenReaderEnabled()`	Returns true when a screen reader or touch-exploration service is active.
`public static void setDarkMode(Boolean darkMode)`	Override the default dark mode setting
`public static void openGallery(ActionListener response, int type)`	Opens the device gallery to pick an image or a video.
`public static void openFileChooser(ActionListener response, String accept)`	Opens a file chooser for arbitrary user-selected files.
`public static` `String getPlatformName()`	Returns a 2-3 letter code representing the platform name for the platform override
`public static` `Simd getSimd()`	Returns the SIMD API for the current platform.
`public static boolean isGpuSupported()`	Returns true if the current platform provides a hardware accelerated 3D GPU backend for `com.codename1.gpu.RenderView`.
`public static void dial(String phoneNumber)`	Opens the device Dialer application with the given phone number
`public static int getSMSSupport()`	Indicates the level of SMS support in the platform as one of: `#SMS_NOT_SUPPORTED` (for desktop, tablet etc.), `#SMS_SEAMLESS` (no UI interaction), `#SMS_INTERACTIVE` (with compose UI), `#SMS_BOTH`.
`public static void sendSMS(String phoneNumber, String message) throws IOException`	Sends a SMS message to the given phone number
`public static void sendSMS(String phoneNumber, String message, boolean interactive) throws IOException`	Sends a SMS message to the given phone number, the code below demonstrates the logic of detecting platform behavior for sending SMS.
`public static void share(String text, String image, String mimeType)`	Share the required information using the platform sharing services.
`public static boolean isNativeShareSupported()`	Indicates if the underlying platform supports sharing capabilities
`public static boolean isNativeInAppReviewSupported()`	Indicates whether the platform exposes a native in-app review/rating prompt (the OS-sanctioned “rate this app” sheet).
`public static void requestNativeInAppReview(SuccessCallback<Boolean> done)`	Requests the native in-app review prompt.
`public static void share(String text, String image, String mimeType, Rectangle sourceRect)`	Share the required information using the platform sharing services.
`public static void registerPush()`	Register to receive push notification, invoke this method once (ever) to receive push notifications.
`public static void deregisterPush()`	Stop receiving push notifications to this client application
`public static` `Thread createThread(Runnable r, String name)`	Start a Codename One thread that supports crash protection and similar Codename One features.
`public static` `Thread startThread(Runnable r, String name)`	Deprecated Start a Codename One thread that supports crash protection and similar Codename One features.
`public static boolean isScreenSaverDisableSupported()`	Checks if the device supports disabling the screen display from dimming, allowing the developer to keep the screen display on.
`public static void setScreenSaverEnabled(boolean e)`	If isScreenSaverDisableSupported() returns true calling this method will lock the screen display on
`public static boolean hasCamera()`	Returns true if the device has camera false otherwise.
`public static boolean isNativePickerTypeSupported(int pickerType)`	Indicates whether the native picker dialog is supported for the given type which can include one of PICKER_TYPE_DATE_AND_TIME, PICKER_TYPE_TIME, PICKER_TYPE_DATE
`public static` `Object showNativePicker(int type, Component source, Object currentValue, Object data)`	Shows a native modal dialog allowing us to perform the picking for the given type which can include one of PICKER_TYPE_DATE_AND_TIME, PICKER_TYPE_TIME, PICKER_TYPE_DATE
`public static void log(String s)`	Prints to the log
`public static void log(Throwable s)`	Prints to the log
`public static void sendLog()`	Sends the log to your email account
`public static void sendMessage(String subject, Message msg, String... recipients)`	Send an email using the platform mail client.
`public static boolean isSimulator()`	Allows detecting development mode so debugging code and special cases can be used to simplify flow
`public static void addDefaultHeader(String key, String value)`	Adds a header to the global default headers, this header will be implicitly added to all requests going out from this point onwards.
`public static void addToQueueAndWait(ConnectionRequest request)`	Identical to add to queue but waits until the request is processed in the queue, this is useful for completely synchronous operations.
`public static void addToQueue(ConnectionRequest request)`	Adds the given network connection to the queue of execution
`public static void killAndWait(ConnectionRequest request)`	Kills the given request and waits until the request is killed if it is being processed by one of the threads.
`public static void addNetworkErrorListener(ActionListener<NetworkEvent> e)`	Adds a generic listener to a network error that is invoked before the exception is propagated.
`public static void removeNetworkErrorListener(ActionListener<NetworkEvent> e)`	Removes the given error listener
`public static void addNetworkProgressListener(ActionListener<NetworkEvent> al)`	Adds a listener to be notified when progress updates
`public static void removeNetworkProgressListener(ActionListener<NetworkEvent> al)`	Adds a listener to be notified when progress updates
`public static void updateNetworkThreadCount(int threadCount)`	Sets the number of network threads and restarts the network threads
`public static void clearStorageCache()`	Storage is cached for faster access, however this might cause a problem with refreshing objects since they are not cloned.
`public static void flushStorageCache()`	Flush the storage cache allowing implementations that cache storage objects to store
`public static void deleteStorageFile(String name)`	Deletes the given file name from the storage
`public static void clearStorage()`	Deletes all the files in the application storage
`public static` `OutputStream createStorageOutputStream(String name) throws IOException`	Creates an output stream to the storage with the given name
`public static` `InputStream createStorageInputStream(String name) throws IOException`	Creates an input stream to the given storage source file
`public static boolean existsInStorage(String name)`	Returns true if the given storage file exists
`public static` `String[] listStorageEntries()`	Lists the names of the storage files
`public static int storageEntrySize(String name)`	Returns the size in bytes of the given entry
`public static boolean writeObjectToStorage(String name, Object o)`	Writes the given object to storage assuming it is an externalizable type or one of the supported types.
`public static` `Object readObjectFromStorage(String name)`	Reads the object from the storage, returns null if the object isn’t there
`public static` `String[] getFileSystemRoots()`	Returns the filesystem roots from which the structure of the file system can be traversed
`public static int getFileSystemRootType(String root)`	Returns the type of the root often by guessing
`public static` `String[] listFiles(String directory) throws IOException`	Lists the files within the given directory, returns relative file names and not full file names.
`public static long getFileSystemRootSizeBytes(String root)`	Returns the size of the given root directory
`public static long getFileSystemRootAvailableSpace(String root)`	Returns the available space in the given root directory
`public static void mkdir(String directory)`	Creates the given directory
`public static void delete(String file)`	Deletes the specific file or empty directory.
`public static boolean existsInFileSystem(String file)`	Indicates whether a file exists
`public static boolean isHiddenFile(String file)`	Indicates the hidden state of the file
`public static void setHiddenFile(String file, boolean h)`	Toggles the hidden state of the file
`public static void renameFile(String file, String newName)`	Renames a file to the given name, expects the new name to be relative to the current directory
`public static long getFileLength(String file)`	Returns the length of the file
`public static long getFileLastModifiedFile(String file)`	Deprecated Returns the time that the file denoted by this abstract pathname was last modified.
`public static boolean isDirectory(String file)`	Indicates whether the given file is a directory
`public static` `OutputStream openFileOutputStream(String file) throws IOException`	Opens an output stream to the given file
`public static` `InputStream openFileInputStream(String file) throws IOException`	Opens an input stream to the given file
`public static` `OutputStream openFileOutputStream(String file, int offset) throws IOException`	Opens an output stream to the given file
`public static` `String getAppHomePath()`	The application home directory is a “safe place” to store files for this application in a portable way.
`public static boolean hasCachesDir()`	Returns true if the device has a directory dedicated for “cache” files
`public static` `String getCachesDir()`	Returns a device specific directory designed for cache style files, or null if `#hasCachesDir()` is false
`public static boolean canInstallOnHomescreen()`	Checks to see if you can prompt the user to install the app on their homescreen.
`public static boolean promptInstallOnHomescreen()`	Prompts the user to install this app on their homescreen.
`public static void onCanInstallOnHomescreen(Runnable r)`	A callback fired when you are allowed to prompt the user to install the app on their homescreen.
`public static` `Image captureScreen()`	Captures a screenshot of the screen.
`public static void addMessageListener(ActionListener<MessageEvent> l)`	Adds a listener to receive messages from the native platform.
`public static void removeMessageListener(ActionListener<MessageEvent> l)`	Removes a listener from receiving messages from the native platform.
`public static void postMessage(MessageEvent message)`	Posts a message to the native platform.
`public static` `Timer setTimeout(int timeout, Runnable r)`	Convenience method to schedule a task to run on the EDT after timeoutms.
`public static` `Timer setInterval(int timeout, Runnable r)`	Convenience method to schedule a task to run on the EDT after periodms repeating every periodms.
`public static` `BrowserComponent getSharedJavascriptContext()`	Gets a reference to an application-wide shared Javascript context that can be used for running Javascript commands.
`public static` `PluginSupport getPluginSupport()`	Returns the plugin support object for the current platform.

Inherited fields

Inherited methods

From Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait, clone

Field details

NATIVE_MAIN_THIN

public static final String NATIVE_MAIN_THIN = "native:MainThin"

Constant for the name of the main thin native font.

NATIVE_MAIN_LIGHT

public static final String NATIVE_MAIN_LIGHT = "native:MainLight"

Constant for the main light native font.

NATIVE_MAIN_REGULAR

public static final String NATIVE_MAIN_REGULAR = "native:MainRegular"

Constant for the main regular native font.

NATIVE_MAIN_BOLD

public static final String NATIVE_MAIN_BOLD = "native:MainBold"

Constant for the main bold native font.

NATIVE_MAIN_BLACK

public static final String NATIVE_MAIN_BLACK = "native:MainBlack"

Constant for the main black native font.

NATIVE_ITALIC_THIN

public static final String NATIVE_ITALIC_THIN = "native:ItalicThin"

Constant for the italic thin native font.

NATIVE_ITALIC_LIGHT

public static final String NATIVE_ITALIC_LIGHT = "native:ItalicLight"

Constant for the italic light native font.

NATIVE_ITALIC_REGULAR

public static final String NATIVE_ITALIC_REGULAR = "native:ItalicRegular"

Constant for the italic regular native font.

NATIVE_ITALIC_BOLD

public static final String NATIVE_ITALIC_BOLD = "native:ItalicBold"

Constant for the italic bold native font.

NATIVE_ITALIC_BLACK

public static final String NATIVE_ITALIC_BLACK = "native:ItalicBlack"

Constant for the italic black native font.