java.lang.Object
- com.iizigo.prop.BaseEditor<TooltipProp,KTooltip>
- - com.iizigo.prop.editor.TooltipPropEditor

All Implemented Interfaces:
IEditedPropControllerOwner<TooltipProp,KTooltip>, IEditedPropertyEntry<TooltipProp,KTooltip>, IEditedPropertyEntryMultiProp<TooltipProp,KTooltip>, IPropertyDefined
```
public class TooltipPropEditor
extends BaseEditor<TooltipProp,KTooltip>
```
The tooltip property editor.
A context menu is available when right-clicking on the icon. A double-click on it opens the Rich Text Editor or the Text Editor.
The option "plain" makes input limited to PLAIN KStrings and should be combined with PlainKStringProp. The option "message" makes editing and selection of the category possible.
Author:
Christopher Mindus

Field Summary
Fields
Modifier and Type Field Description
protected org.eclipse.swt.widgets.Listener caretListener
Selection listener to check for caret location.
- Fields inherited from class com.iizigo.prop.BaseEditor
  appUI, combo, control, controller, definedButton, display, editor, focusListener, hasBeenModified, info, more, multipleValueWarningInput, options, parent, propController, shell, text, validator, wasDefinedAtFocusGained

Constructor Summary
Constructors
Constructor Description
TooltipPropEditor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`checkGoto()`	Checks the goto-enablement from the selection.
`protected void`	`create()`	Creates the property editor controls.
`protected void`	`createTextAndTTCursorChange()`	Create the text and tooltip.
`protected boolean`	`doUndefineIfEmpty(boolean focusLost)`	Keeps empty strings as defined, when input has been changed specifically to empty string, or if the entry was defined when editing began.
`java.lang.String`	`formatValue(KTooltip value)`	Formats the value for user input as a String.
`protected int`	`getCaretPosition()`	Gets the selection from the text or combo.
`KTooltip`	`getDefaultValue()`	Gets the default defined value to set in the property when defined.
`protected java.lang.String`	`getToolTipText()`	Gets the tooltip text to display in the entry fields (not the one for property errors or validator).
`protected KTooltip`	`getValue(java.lang.String input)`	Gets the property value for a user input.
`protected void`	`onDoubleClick(org.eclipse.swt.widgets.Event e)`	Called when mouse is double-clicked in the text or combobox.
`void`	`onError(java.lang.String input, java.lang.String message, int severity, boolean isMultipleValueWarning, boolean isChildError)`	Called when the property is updated due to an error.
`void`	`onF4List()`	Called when F4 is pressed in a Text field.
`void`	`onUndefined()`	Called when the property is undefined.
`void`	`onUpdate(KTooltip value)`	Called when the property is updated without errors, with a new value.
`protected void`	`setInputValue(KTooltip value)`	Sets the new input value.
`protected void`	`setToolTipText(java.lang.String msg)`	Sets the tooltip text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - caretListener
```
protected final org.eclipse.swt.widgets.Listener caretListener
```
    Selection listener to check for caret location.
- Constructor Detail
  - TooltipPropEditor
```
public TooltipPropEditor()
```
- Method Detail
  - create
```
protected void create()
```
    Creates the property editor controls.
    Specified by:
    create in class BaseEditor<TooltipProp,KTooltip>
  - createTextAndTTCursorChange
```
protected void createTextAndTTCursorChange()
```
    Create the text and tooltip.
  - getCaretPosition
```
protected int getCaretPosition()
```
    Gets the selection from the text or combo.
  - checkGoto
```
protected void checkGoto()
```
    Checks the goto-enablement from the selection.
  - onDoubleClick
```
protected void onDoubleClick(org.eclipse.swt.widgets.Event e)
```
    Called when mouse is double-clicked in the text or combobox. Overridden to check if Goto reference is enabled, and if so goes there.
    Overrides:
    onDoubleClick in class BaseEditor<TooltipProp,KTooltip>
  - onF4List
```
public void onF4List()
```
    Called when F4 is pressed in a Text field.
    Overrides:
    onF4List in class BaseEditor<TooltipProp,KTooltip>
  - getToolTipText
```
protected java.lang.String getToolTipText()
```
    Gets the tooltip text to display in the entry fields (not the one for property errors or validator).
    Specified by:
    getToolTipText in class BaseEditor<TooltipProp,KTooltip>
  - setToolTipText
```
protected void setToolTipText(java.lang.String msg)
```
    Sets the tooltip text. The default is to apply the getToolTipText() text to the edit control.
    Overrides:
    setToolTipText in class BaseEditor<TooltipProp,KTooltip>
    Parameters:
    msg - Message in tooltip (normally error), null for none, in which case the getToolTipText2() is used.
  - getDefaultValue
```
public KTooltip getDefaultValue()
```
    Gets the default defined value to set in the property when defined.
    Specified by:
    getDefaultValue in interface IEditedPropControllerOwner<TooltipProp,KTooltip>
    Specified by:
    getDefaultValue in class BaseEditor<TooltipProp,KTooltip>
  - doUndefineIfEmpty
```
protected boolean doUndefineIfEmpty(boolean focusLost)
```
    Keeps empty strings as defined, when input has been changed specifically to empty string, or if the entry was defined when editing began.
    Overrides:
    doUndefineIfEmpty in class BaseEditor<TooltipProp,KTooltip>
  - getValue
```
protected KTooltip getValue(java.lang.String input)
                     throws KStringException
```
    Gets the property value for a user input.
    Specified by:
    getValue in class BaseEditor<TooltipProp,KTooltip>
    Parameters:
    input - The current user input.
    Returns:
    The property value for the input, or null to un-define the property.
    Throws:
    KStringException - For parsing errors.
  - formatValue
```
public java.lang.String formatValue(KTooltip value)
```
    Formats the value for user input as a String.
    Specified by:
    formatValue in interface IEditedPropControllerOwner<TooltipProp,KTooltip>
    Specified by:
    formatValue in class BaseEditor<TooltipProp,KTooltip>
    Parameters:
    value - The value.
    Returns:
    The formatted value.
  - setInputValue
```
protected void setInputValue(KTooltip value)
```
    Sets the new input value.
    Overrides:
    setInputValue in class BaseEditor<TooltipProp,KTooltip>
    Parameters:
    value - The value to set, null for empty.
  - onUpdate
```
public void onUpdate(KTooltip value)
```
    Called when the property is updated without errors, with a new value.
    Specified by:
    onUpdate in interface IEditedPropControllerOwner<TooltipProp,KTooltip>
    Overrides:
    onUpdate in class BaseEditor<TooltipProp,KTooltip>
  - onUndefined
```
public void onUndefined()
```
    Called when the property is undefined.
    Specified by:
    onUndefined in interface IEditedPropControllerOwner<TooltipProp,KTooltip>
    Overrides:
    onUndefined in class BaseEditor<TooltipProp,KTooltip>
  - onError
```
public void onError(java.lang.String input,
                    java.lang.String message,
                    int severity,
                    boolean isMultipleValueWarning,
                    boolean isChildError)
```
    Called when the property is updated due to an error.
    Specified by:
    onError in interface IEditedPropControllerOwner<TooltipProp,KTooltip>
    Overrides:
    onError in class BaseEditor<TooltipProp,KTooltip>

Class TooltipPropEditor

Field Summary

Fields inherited from class com.iizigo.prop.BaseEditor

Constructor Summary

Method Summary

Methods inherited from class com.iizigo.prop.BaseEditor

Methods inherited from class java.lang.Object

Field Detail

caretListener

Constructor Detail

TooltipPropEditor

Method Detail

create

createTextAndTTCursorChange

getCaretPosition

checkGoto

onDoubleClick

onF4List

getToolTipText

setToolTipText

getDefaultValue

doUndefineIfEmpty

getValue

formatValue

setInputValue

onUpdate

onUndefined

onError