package com.smartgwt.client.types;


/*
 * Smart GWT (GWT for SmartClient)
 * Copyright 2008 and beyond, Isomorphic Software, Inc.
 *
 * Smart GWT is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.  Smart GWT is also
 * available under typical commercial license terms - see
 * http://smartclient.com/license
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 */
/* sgwtgen */
 
/**
 * Controls which formatting stages are applied to cell values during canvas {@link
 * com.smartgwt.client.widgets.grid.ListGrid#getPreRender ListGrid.preRender} rendering in "data" mode.
 */
public enum PreRenderFormatValues implements ValueEnum {
    /**
     * Raw record values only (<code>record[field.name]</code>). Fastest ? no formatting overhead.
     * <P>
     * If this enumerated value is used in a {@link com.smartgwt.client.docs.ComponentXML Component XML}
     * file or server-side DataSource descriptor (.ds.xml file), use the value "none".
     */
    NONE("none"),
    /**
     * Applies {@link com.smartgwt.client.widgets.grid.ListGridField#getValueMap valueMaps}, {@link
     * com.smartgwt.client.widgets.grid.ListGridField#getDisplayField displayField} substitution, {@link
     * com.smartgwt.client.widgets.grid.ListGridField#getFormat format strings}, and type-specific formatters via {@link
     * com.smartgwt.client.widgets.grid.ListGrid#getDefaultFormattedValue ListGrid.getDefaultFormattedValue()}. Does <b>not</b>
     * call custom {@link com.smartgwt.client.widgets.grid.ListGridField#setCellFormatter field.formatCellValue()} or {@link
     * com.smartgwt.client.widgets.grid.ListGrid#setCellFormatter grid.formatCellValue()}.
     * <P>
     * If this enumerated value is used in a {@link com.smartgwt.client.docs.ComponentXML Component XML}
     * file or server-side DataSource descriptor (.ds.xml file), use the value "default".
     */
    DEFAULT("default"),
    /**
     * Full formatting pipeline including custom {@link com.smartgwt.client.widgets.grid.ListGridField#setCellFormatter
     * field.formatCellValue()} and {@link com.smartgwt.client.widgets.grid.ListGrid#setCellFormatter grid.formatCellValue()}
     * methods. Any HTML tags in the result will appear as literal text in the canvas preview, since Canvas 2D cannot render
     * HTML. Slowest option.
     * <P>
     * If this enumerated value is used in a {@link com.smartgwt.client.docs.ComponentXML Component XML}
     * file or server-side DataSource descriptor (.ds.xml file), use the value "custom".
     */
    CUSTOM("custom");
    private String value;

    PreRenderFormatValues(String value) {
        this.value = value;
    }

    public String getValue() {
        return this.value;
    }
}
