[]
Sheets.Designer.AtomicComponentBase
Name |
---|
ValueType |
OptionsType |
• new AtomicComponentBase<ValueType
, OptionsType
>(host
, options
)
Represent a abstract class define atomical component.
Name |
---|
ValueType |
OptionsType |
Name | Type | Description |
---|---|---|
host |
HTMLElement |
This is the HTML area that the Component mounts. |
options |
OptionsType |
The component options. |
▸ getTemplate(options
): string
set inner html here. will invoke when mount host to DOM.
Name | Type |
---|---|
options |
OptionsType |
string
▸ onDestroy(host
): void
invoke when component will destroy.
Name | Type |
---|---|
host |
HTMLElement |
void
▸ onEnableChanged(prevEnable
, nextEnable
, host
, options
): void
Invoke this function when value status changed.
Name | Type |
---|---|
prevEnable |
boolean |
nextEnable |
boolean |
host |
HTMLElement |
options |
OptionsType |
void
▸ onInit(options
): void
invoke when component is initializing itself.
Name | Type |
---|---|
options |
OptionsType |
void
▸ onMounted(host
, options
): void
invoke when component's host is append to DOM tree.
Name | Type |
---|---|
host |
HTMLElement |
options |
OptionsType |
void
▸ onValueChanged(prevValue
, nextValue
, host
, options
): void
Invoke this function when enable status changed.
Name | Type |
---|---|
prevValue |
ValueType |
nextValue |
ValueType |
host |
HTMLElement |
options |
OptionsType |
void
▸ raiseValueChanged(): void
raise the value changed event to Designer, which will call the execute function of command.
void
▸ updateValue(host
, options
): ValueType
get the latest component value. Invoked when framework needs component value.
Name | Type |
---|---|
host |
HTMLElement |
options |
OptionsType |
ValueType