Class: ObjectEditor

Kekule.PropertyEditor. ObjectEditor

new ObjectEditor()

A property editor that to edit a object (not ObjectEx) property.
Source:

Extends

Methods

createEditWidget(parentWidget) → {Kekule.Widget.BaseWidget}

Create a custom edit widget and put old property value in it.
Parameters:
Name Type Description
parentWidget Kekule.Widget.BaseWidget
Inherited From:
Source:
Returns:
Type
Kekule.Widget.BaseWidget

doCreateEditWidget(parentWidget) → {Kekule.Widget.BaseWidget}

Do actual work of createEditWidget. Descendants should override this method.
Parameters:
Name Type Description
parentWidget Kekule.Widget.BaseWidget //@param {Variant} propValue
Inherited From:
Source:
Returns:
Type
Kekule.Widget.BaseWidget

getDescription() → {String}

Returns property description. Usually propInfo.description. Descendants seldom need to override this method.
Inherited From:
Source:
Returns:
Type
String

getEditWidget() → {Kekule.Widget.BaseWidget}

Returns currently created edit widget.
Inherited From:
Source:
Returns:
Type
Kekule.Widget.BaseWidget

getHint() → {String}

Returns property hint to display in object inspector. Usually this value is same with getTitle(). Descendants seldom need to override this method.
Inherited From:
Source:
Returns:
Type
String

getTitle() → {String}

Returns property title to display in object inspector. Usually propInfo.title or propInfo.name. Descendants seldom need to override this method.
Inherited From:
Source:
Returns:
Type
String

getValue() → {Variant}

Returns property value of all objects. Descendants may override this method.
Inherited From:
Source:
Returns:
Type
Variant

isReadOnly() → {Bool}

Whether the editor is a read only one.
Inherited From:
Source:
Returns:
Type
Bool

saveEditValue() → {Variant}

Save edit value in edit widget back to property. If the original value is not changed, false should be returned. Else true should be returned.
Inherited From:
Source:
Returns:
Type
Variant

setValue(value)

Save property value back to objects.
Parameters:
Name Type Description
value Variant
Inherited From:
Source:

Kekule.PropertyEditor. ObjectEditor

Methods

createEditWidget(parentWidget) → {Kekule.Widget.BaseWidget}

Create a custom edit widget and put old property value in it.
Parameters:
Name Type Description
parentWidget Kekule.Widget.BaseWidget
Inherited From:
Source:
Returns:
Type
Kekule.Widget.BaseWidget

doCreateEditWidget(parentWidget) → {Kekule.Widget.BaseWidget}

Do actual work of createEditWidget. Descendants should override this method.
Parameters:
Name Type Description
parentWidget Kekule.Widget.BaseWidget //@param {Variant} propValue
Inherited From:
Source:
Returns:
Type
Kekule.Widget.BaseWidget

getDescription() → {String}

Returns property description. Usually propInfo.description. Descendants seldom need to override this method.
Inherited From:
Source:
Returns:
Type
String

getEditWidget() → {Kekule.Widget.BaseWidget}

Returns currently created edit widget.
Inherited From:
Source:
Returns:
Type
Kekule.Widget.BaseWidget

getHint() → {String}

Returns property hint to display in object inspector. Usually this value is same with getTitle(). Descendants seldom need to override this method.
Inherited From:
Source:
Returns:
Type
String

getTitle() → {String}

Returns property title to display in object inspector. Usually propInfo.title or propInfo.name. Descendants seldom need to override this method.
Inherited From:
Source:
Returns:
Type
String

getValue() → {Variant}

Returns property value of all objects. Descendants may override this method.
Inherited From:
Source:
Returns:
Type
Variant

isReadOnly() → {Bool}

Whether the editor is a read only one.
Inherited From:
Source:
Returns:
Type
Bool

saveEditValue() → {Variant}

Save edit value in edit widget back to property. If the original value is not changed, false should be returned. Else true should be returned.
Inherited From:
Source:
Returns:
Type
Variant

setValue(value)

Save property value back to objects.
Parameters:
Name Type Description
value Variant
Inherited From:
Source: