Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/developer-guide/Advanced-Theming.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -261,12 +261,24 @@ SoftKey, Touch, Bar, Title, Right, Native
|hideLeftSideMenuBool
|Hides the side menu icon that appears on the left side of the UI

|hideRightSideMenuBool
|Hides the toolbar menu icon that appears on the right side of the title area

|ignorListFocusBool
|Hide the focus component of the list when the list doesn't have focus

|infiniteImage
|The image used by the infinite progress component, the component will rotate it as needed

|infiniteMaterialDesignSize
|Size (in millimeters) of the generated material design spinner when `InfiniteProgress` runs in material mode. Defaults to 6.667mm

|infiniteMaterialImageSize
|Size (in millimeters) of the generated spinner image when no custom `infiniteImage` is provided. Defaults to 7mm

|infiniteDefaultColor
|Hex RGB color used for the auto-generated material spinner when `infiniteImage` isn't supplied. Defaults to `777777`

|includeNativeBool
|True to derive from the platform native theme, false to create a blank theme that only uses the basic defaults

Expand Down Expand Up @@ -306,6 +318,9 @@ SoftKey, Touch, Bar, Title, Right, Native
|menuButtonTopBool
|When set to true this flag aligns the menu button to the top portion of the title. Defaults to false

|landscapeTitleUiidBool
|When true the toolbar swaps to landscape-specific UIIDs (such as `ToolbarLandscape`/`BackCommandLandscape`) for layout and icon styling

|menuHeightPercent
|Allows positioning and sizing the menu

Expand Down Expand Up @@ -342,6 +357,9 @@ SoftKey, Touch, Bar, Title, Right, Native
|menuWidthPercent
|Allows positioning and sizing the menu

|iosStyleBackArrowBool
|Renders the back command using the iOS-style chevron arrow (with a small icon gap) when the toolbar shows back text

|minimizeOnBackBool
|Indicates whether the form should minimize the entire application when the physical back button is pressed (if available) and no command is defined as the back command. Defaults to true

Expand All @@ -357,6 +375,12 @@ SoftKey, Touch, Bar, Title, Right, Native
|paintsTitleBarBool
|Indicates that the StatusBar UIID should be added to the top of the form to space down the title area, as is the case on iOS 7+ where the status bar is painted on top of the UI

|rightSideMenuImage
|Overrides the default icon used for the right-side toolbar menu button

|rightSideMenuPressImage
|Optional pressed-state icon for the right-side toolbar menu button

|popupCancelBodyBool
|Indicates that a cancel button should appear within the combo box popup

Expand Down
10 changes: 10 additions & 0 deletions docs/developer-guide/The-Components-Of-Codename-One.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,12 @@ This will show the dialog on the right hand side of the screen, which is pretty

NOTE: The `InteractionDialog` can only be shown at absolute or popup locations. This is inherent to its use case which is "non-blocking". When using this component you need to be very aware of its location.

To make popup behaviour feel natural on touch devices you can call `setDisposeWhenPointerOutOfBounds(true)` so the dialog auto-dismisses as soon as the user taps outside the title or content area. Internally the dialog listens for pointer pressed/released events and will call `dispose()` for you when the interaction happens beyond its bounds, so you no longer need to wire that logic manually.

By default the dialog is placed on the form's layered pane, but you can switch between the global layered pane and form-specific layered pane using `setFormMode(boolean)`. Setting form mode to `true` keeps the dialog coupled with the showing form even when the global layered pane is used elsewhere in your app.

Finally, recent updates added animation toggles so you can fine-tune presentation. `setAnimateShow(boolean)` turns the show/dispose animations on or off, while `setRepositionAnimation(boolean)` enables a "grow/shrink" reposition effect during those animations when you want a more dynamic transition.

[[label-section]]
=== Label

Expand Down Expand Up @@ -765,12 +771,14 @@ These varying looks are implemented via a combination of layouts, theme constant
There are several theme constants related that can manipulate some pieces of this functionality:

- `textComponentErrorColor` a hex RGB color which defaults to null in which case this has no effect. When defined this will change the color of the border and label to the given color to match the material design styling. This implements the red border underline in cases of error and the label text color change
- `textComponentErrorLineBorderBool` toggles the material-style underline that appears on validation errors. Set it to `false` if you prefer to supply a different border when errors are shown

- `textComponentOnTopBool` toggles the on top mode which makes things look like they do on Android. This defaults to true on Android and false on other OS's. This can also be manipulated via the `onTopMode(boolean)` method in `InputComponent` however the layout will only use the theme constant

- `textComponentAnimBool` toggles the animation mode which again can be manipulated by a method in `InputComponent`. If you want to keep the UI static without the floating hint effect set this to false. Notice this defaults to true only on Android

- `textComponentFieldUIID` sets the UIID of the text field to something other than `TextField` this is useful for platforms such as iOS where the look of the text field is different within the text component. This allows us to make the background of the text field transparent when it's within the `TextComponent` and make it different from the regular text field
- `inputComponentErrorMultilineBool` makes error labels multi-line by default so longer validation messages can wrap instead of being clipped


[[button-section]]
Expand Down Expand Up @@ -1049,6 +1057,8 @@ To customize everything you need to customize the UIID's for `MultiLine1`, `Mult

You can customize the individual `UIID's` thru the API directly using the `setIconUIID`, `setUIIDLine1`, `setUIIDLine2`, `setUIIDLine3`, `setUIIDLine4` & `setEmblemUIID`.

Recent versions also include a badge overlay that can be rendered in the corner of the main icon. Use `setBadgeText()` to display a value (for example a notification count) and `setBadgeUIID()` if you need a custom UIID instead of the default `Badge` styling. When you need to inspect or adjust the badge style programmatically, `getBadgeStyleComponent()` returns the component whose styles are applied to the badge so you can tweak padding, colors or borders before showing the `MultiButton`.


=== SpanButton

Expand Down