# Class: modelit.ui.TextEditor

### Extends: modelit.ui.Jacontrol & modelit.ui.AbstractJacontrol & matlab.mixin.SetGet & handle & matlab.mixin.Heterogeneous

## DESCRIPTION:

A TextEditor is a text component that can display editable text. In the lower right corner the line and column position of the cursor is indicated. It is possible to show colored linenumbers with tooltips (TooltipSet). For example to show errors.

#

## Properties

BackgroundColor | RGB triple, default value is system dependent |
     The background color of the texteditor.
Busy | Boolean, default value: False |
     If true a indeterminate progress indicator appears on the faded texteditor.
     While this indicator is visible the texteditor is disabled.
BusyAction | cancel | {queue} |
     Callback queuing.
     Determines how MATLAB handles the execution of interrupting callbacks.
     A running callback is the currently executing callback. The interrupting callback is the callback that tries to interrupt the running callback.
     The BusyAction property of the interrupting callback determines how MATLAB handles its execution. When the BusyAction property is set to:
      'queue' ? Puts the interrupting callback in a queue to be processed after the running callback finishes execution.
      'cancel' ? Discards the interrupting callback as MATLAB finishes execution.
     For information about how the Interruptible property of the callback controls whether other callbacks can interrupt the running callback, see the Interruptible property description.
ChangeCallback | String, cell array or function handle, default value: [] |
     Function that should be executed when the document is changed,
     callback is only triggerd once. e.g. to indicate that save is not
     up to date anymore.
Children | The component's children. |
Clipping | clipping |
     Clipping mode.
     This property has no direct effect on the objects
     Use this property if you want to implement your own custom
ColorSet | Matrix Nx4, default value: [] |
     Colors for the linenumber.
     First column is an index (linenumber)
     Second, third and fourth column specify the RGB values for the corresponding index.
     The colorset is used to determine the color of every cell in the table by using the color index specified for every cell.
     Example: [1 0 1 0] to make the first linenumber green
ContentType | text/fix - fix (with fix formatting) |
     {text/plain} | text/html | text/rtf | text/matlab | text/fix
     text/plain - produces a wrapped plain text view.
     text/html - HTML text.
     text/rtf - RTF text.
     text/matlab - matlab (with matlab formatting)
Editable | Boolean, default value: true |
     Indicates if the texteditor is editable
Enable | {on} | inactive | off |
     Disable or enable the component.
     This property controls how components respond to user interaction.
     Possible values for this property:
      on ? The component is operational (the default).
      inactive ? The component is not operational, but looks the same as when Enable is on.
      off ? The component is not operational and is grayed out.
Extent | Width and height are the dimensions of the rectangle. All measurements are in units specified by the Units property. |
     Position rectangle (read only).
     A four-element vector that defines the size and position of the component.
     It has the form: [xpos,ypos,width,height]
     The first two elements are always zero are the component's position on the x- and y-axis. w
FontAngle | {normal} | italic |
     Setting this property to italic selects a slanted version of the component's font, when it is available on your system.
FontName | String, default is system dependent. |
     The name of the font in which to display the text in the components.
     To display and print properly, this must be a font that your system supports.
     Use listfonts to list all available system fontnames.
FontSize | Integer, default value is system dependent. |
     A number specifying the size in pixels of the component's font.
FontUnits | {points} | normalized | inches | centimeters | pixels |
     This property determines the units used by the FontSize property.
     Normalized units interpret FontSize as a fraction of the height of the uicontrol. When you resize the uicontrol, MATLAB modifies the screen FontSize accordingly.
     pixels, inches, centimeters, and points are absolute units (1 point = 1/72 inch).
FontWeight | {normal} | bold |
     Setting this property to bold selects a bold version of the component's font, when it is available on your system.
ForegroundColor | RGB triple, default value is system dependent |
     The foreground (text) color of the texteditor.
InfoLabel | Boolean, default value: False |
     Specifies if a label with info is visible in the lower right
     corner of the texteditor. This label shows information about the
     position of the caret.
InfoLabelFontAngle | {normal} | italic |
     Setting this property to italic selects a slanted version of the infolabel's font, when it is available on your system.
InfoLabelFontName | String, default is system dependent. |
     The name of the font in which to display the string in the infolabel.
     To display and print properly, this must be a font that your system supports.
     Use listfonts to list all available system fontnames.
InfoLabelFontSize | Integer, default value is system dependent. |
     A number specifying the size in pixels of the infolabel's font.
InfoLabelFontWeight | {normal} | bold |
     Setting this property to bold selects a bold version of the infolabel's font, when it is available on your system.
Interruptible | off | {on} |
     Callback routine interruption.
     Controls whether MATLAB can interrupt an object's callback function when subsequent callbacks attempt to interrupt it.
JavaHandle | Java object |
     The underlying java object.
     See javacomponent
MatlabHandle | Matlab handle |
     The handle of the associated Matlab container for this java object.
     See javacomponent
MaximumSize | Array, [width height] |
     The component's maximum size, measured in pixels.
     The preferred size indicates the best size for the component.
     The component should be no larger than its maximum size and no smaller than its minimum size.
     NOTE: Matlab may overrule this setting if the component is not in
     a Panel, ScrollPane, Toolbar, SplitPane or TabbedPane.
MinimumSize | Array, [width height] |
     The component's minimum size, measured in pixels.
     The preferred size indicates the best size for the component.
     The component should be no larger than its maximum size and no smaller than its minimum size.
     NOTE: Matlab may overrule this setting if the component is not in
     a Panel, ScrollPane, Toolbar, SplitPane or TabbedPane.rtain layout managers.
MouseClickedCallback | String, cell array or function handle, default value: [] |
     Specifies the function that should be executed when the mouse is clicked on the component
MouseEnteredCallback | String, cell array or function handle, default value: [] |
     Specifies the callback function that should be executed when the mouse enters the component.
MouseExitedCallback | String, cell array or function handle, default value: [] |
     Specifies the callback function that should be executed when the mouse exits the component.
NextFocusableComponent | Jacontrol, default value: [] |
     Specifies the next component to get the focus after this one.
     for example, when the tab key or shift-tab key is used.
Page | String, default value: '' |
     The current URL being displayed.
     The 'EditorContentType' is determined from the URL.
Parent | The component's parent. |
Position | Array, [width height] |
     Size and location of the component.
     The rectangle defined by this property specifies the size and location of the component within the parent.
     Specify Position as [left bottom width height]
     left and bottom are the distance from the lower-left corner of the parent object to the lower-left corner of the component.
     width and height are the dimensions of the component. All measurements are in units specified by the Units property.
PreferredSize | Array, [width height] |
     The component's preferred size, measured in pixels.
     The preferred size indicates the best size for the component.
     The component should be no larger than its maximum size and no smaller than its minimum size.
     NOTE: Matlab may overrule this setting if the component is not in
     a Panel, ScrollPane, Toolbar, SplitPane or TabbedPane.
String | String |
     Contents of the texteditor
Style | TextEditor (Read only) |
Tag | String, default value: '' |
     User specified object identifier.
     Use this tag i.c.w. gcjh('tag',parent) to find a modelit.ui.Jacontrol
TooltipSet | Cell array Nx2, default value: {} |
     Tooltips for linenumbers
     First column is an index, second column specifies the tooltipstring
     for the corresponding index.
     Example: {1, 'First line'} to put a tooltip for the first line
Type | Read only property fixed to 'Jacontrol' |
     String with the object type.
Units | {pixels} | normalized | inches | centimeters | points | characters |
     Used to interpret the extent and position properties.
     All units are measured from the lower-left corner of the parent object.
     Normalized units map the lower-left corner of the parent object to (0,0) and the upper-right corner to (1.0,1.0).
     pixels, inches, centimeters, and points are absolute units (1 point = 1/72 inch).
     Character units are characters using the default system font; the width of one character is the width of the letter x, the height of one character is the distance between the baselines of two lines of text.
     If you change the value of Units, it is good practice to return it to its default value after completing your computation so as not to affect other functions that assume Units is set to the default value.
Userdata | Array, default value: [] |
     User specified data for this modelit.ui.Jacontrol object
Visible | Off | {On} |
     Component visibility.
     By default, all jacontrols are visible. When set to off, the jacontrol is not visible, but still exists and you can query and set its properties.

# Public Method: cleanup

## DESCRIPTION:

Reset object fields to empty values, called by the destructor.

## CALL:

cleanup(obj)

## INPUT:

obj | any |
    modelit.ui.Jacontrol

## OUTPUT:

       No output

# Public Method: TextEditor

## DESCRIPTION:

modelit.ui.TextEditor constructor

## CALL:

obj = modelit.ui.TextEditor(parent, varargin)

## INPUT:

parent | any |
    handle of the TextEditor's parent e.g. gcf or modelit.ui.Panel
varargin | any |
    parameter-value pairs, see TextEditor properties for a
    description of the parameters and their values
    Documentation for modelit.ui.TextEditor/TextEditor
       doc modelit.ui.TextEditor

# Public Method: delete

### Inherited from modelit.ui.Jacontrol

## DESCRIPTION:

modelit.ui.Jacontrol destructor.

## CALL:

delete(obj)

## INPUT:

obj | any |
    modelit.ui.Jacontrol

## OUTPUT:

       No output

    Help for modelit.ui.TextEditor/delete is inherited from superclass MODELIT.UI.JACONTROL

# Public Method: isappdata

### Inherited from modelit.ui.Jacontrol

## DESCRIPTION:

True if application defined data exists.

## CALL:

value = isappdata(obj, name)

## INPUT:

obj | any |
    a modelit.ui.Jacontrol object
name | any |
    string with the name of the application data

## OUTPUT:

value | any |
        True if the application defined data exists
    Help for modelit.ui.TextEditor/isappdata is inherited from superclass MODELIT.UI.JACONTROL

# Public Method: getappdata

### Inherited from modelit.ui.Jacontrol

## DESCRIPTION:

Get application defined data.

## CALL:

value = getappdata(obj, name)

## INPUT:

obj | any |
    a modelit.ui.Jacontrol object
name | any |
    string with the name of the application data

## OUTPUT:

value | any |
        The application defined data
    Help for modelit.ui.TextEditor/getappdata is inherited from superclass MODELIT.UI.JACONTROL

# Public Method: setappdata

### Inherited from modelit.ui.Jacontrol

## DESCRIPTION:

Set application defined data.

## CALL:

setappdata(obj, name, value)

## INPUT:

obj | any |
    a modelit.ui.Jacontrol object
name | any |
    string with the name of the application data
value | any |
    value to be stored. May be anything

## OUTPUT:

       No output. The application-defined data,
       which is created if it does not already exist, is
       assigned a name and a value.

    Help for modelit.ui.TextEditor/setappdata is inherited from superclass MODELIT.UI.JACONTROL

# Public Method: ishandle

### Inherited from modelit.ui.Jacontrol

## DESCRIPTION:

Returns true if this is a valid graphics object

## CALL:

value = ishandle(obj)

## INPUT:

obj | any |
    a modelit.ui.Jacontrol object

## OUTPUT:

value | any |
        boolean: true if this is a valid graphics object
        What does "valid" mean in this context??
        Matlab HG object/container that holds still exist?
    Help for modelit.ui.TextEditor/ishandle is inherited from superclass MODELIT.UI.JACONTROL

# Public Method: java

### Inherited from modelit.ui.Jacontrol

## DESCRIPTION:

Returns the underlying Java object

## CALL:

jobj = java(obj)

## INPUT:

obj | any |
    a modelit.ui.Jacontrol object

## OUTPUT:

jobj | any |
        java object
    Help for modelit.ui.TextEditor/java is inherited from superclass MODELIT.UI.JACONTROL

# Public Method: handle

### Inherited from modelit.ui.Jacontrol

## DESCRIPTION:

Returns the handle of the component's Matlab container

## CALL:

h = handle(obj)

## INPUT:

obj | any |
    a modelit.ui.Jacontrol object

## OUTPUT:

h | any |
        handle of the component's Matlab container
    Help for modelit.ui.TextEditor/handle is inherited from superclass MODELIT.UI.JACONTROL

# Public Method: ancestor

### Inherited from modelit.ui.Jacontrol

## DESCRIPTION:

Returns the handle of the closest ancestor of obj that matches one of the types in type,

## CALL:

p = ancestor(obj, type)

## INPUT:

obj | any |
    modelit.ui.Jacontrol
type | any |
    String or cell array of strings (types)

## OUTPUT:

p | any |
          handle of the closest ancestor of the obj that matches one of the types in type
    Help for modelit.ui.TextEditor/ancestor is inherited from superclass MODELIT.UI.JACONTROL

# Protected Static Sealed Method: getDefaultScalarElement

### Inherited from modelit.ui.AbstractJacontrol

## DESCRIPTION:

Create a default object for heterogeneous arrays. Help for modelit.ui.TextEditor.getDefaultScalarElement is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL

# Public Sealed Method: ne

### Inherited from modelit.ui.AbstractJacontrol

## DESCRIPTION:

Not equal relation for handles. Help for modelit.ui.TextEditor/ne is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL

# Public Sealed Method: eq

### Inherited from modelit.ui.AbstractJacontrol

## DESCRIPTION:

Equal relation for handles. Help for modelit.ui.TextEditor/eq is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL

# Public Sealed Method: findobj

### Inherited from modelit.ui.AbstractJacontrol

## DESCRIPTION:

Returns the objects whose property values match those passed as param-value pairs to the findobj command. Help for modelit.ui.TextEditor/findobj is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL

# Public Sealed Method: set

### Inherited from modelit.ui.AbstractJacontrol

## DESCRIPTION:

Set object properties Help for modelit.ui.TextEditor/set is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL