This document describes the MIDP module architecture including:
This is the only true information document. What is not here in the document, does not exists at all!
All description is for MIDP-2.0 by default. All differences between MIDP-1.0 and MIDP-2.0 will be marked in place.
All properties, setters, actions and presenters are inherited from super component descriptor if not mentioned otherwise.
Deleting of a second component by a first component described in a "Actions|Delete" section means: to run the full deletion task using DeleteSupport.deleteComponent(component,setOfComponentsToDelete). This method at the any automatically removes the component from its parent.
Delete of component takes cares of the component deletion and unregistering the component from the structure around e.g.: DisplayableCD does not modify the commands property directly but CommandEventSourceCD does modify the commands property.
Reset-to-default functionality is available only if a property has non-null property value or its property descriptor allows null values.
TBD
MidpTypes class handles all the work with TypeIDs, including creation of PropertyValues of primitive types.
These components are general and are the base of whole MIDP-layer model.
Created by a file template only.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| version | String | MIDP-2.0 | no | no | MIDP-2.0, MIDP-1.0 | no, yes if there are other basic properties | yes | forever |
Setters
| Method Name | Parameters | Description | Version |
|---|
Actions
Presenters
Base descriptor of all class-based objects in a target language
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| instanceName | String | null | no | no | Instance name has to be always resolved by InstanceNameResolver | no | yes | FOREVER |
| lazy-init | boolean | true | no | no | no | yes | FOREVER |
Post-init: instanceName is an unique-instance-name in document based on ClassCode.getSuggestedMainName (component)
Settres
| Method Name | Parameters | Description | Version |
|---|
Actions
Presenters
Directly underneath the RootCD.
Actions
Presenters
Created in a file template only. Contains all CommandCDs in a file.
Actions
Presenters
Presenters
Created in a file template only. Contains all available EventListenerCD and dispathers components. Initially there are just EventListenerCD related to the class itself. Later there will be EventListenerCD related to other file e.g. commandAction would be generated to another file.
Actions
Presenters
Created in a file template only. Contains all DisplayableCDs in a file.
Actions
Presenters
Created in a file template only. Contains all available PointsCDs in a file.
Actions
Presenters
Created in a file template only. Contains all available ResourceCDs in a file.
Actions
Presenters
These components are location under DisplayablesCategoryCD only and represents a Displayable-based classes in MIDP.
Has CommandEventSources under itself - their order is defined by commands property.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| commands | CommandEventSourceCD... | empty-array | no | yes; no for array itself | - | no | yes | MIDP |
| ticker | TickerCD | null | yes | yes | - | no | yes | MIDP |
| title | String | null | yes | yes | - | yes | yes | MIDP |
| commandListener | CommandListenerCD | null | yes | yes | - | no | yes | MIDP |
Post-init: title is derived from instanceName, commandListener is the default command listener in the file represented by a "this" reference.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| addCommand | &commands:CommandCD | uses commands(index).command property | MIDP |
| setCommandListener | commandListener:CommandListenerCD | - | MIDP |
| setTicker | ticker:TickerCD | MIDP | |
| setTitle | title:String | MIDP |
Paremeter: title, ticker, commandParam, commandListenerParam
Actions
Presenters
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| fullScreenMode | boolean | false | no | yes | - | no | yes | MIDP-2.0 |
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| setFullScreenMode | fullScreenMode:boolean | MIDP-2.0 |
Paremeter: fullScreenMode
Actions
Presenters
Properties
Settres
Actions
Presenters
Created by a MidpProducer.Alert in Displayable/Alert.
Alert.DISMISS_COMMAND instance could not be modeled / used.
A special GaugeCD used as a alert indicator is placed under the Alert component.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| timeout | int | vary across implementation -> null | no | yes | FOREVER (-2) or any positive value (time in millis) | no | yes | MIDP |
| image | ImageCD | null | yes | yes | no | yes | MIDP | |
| indicator | GaugeCD | null (the gauge component is under the alert) | yes | yes | the special "under" Gauge or null | no | yes | MIDP-2.0 |
| string | String | null | yes | yes | yes | yes | MIDP | |
| type | AlertCD.TYPEID_ALERT_TYPE | null | yes | yes | null (no specific type), ALARM, CONFIRMATION, ERROR, INFO, WARNING | yes | yes | MIDP |
Post-init: timeout has some value -2 forever.
The indicator property will be shown as a check-box property (false = null, true = special "under" Gauge).
The GaugeCD as indicator will be created when the check-box is set to true. The indicator GaugeCD cannot be used anywhere else then just in the Alert under which it is placed. The GaugeCD.usedByAlert property of the indicator will be set to true. When the check-box is set to false, the indicator GuageCD is deleted.
The GaugeCD indicator component must be initialized that as: it must be non-interactive; it must not be owned by another container (Alert or Form); it must not have any Commands; it must not have an ItemCommandListener; it must not have a label (that is, its label must be null; its preferred width and height must both be unlocked; and its layout value must be LAYOUT_DEFAULT.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| Alert | title:String | MIDP | |
| Alert | title:String title, string:String, image:ImageCD, type:AlertCD.TYPEID_ALERT_TYPE | MIDP | |
| addCommand | alertCommand@commands:CommandCD | Similar to Displayable.addCommand(Command), however when the application first adds a command to an Alert, Alert.DISMISS_COMMAND is implicitly removed. | MIDP |
| setImage | image:ImageCD | MIDP | |
| setIndicator | indicator:GaugeCD | MIDP-2.0 | |
| setString | string:String | MIDP | |
| setTimeout | time:int | MIDP | |
| setType | type:AlertCD.TYPEID_ALERT_TYPE | MIDP |
Paremeter: timeout, image, indicator, string, type
Parameter: TODO - alertCommand (does the first command replacement)
Actions
Presenters
Created by a Displayables/Form producer. Has related Items under itself - their order is held by items property.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| items | ItemCD... | empty array | yes | yes, no for array itself | - | no | yes | MIDP |
| itemStateListener | ItemStateListenerCD | null | yes | yes | - | no | yes | MIDP |
Post-init: itemStateListener = midp-document-default listener in the file represented by a "this" reference.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| Form | title:String | MIDP | |
| Form | title:String, &items:ItemCD... | MIDP | |
| setItemStateListener | itemStateListener:ItemStateListenerCD ? | Sets the ItemStateListener for the Form, replacing any previous ItemStateListener. If iListener is null, simply removes the previous ItemStateListener. | MIDP |
| append | item@items:ItemCD | MIDP | |
| append | image:ImageCD | not used | MIDP |
| append | string:String | not used | MIDP |
| insert | itemNum:int, Item:ItemCD | Inserts an item into the Form just prior to the item specified. not used | MIDP |
| set | itemNum:int, Item:ItemCD | Sets the item referenced by itemNum to the specified item, replacing the previous item. The previous item is removed from this Form. not used | MIDP |
Parameter: item, itemStateListener
Actions
Presenters
Created by a Displayables/TextBox producer.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| text | String | null | yes | yes | - | yes | yes | MIDP |
| constraints | int | null | no | yes | see TextFieldCD constraints values | no | yes | MIDP + some values are MIDP-2.0 only |
| initialInputMode | String | null | yes | yes | see TextFieldCD initialInputMode values | no | yes | MIDP-2.0 |
| maxSize | int | depends of implementation -> null | no | yes | positive int | yes | yes | MIDP |
Post-init: maxSize = 100, constraints = TextFieldCD.CONSTRAINT_ANY
When changing the text, then asure the maxSize is bigger than the size of the text.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new TextBox | title:String, text:String, maxSize:int, constraints:int | MIDP | |
| setString | string:String | sets the text from string, replacing the previous value | MIDP |
| setConstraints | constraints:int | MIDP | |
| setInitialInputMode | initialInputMode:String | MIDP-2.0 | |
| setMaxSize | maxSize:int | MIDP | |
| delete | offset:int, length:int | deletes characters from the text. not used | MIDP |
| insert | data:char..., offset:int, length:int, position:int | inserts a subrange of an array of characters into the text. not used | MIDP |
| insert | string:String, position:int | inserts a string into the text. not used | MIDP |
| setChars | data:char..., offset:int, length:int | sets the text from a character array, replacing the previous value. not used | MIDP |
Parameter: text, maxSize, constraints, initialInputMode
Actions
Presenters
Created by a Displayables/List producer. It has a ListSelectCommandEventSource with default ListSelectCommandCD reference and with initial ListEventHandler underneath.
The ListEventHandler forwards code generation to all ListElementESs.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| listType | int | ChoiceCD.TYPE_IMPLICIT | no | yes | ChoiceCD.TYPE_IMPLICIT, ChoiceCD.TYPE_EXCLUSIVE, ChoiceCD.TYPE_MULTIPLE (and it does not allows ChoiceCD.POPUP) | yes | yes | MIDP |
| elements | ListElementCD... | empty-array | no | yes, no for the array itself | - | yes | yes | MIDP |
| fitPolicy | int | ChoiceCD.FIT_POLICY_TEXT_WRAP_DEFAULT | no | yes | ChoiceCD.FIT_POLICY_TEXT_WRAP_DEFAULT, ChoiceCD.FIT_POLICY_TEXT_WRAP_ON, ChoiceCD.FIT_POLICY_TEXT_WRAP_OFF | no | yes | MIDP-2.0 |
| selectCommand | CommandCD | ListCD.SELECT_COMMAND | yes | yes | - | no | yes | MIDP-2.0 |
| indexBasedSwitch | boolean | true | false | false | - | no | yes | MIDP |
If a selectCommand is set, then it has to be in commands array too (if it is not there, then add it).
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new List | title:String, listType:int | MIDP | |
| new List | title:String, listType:int, &ListElementCD.string:String, &ListElementCD.image:ImageCD | MIDP | |
| setFitPolicy | fitPolicy:int | MIDP-2.0 | |
| setSelectCommand | selectCommand:CommandCD | MIDP-2.0 | |
| setFont | listElementFont@ListElementCD.font:FontCD | if font is null, then not required | MIDP-2.0 |
| setSelectedFlags | &ListElementCD.selected:boolean | MIDP | |
| set, insert, append, delete, deleteAll | not used | MIDP | |
| setSelectedIndex | not used | MIDP |
Parameter: listType, fitPolicy, listElementString, listElementStringArray, listElementImage, listElementImageArray, listElementSelect, listElementSelectArray, special selectCommand
Parameter: command parameter is overriden to remove ListSelectCommandEventSource from the list of commands
Actions
Presenters
These components are used in ChoiceCD and ListCD. ListElementCD is no longer used - it is fully merged into ListElementEventSourceCD.
Created by Elements/Choice Element producer. Used by ChoiceGroupCD only. Always under ChoiceGroupCD.
TBD - what about commands, event sources, ...
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| string | String | null | no | yes | - | no, yes if there is another important property | yes | MIDP |
| image | ImageCD | null | yes | yes | - | no, yes if there is another important property | yes | MIDP |
| selected | boolean | false | no | yes | - | no, yes if there is another important property | yes | MIDP |
| font | FontCD | null | yes | yes | - | no | yes | MIDP-2.0 |
Post-init: resolved by the ChoiceGroupCD.accept/new/add itself: string = "Choice Element" + index in ChoiceGroupCD.element
Settres
| Method Name | Parameters | Description | Version |
|---|
Actions
Presenters
Commands are used by DisplayableCD, ItemCD, ... There is a repository of commands available in the document. All usages within the document are just referencing particular command component.
Some commands are "different" and cannot be used as a regular commands e.g List.SELECT_COMMAND. The CommandCD.ordinary == false then the command is "different" and is excluded from a set of regular commands, therefore it should not be visible as a option for setting/using.
Created by a particular Commands/Back Command, Exit Command, Item Command, Screen Command, Cancel Command, Help Command, OK Command, Stop Command producer.
CommandCD is placed under the CommandsCategoryCD only.
DisplayableCD has CommandEventSourceCDs underneath and these event sources are referencing the CommandCD.
ItemCD has ItemCommandEventSourceCDs underneath and these event sources are referencing the CommandCD.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| label | String | null | no | yes | - | yes | yes | MIDP |
| longLabel | String | null | yes | yes | - | no | yes | MIDP |
| type | int | null | no | yes | BACK, CANCEL, EXIT, HELP, ITEM, OK, SCREEN, STOP | yes | yes | MIDP |
| priority | int | 0 | no | yes | int | no | yes | MIDP |
| ordinary | boolean | true | no | no | true, false | no | no | FOREVER |
Post-init: is done by CommandProducer only: instance-name = typeCommandIndex, label = instance-name, type = type
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| Command | label:String, type:int, priority:int | ||
| Command | label:String, longLabel:String, type:int, priority:int |
Parameter: label, longLabel, type, priority
Actions
Presenters
This component is created by the file template only and there is only one component in whole document.
It is not ordinary command.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Post-init: label = "", type = screen, priority = 0
Post-init: ordinary = false - this prevent the list-select-command to be used as an ordinary command within the designer.
Settres
| Method Name | Parameters | Description | Version |
|---|
Actions
Presenters
Does not inherit any presenter from CommandCD.
Items are used in the FormCD only.
For MIDP-1.0, layout property does not exist except for StringItem, ImageItem.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| label | String | null | yes | yes | - | yes | yes | MIDP |
| layout | int | LAYOUT_DEFAULT | no | yes | LAYOUT_BOTTOM, LAYOUT_CENTER, LAYOUT_DEFAULT, LAYOUT_EXPAND, LAYOUT_LEFT, LAYOUT_NEWLINE_AFTER, LAYOUT_NEWLINE_BEFORE, LAYOUT_RIGHT, LAYOUT_SHRINK, LAYOUT_TOP, LAYOUT_VCENTER, LAYOUT_VEXPAND, LAYOUT_VSHRINK | no | yes | MIDP |
| itemCommands | ItemCommandEventSourceCD... | empty-array | no | yes; no for array itself | - | no | yes | MIDP-2.0 |
| defaultCommand | ItemCommandEventSourceCD | null | yes | yes | - | no | yes | MIDP-2.0 |
| preferredHeight | int | -1 | no | yes | greater or equal than -1 | no | yes | MIDP-2.0 |
| preferredWidth | int | -1 | no | yes | greater or equal than -1 | no | yes | MIDP-2.0 |
| itemCommandListener | ItemCommandListenerCD | null | yes | yes | - | no | yes | MIDP-2.0 |
Post-init: label = instance-name, itemCommandListener = the midp document default of a item-command-listener representing "this"
When a defaultCommand is set then it has to exist in itemCommands property. If not then it has to be added there.
The layout property depends on a component and a version. Use default value to prevent setLayout method generation for invalid cases.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| addCommand | &itemCommands.command:CommandCD | MIDP-2.0 | |
| setItemCommandListener | commandListener:ItemCommandListenerCD | MIDP-2.0 | |
| setDefaultCommand | defaultCommand.command:CommandCD | MIDP-2.0 | |
| setLabel | label:String | MIDP | |
| setLayout | layout:int | MIDP | |
| setPreferredSize | width:int, height:int | MIDP-2.0 |
Parameter: label, layout, itemCommand, defaultCommand, itemCommandListener, preferredWidth, preferredHeight
Actions
Presenters
Created by Items/Choice Group producer. Contains ChoiceElementCD underneath.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| choiceType | int | ChoiceCD.MULTIPLE | no | yes | ChoiceCD.EXCLUSIVE, ChoiceCD.MULTIPLE, ChoiceCD.POPUP | yes | yes | MIDP |
| elements | ChoiceElementCD... | empty-array | no | no | - | no | yes | MIDP |
| fitPolicy | int | ChoiceCD.FIT_POLICY_TEXT_WRAP_DEFAULT | no | yes | ChoiceCD.FIT_POLICY_TEXT_WRAP_DEFAULT, ChoiceCD.FIT_POLICY_TEXT_WRAP_ON, ChoiceCD.FIT_POLICY_TEXT_WRAP_OFF | no | yes | MIDP-2.0 |
Settres
| Method Name | Parameters | Description | Version | |
|---|---|---|---|---|
| new ChoiceGroup | label:String, choiceType:int | MIDP | ||
| new ChoiceGroup | label:String, choiceType:int, &ChoiceElementCD.string:String, &ChoiceElementCD.image:ImageCD | MIDP | ||
| setSelectedFlags | &ChoiceElementCD.selected:boolean | MIDP | ||
| setFont | index, &ChoiceElementCD.font:FontCD | if font is null, then not required | MIDP-2.0 | |
| setFitPolicy | fitPolicy:int | MIDP-2.0 | ||
| set, insert, append, delete, deleteAll | not used | MIDP | ||
| setSelectedIndex | not used | MIDP |
Parameter: choiceType, fitPolicy, string, image, font, selectedArray, stringArray, imageArray
Actions
Presenters
Created by Items/Gauge producer. The Gauge is placed under the related Form.
If the GaugeCD.usedByAlert == true, then there are various restrictions for the property values. Also this special gauge will be placed under AlertCD.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| usedByAlert | boolean | false | no | no | - | no | no | FOREVER |
| interactive | boolean | false | no | yes | - | yes | yes | MIDP |
| value | int | null | no | yes | for non-interactive: GaugeCD.CONTINUOUS_IDLE, GaugeCD.INCREMENTAL_IDLE, GaugeCD.CONTINUOUS_RUNNING, GaugeCD.INCREMENTAL_UPDATING, for interactive: int | yes | yes | MIDP |
| maxValue | int | null | no | yes | for non-interactive: GaugeCD.VALUE_INDEFINITE, for interactive: int | yes | yes | MIDP |
Post-init: value = 50, maxValue = 100
When maxValue == INDEFINITE then value must be one of GaugeCD.CONTINUOUS_IDLE, GaugeCD.INCREMENTAL_IDLE, GaugeCD.CONTINUOUS_RUNNING, GaugeCD.INCREMENTAL_UPDATING.
If usedByAlert is set then: it must be non-interactive; it must not be owned by another container (Alert or Form); it must not have any Commands; it must not have an ItemCommandListener; it must not have a label (means its label must be null); its preferred width and height must both be unlocked; and its layout value must be LAYOUT_DEFAULT.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new Gauge | label:String, interactive:boolean, maxValue:int, value:int | MIDP | |
| setValue | value:int | only for interactive | MIDP |
| setMaxValue | maxValue:int | only for interactive | MIDP |
Parameter: interactive, value, maxValue
Actions
Presenters
Created by Items/Spacer producer.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| minWidth | int | 16 | no | yes | zero int or greater | no, yes if there is another important property | yes | MIDP-2.0 |
| minHeight | int | 1 | no | yes | zero int or greater | no, yes if there is another important property | yes | MIDP-2.0 |
Post-init: label = null
The minWidth and minHeight must be greater or equal to zero.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new Spacer | minWidth:int, minHeight:int | MIDP-2.0 | |
| setMinimumSize | minWidth:int, minHeight:int | MIDP-2.0 |
Actions
Presenters
Created by Items/TextField producer.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| text | String | null | yes | yes | - | yes | yes | MIDP |
| constraints | int | null | no | yes | CONSTRAINT_EMAILADDR, CONSTRAINT_NUMERIC, CONSTRAINT_PHONENUMBER, CONSTRAINT_URL, CONSTRAINT_DECIMAL | yes | yes | MIDP |
| initialInputMode | String | null | yes | yes | - | no | yes | MIDP-2.0 |
| maxSize | int | default is null | no | yes | positive int | no? | yes | MIDP |
Post-init: initial = 32, constraint = CONSTRAINT_ANY
When modifying text, then asure maxSize to fit it, when modifying maxSize allow even shorter size that the text length
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new TextField | label:String, text:String, maxSize:int, constraints:int | MIDP | |
| setConstraints | constraints:int | MIDP | |
| setMaxSize | maxSize:int | MIDP | |
| setInitialInputMode | initialInputMode:String | MIDP-2.0 | |
| delete | offset:int, length:int | deletes characters from the text. not used | MIDP |
| insert | data:char..., offset:int, length:int, position:int | inserts a subrange of an array of characters into the text. not used | MIDP |
| insert | string:String, position:int | inserts a string into the text. not used | MIDP |
| setChars | data:char..., offset:int, length:int | sets the text from a character array, replacing the previous value. not used | MIDP |
| setString | string:String | sets the text from string, replacing the previous value. not used | MIDP |
Parameter: text, maxSize, initialInputMode, constraints
Actions
Presenters
Created by Items/DateField producer.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| date | long | null | yes | yes | - | yes | yes | MIDP |
| mode | int | null, initial: DATE | no | yes | MODE_DATE, MODE_DATE, MODE_DATE_TIME | yes | yes | MIDP |
| timeZone | String | null | yes | yes | null | no | yes | MIDP |
Post-init: date = USERCODE: new Date (System.currentTimeMillis()) , mode = DATE_TIME
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new DateField | label:String, mode:int | MIDP | |
| new DateField | label:String, mode:int, timeZone:TimeZone | MIDP | |
| setDate | date:long | MIDP | |
| setInputMode | mode:int | MIDP |
Parameter: mode, date, timeZone
Actions
Presenters
Created by Items/ImageItem producer. Producer should ask for the ImageCD.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| image | ImageCD | null | yes | yes | - | yes + image resource path editor | yes | MIDP |
| altText | String | null | yes | yes | - | no | yes | MIDP |
| appearanceMode | int | ItemCD.APPEARANCE_PLAIN | no | yes | ItemCD.APPEARANCE_PLAIN, ItemCD.APPEARANCE_BUTTON, ItemCD.APPEARANCE_HYPERLINK | no | yes |
Post-init: TBD - altText = "<Missing image>"
Forward property editor for image.imageResource property editor.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new ImageItem | label:String, image:ImageCD, layout:int, altText:String | MIDP | |
| new ImageItem | label:String, image:ImageCD, layout:int, altText:String, appearanceMode:int | MIDP-2.0 | |
| setAltText | altText:String | MIDP | |
| setImage | img:ImageCD | MIDP |
Parameter: image, altText, appearanceMode
Actions
Presenters
Created by Items/StringItem producer.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| text | String | null | yes | yes | - | yes | yes | MIDP |
| appearanceMode | int | ItemCD.APPEARANCE_PLAIN | no | yes | ItemCD.APPEARANCE_PLAIN, ItemCD.APPEARANCE_BUTTON, ItemCD.APPEARANCE_HYPERLINK | no | yes | MIDP-2.0 |
| font | FontCD | null | yes | yes | - | no | yes | MIDP |
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new StringItem | label:String, text:String | MIDP | |
| new StringItem | label:String, text:String, appearanceMode:int | MIDP-2.0 | |
| setText | text:String | MIDP | |
| setFont | font:FontCD | MIDP-2.0 |
Parameter: text, appearanceMode, font
Actions
Presenters
Resource component are used at various placed and there are used as references. All resources are ClassCD based.
A marker component. All resources are based on ClassCD.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Settres
| Method Name | Parameters | Description | Version |
|---|
Actions
Presenters
Created by Resources/Image producer. TODO - the producer should ask for the image resource otherwise it should cancel creation.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| resourcePath | String | null | yes | yes | - | yes | yes | MIDP |
If no image is set, then resourcePath should be null.
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| Image.createImage | resourcePath:String | MIDP | |
| Image.createImage | nullResourcePath:int,int | if resourcePath is null then use "0,0" as parameters | MIDP |
Parameter: resourcePath, nullResourcePath (CODE: ("0, 0"))
Actions
Presenters
Created by Resources/Font producer.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| face | int | FACE_SYSTEM | no | yes | FACE_SYSTEM, FACE_MONOSPACE, FACE_PROPORTIONAL | no, yes if there are other basic properties | yes | MIDP |
| style | int | STYLE_PLAIN | no | yes | STYLE_PLAIN, STYLE_BOLD, STYLE_ITALIC, STYLE_UNDERLINED | no, yes if there are other basic properties | yes | MIDP |
| size | int | SIZE_MEDIUM | no | yes | SIZE_MEDIUM, SIZE_SMALL, SIZE_LARGE | no, yes if there are other basic properties | yes | MIDP |
| kind | int | KIND_DEFAULT | no | no | KIND_DEFAULT, KIND_CUSTOM, KIND_STATIC, KIND_INPUT | no, yes if there are other basic properties | yes | MIDP |
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| Font.getFont | face:int, style:int, size:int | MIDP | |
| Font.getFont | kind:int | MIDP | |
| Font.getDefaultFont | MIDP |
Just single setter descriptor for all cases - the values depends on
Actions
Presenters
Created by Resources/Ticker producer.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| text | String | empty string | no | yes | - | yes | yes | MIDP |
Settres
| Method Name | Parameters | Description | Version |
|---|---|---|---|
| new Ticker | text:String | MIDP | |
| setString | text:String | MIDP |
Parameter: text
Actions
Presenters
The Event Sources are places in a target application where events may be fired. On those places there are an action is invoked. The actions are specified by related Event Handlers.
Has an event handler directly underneath. Even through right now there is a single event handler related/underneath the event source, there may be more event handlers registered in the future.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| eventHandler | EventHandlerCD | null | yes | no | - | yes | yes | FOREVER |
The eventHandler has a complex property editor. The editor will be extensible (using global lookup) and allows to edit/create a event handler which will be assigned to the event source.
Actions
Presenters
Created by accept presenter of the DisplayableCD when accepting a command.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| displayable | DisplayableCD | null | no | no | - | no | yes - readonly | MIDP |
| command | CommandCD | null | no | no | - | no | yes - readonly | MIDP |
The displayable and command property has to be final and set by the DisplayableCD.accept presenter only.
Its should also show all properties of related Command.
Actions
Presenters
Creates by accept presenter of ItemCD when accepting a command.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| item | ItemCD | null | no | no | - | no | no | |
| command | CommandCD | null | no | no | - | no | no |
The item and command property has to be final and set by the ItemCD.accept presenter only.
Its should also show all properties of related Command.
Actions
Presenters
Created by the ListCD producer together with an initial ListActionEventHandler.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| showSelectCommand | boolean | false | no | no | - | no | yes | MIDP |
It should not show any properties of related Command.
Actions
Presenters
Created by Elements/List Element producer. ListElementEventSource is directly underneath a ListCD.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| string | String | null | no | yes | - | no, yes if there is another important property | yes | MIDP |
| image | ImageCD | null | yes | yes | - | no, yes if there is another important property | yes | MIDP |
| selected | boolean | false | no | yes | - | no, yes if there is another important property | yes | MIDP |
| font | FontCD | null | yes | yes | - | no | yes | MIDP-2.0 |
Post-init: resolved by the ListCD.accept/new/add itself: string = "List Element " + index in ListCD.element
Its should also show all properties of related List Element (parent component).
Actions
Presenters
Created in the VisualMidlet template file. The MobileDevice is always the parent component.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
Created in the VisualMidlet template file. The MobileDevice is always the parent component.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
Created by Flow/If producers. It is always the one instance under the IfPointCD and assigned to it too.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
Created by Flow/If producers. It is always the one instance under the IfPointCD and assigned to it too.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| option | javaCode | null | yes | yes | - | no | yes | FOREVER |
The option property is resolved by the SwitchPointCD.accept presenter.
Actions
Presenters
Created by Flow/EntryPoint producer. The only component under EntryPointCD and is assigned to it.
Actions
Presenters
Holds the action that is performed on a particular placed specified by EventSource where a handler is assigned.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| eventSource | EventSourceCD | null | no | no | - | no | no | FOREVER |
The eventSource is set automatically by MidpDocumentSupport.assignUpdateEventHandler(EventSource,newEventHandler)
Actions
Presenters
Created by MobileDevice-EventHandlerCreator.
Available only when a document has MobileDeviceCD.
TODO - Maybe created by a producer and put into the palette.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| mobileDevice | MobileDeviceCD | null | no | no | - | no | no | MIDP |
The mobileDevice property is resolved by the MobileDevice-EventHandlerCreator
Actions
Presenters
Created by CallPointEventHandlerCreator on CallPoint.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| callPoint | CallPointCD | null | no | no | - | no | no | MIDP |
The callPoint is set by the creator.
Actions
Presenters
Created by MethodPointEventHandlerCreator on MethodPoint.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| methodPoint | MethodPointCD | null | no | no | - | no | no | FOREVER |
The methodPoint is set by the creator.
Actions
Presenters
Created by SwitchDisplayableEventHandlerCreator on DisplayableCD.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| displayable | DisplayableCD | null | no | no | - | yes | yes | |
| alert | AlertCD | null | yes | no | - | yes | yes |
The displayable property is set by the EventHandlerCreator.
Actions
Presenters
Created by the producer.
The related list is the one that is the parent of the parent component of this component. This is ListEventHandlerCD under CommandEventSourceCD under DisplayableCD.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
TODO - not implemented yet - requires a MenuScreenController or smth.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
Points are places in the target application which may be invoked and usually they are specifying the interface between the target application and its environment.
A marker component only.
Actions
Presenters
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| accessCode | JavaCode | - | false | false | no | yes | FOREVER |
Post-Init: accessCode = ""
Actions
Presenters
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| method | String | - | no | no | valid method name | yes | yes | MIDP |
Actions
Presenters
Created by Flow|EntryPoint producer. The producer creates a EntryStartEventSource underneath too and assigns it.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| start | EntryStartEventSourceCD | null | no | no | - | no | no |
The start property is initialized by producer.
Actions
Presenters
One IfTrueEventSourceCD and one IfFalseEventSourceCD is always created together with IfPointCD by producer.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| condition | javaCode | null | no | no | - | yes | yes | FOREVER |
| true | IfTrueEventSourceCD | null | no | no | - | no | no | FOREVER |
| false | IfFalseEventSourceCD | null | no | no | - | no | no | FOREVER |
Post-init: condition = "true"
Actions
Presenters
SwitchCaseEventSourceCD are added directly underneath.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| operand | javaCode | null | no | no | - | yes | yes | FOREVER |
| cases | SwitchCaseEventSourceCD... | empty-array | no | yes, no for array itself | - | no | yes | FOREVER |
Post-init: Operand = 0
Actions
Presenters
One MobileDeviceStartEventSourceCD and one MobileDeviceResumeEventSourceCD is always created together with MobileDeviceCD and it is created in the file template only.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|---|---|---|---|---|---|---|---|
| start | MobileDeviceStartEventSourceCD | null | no | no | - | no | no | FOREVER |
| resume | MobileDeviceResumeEventSourceCD | null | no | no | - | no | no | FOREVER |
The start and resume property are resolved by the file template.
Actions
Presenters
Created in the Visual* template files. Single instance per whole document.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
This listeners represents the listener methods implementation and dispatches the action to each event source.
This is a marker interface for all event listeners.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters
Representes a CommandListener interface implementation. Created by a file template with "this" reference.
Properties
| Name | TypeID | Default Value | IsNull | IsUserCode | Values | Is basic | Is advanced | Version |
|---|
Actions
Presenters