mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
8f531ef622
Summary: Previously, ref/reflist columns were formatted entirely based on their visible column, since they received values from the visible or display columns rather than the actual row IDs. This creates `ReferenceFormatter` and `ReferenceListFormatter` which still delegate most of the formatting work to a visible column formatter but fix a few issues: - ReferenceList columns now actually use the options (e.g. date format) of the visible column to format their elements. Previously they were formatted generically because the visible column formatter wasn't expecting a list. - Invalid references aren't formatted with an `#Invalid Ref` prefix. - When the ref column displays the Row ID, it doesn't have a visible or display column. Previously this led to the references being formatted as just numbers in most cases, with special code in the widget to display them like `Table1[2]`. Now they are consistently formatted in that style throughout. Test Plan: Updated existing tests. Reviewers: jarek Reviewed By: jarek Subscribers: dsagal Differential Revision: https://phab.getgrist.com/D3212
93 lines
3.2 KiB
TypeScript
93 lines
3.2 KiB
TypeScript
/**
|
|
* NewAbstractWidget is equivalent to AbstractWidget for outside code, but is in typescript, and
|
|
* so is friendlier and clearer to derive TypeScript classes from.
|
|
*/
|
|
import {DocComm} from 'app/client/components/DocComm';
|
|
import {DocData} from 'app/client/models/DocData';
|
|
import {ViewFieldRec} from 'app/client/models/entities/ViewFieldRec';
|
|
import {SaveableObjObservable} from 'app/client/models/modelUtil';
|
|
import {cssLabel, cssRow} from 'app/client/ui/RightPanel';
|
|
import {colorSelect} from 'app/client/ui2018/ColorSelect';
|
|
import {BaseFormatter} from 'app/common/ValueFormatter';
|
|
import {Computed, Disposable, DomContents, fromKo, Observable} from 'grainjs';
|
|
|
|
|
|
export interface Options {
|
|
// A hex value to set the default widget text color. Default to '#000000' if omitted.
|
|
defaultTextColor?: string;
|
|
}
|
|
|
|
/**
|
|
* NewAbstractWidget - The base of the inheritance tree for widgets.
|
|
* @param {Function} field - The RowModel for this view field.
|
|
*/
|
|
export abstract class NewAbstractWidget extends Disposable {
|
|
/**
|
|
* Override the create() method to match the parameters of create() expected by FieldBuilder.
|
|
*/
|
|
public static create(field: ViewFieldRec) {
|
|
return Disposable.create.call(this as any, null, field);
|
|
}
|
|
|
|
protected options: SaveableObjObservable<any>;
|
|
protected valueFormatter: Observable<BaseFormatter>;
|
|
protected textColor: Observable<string>;
|
|
protected fillColor: Observable<string>;
|
|
|
|
constructor(protected field: ViewFieldRec, opts: Options = {}) {
|
|
super();
|
|
const {defaultTextColor = '#000000'} = opts;
|
|
this.options = field.widgetOptionsJson;
|
|
this.textColor = Computed.create(this, (use) => (
|
|
use(this.field.textColor) || defaultTextColor
|
|
)).onWrite((val) => this.field.textColor(val === defaultTextColor ? undefined : val));
|
|
this.fillColor = fromKo(this.field.fillColor);
|
|
|
|
this.valueFormatter = fromKo(field.formatter);
|
|
}
|
|
|
|
/**
|
|
* Builds the DOM showing configuration buttons and fields in the sidebar.
|
|
*/
|
|
public buildConfigDom(): DomContents { return null; }
|
|
|
|
/**
|
|
* Builds the transform prompt config DOM in the few cases where it is necessary.
|
|
* Child classes need not override this function if they do not require transform config options.
|
|
*/
|
|
public buildTransformConfigDom(): DomContents { return null; }
|
|
|
|
public buildColorConfigDom(): Element[] {
|
|
return [
|
|
cssLabel('CELL COLOR'),
|
|
cssRow(
|
|
colorSelect(
|
|
this.textColor,
|
|
this.fillColor,
|
|
// Calling `field.widgetOptionsJson.save()` saves both fill and text color settings.
|
|
() => this.field.widgetOptionsJson.save()
|
|
)
|
|
)
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Builds the data cell DOM.
|
|
* @param {DataRowModel} row - The rowModel object.
|
|
*/
|
|
public abstract buildDom(row: any): Element;
|
|
|
|
/**
|
|
* Returns the DocData object to which this field belongs.
|
|
*/
|
|
protected _getDocData(): DocData {
|
|
// TODO: There should be a better way to access docData and docComm, or better yet GristDoc.
|
|
return this.field._table.tableData.docData;
|
|
}
|
|
|
|
/**
|
|
* Returns the docComm object for communicating with the server.
|
|
*/
|
|
protected _getDocComm(): DocComm { return this._getDocData().docComm; }
|
|
}
|