/*
 * 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 */
 
package com.smartgwt.client.tools;


import com.smartgwt.client.event.*;
import com.smartgwt.client.core.*;
import com.smartgwt.client.types.*;
import com.smartgwt.client.data.*;
import com.smartgwt.client.data.Record;
import com.smartgwt.client.data.events.*;
import com.smartgwt.client.browser.window.*;
import com.smartgwt.client.rpc.*;
import com.smartgwt.client.ai.*;
import com.smartgwt.client.callbacks.*;
import com.smartgwt.client.tools.*;
import com.smartgwt.client.bean.*;
import com.smartgwt.client.widgets.*;
import com.smartgwt.client.widgets.ai.*;
import com.smartgwt.client.widgets.events.*;
import com.smartgwt.client.widgets.form.*;
import com.smartgwt.client.widgets.form.validator.*;
import com.smartgwt.client.widgets.form.fields.*;
import com.smartgwt.client.widgets.tile.*;
import com.smartgwt.client.widgets.tile.events.*;
import com.smartgwt.client.widgets.grid.*;
import com.smartgwt.client.widgets.grid.events.*;
import com.smartgwt.client.widgets.chart.*;
import com.smartgwt.client.widgets.layout.*;
import com.smartgwt.client.widgets.layout.events.*;
import com.smartgwt.client.widgets.menu.*;
import com.smartgwt.client.widgets.tour.*;
import com.smartgwt.client.widgets.notify.*;
import com.smartgwt.client.widgets.rte.*;
import com.smartgwt.client.widgets.rte.events.*;
import com.smartgwt.client.widgets.ace.*;
import com.smartgwt.client.widgets.ace.events.*;
import com.smartgwt.client.widgets.tab.*;
import com.smartgwt.client.widgets.toolbar.*;
import com.smartgwt.client.widgets.tree.*;
import com.smartgwt.client.widgets.tree.events.*;
import com.smartgwt.client.widgets.tableview.*;
import com.smartgwt.client.widgets.viewer.*;
import com.smartgwt.client.widgets.calendar.*;
import com.smartgwt.client.widgets.calendar.events.*;
import com.smartgwt.client.widgets.cube.*;
import com.smartgwt.client.widgets.notify.*;
import com.smartgwt.client.widgets.drawing.*;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import com.google.gwt.event.shared.*;
import com.google.gwt.dom.client.Element;
import com.google.gwt.user.client.ui.Widget;
import com.google.gwt.core.client.JavaScriptObject;

import com.smartgwt.client.util.*;
import com.smartgwt.client.util.events.*;
import com.smartgwt.client.util.workflow.*;
import com.smartgwt.client.util.workflow.Process; // required to override java.lang.Process
import com.smartgwt.client.util.tour.*;


/**
 * {@link com.smartgwt.client.tools.EditProxy} that handles {@link com.smartgwt.client.widgets.viewer.DetailViewer}
 * components when editMode is enabled.
 * @see com.smartgwt.client.docs.DevTools Dashboards & Tools Framework Overview
 */
@BeanFactory.FrameworkClass
@BeanFactory.ScClassName("DetailViewerEditProxy")
public class DetailViewerEditProxy extends CanvasEditProxy {

    public static DetailViewerEditProxy getOrCreateRef(JavaScriptObject jsObj) {
        if(jsObj == null) return null;
        BaseClass obj = BaseClass.getRef(jsObj);
        if(obj != null) {
            return (DetailViewerEditProxy) obj;
        } else {
            return new DetailViewerEditProxy(jsObj);
        }
    }
        


    public DetailViewerEditProxy(){
        scClassName = "DetailViewerEditProxy";
    }

    public DetailViewerEditProxy(JavaScriptObject jsObj){
        scClassName = "DetailViewerEditProxy";
        setJavaScriptObject(jsObj);
    }

    public native JavaScriptObject create()/*-{
        var config = this.@com.smartgwt.client.core.BaseClass::getConfig()();
        var scClassName = this.@com.smartgwt.client.core.BaseClass::scClassName;
        return $wnd.isc[scClassName].create(config);
    }-*/;


    // ********************* Properties / Attributes ***********************

    /**
     * If {@link com.smartgwt.client.tools.EditProxy#getInlineEditEvent inline editing} for this viewer edits the
     * {@link com.smartgwt.client.widgets.viewer.DetailViewer#getData DetailViewer.data}, character that should be used as a
     * separator for
     *  entering {@link com.smartgwt.client.types.ValueMap}-style entries that map from a field name to a value.
     *  <p>
     *  With the default of ":", the following input:
     *  <pre>
     *       1:Fixed, 2:Won't Fix, 3:Resolved
     *  </pre>
     *  Would be assumed to be a mapping like this (expressed in JSON):
     *  <pre>
     *    {
     *       "1" : "Fixed",
     *       "2" : "Won't Fix",
     *       "3" : "Resolved"
     *    }
     *  </pre>
     *  <p>
     *  Any entry without a separator char has an implied value of <code>null</code>.
     *  For example, for this input:
     *  <pre>
     *        Fixed:Reported Fixed, WontFix:Won't Fix, Resolved
     *  </pre>
     *  The resulting <code>data</code> would be:
     *  <pre>
     *    {
     *       "Fixed" : "Reported Fixed",
     *       "WontFix" : "Won't Fix",
     *       "Resolved" : null
     *    }
     *  </pre>
     *  <p>
     * The {@link com.smartgwt.client.tools.DetailViewerEditProxy#getDataEscapeChar dataEscapeChar} can be used to enter
     * literal colon characters.
     *  <p>
     *  Set <code>dataDisplaySeparatorChar</code> to null to prevent entry of values
     *  - user input will always be treated as just a list of legal field names.
     *
     * @param dataDisplaySeparatorChar New dataDisplaySeparatorChar value. Default value is ":"
     * @return {@link com.smartgwt.client.tools.DetailViewerEditProxy DetailViewerEditProxy} instance, for chaining setter calls
     * @throws IllegalStateException this property cannot be changed after the underlying component has been created
     */
    public DetailViewerEditProxy setDataDisplaySeparatorChar(String dataDisplaySeparatorChar)  throws IllegalStateException {
        return (DetailViewerEditProxy)setAttribute("dataDisplaySeparatorChar", dataDisplaySeparatorChar, false);
    }

    /**
     * If {@link com.smartgwt.client.tools.EditProxy#getInlineEditEvent inline editing} for this viewer edits the
     * {@link com.smartgwt.client.widgets.viewer.DetailViewer#getData DetailViewer.data}, character that should be used as a
     * separator for
     *  entering {@link com.smartgwt.client.types.ValueMap}-style entries that map from a field name to a value.
     *  <p>
     *  With the default of ":", the following input:
     *  <pre>
     *       1:Fixed, 2:Won't Fix, 3:Resolved
     *  </pre>
     *  Would be assumed to be a mapping like this (expressed in JSON):
     *  <pre>
     *    {
     *       "1" : "Fixed",
     *       "2" : "Won't Fix",
     *       "3" : "Resolved"
     *    }
     *  </pre>
     *  <p>
     *  Any entry without a separator char has an implied value of <code>null</code>.
     *  For example, for this input:
     *  <pre>
     *        Fixed:Reported Fixed, WontFix:Won't Fix, Resolved
     *  </pre>
     *  The resulting <code>data</code> would be:
     *  <pre>
     *    {
     *       "Fixed" : "Reported Fixed",
     *       "WontFix" : "Won't Fix",
     *       "Resolved" : null
     *    }
     *  </pre>
     *  <p>
     * The {@link com.smartgwt.client.tools.DetailViewerEditProxy#getDataEscapeChar dataEscapeChar} can be used to enter
     * literal colon characters.
     *  <p>
     *  Set <code>dataDisplaySeparatorChar</code> to null to prevent entry of values
     *  - user input will always be treated as just a list of legal field names.
     *
     * @return Current dataDisplaySeparatorChar value. Default value is ":"
     */
    public String getDataDisplaySeparatorChar()  {
        return getAttributeAsString("dataDisplaySeparatorChar");
    }
    

    /**
     * If {@link com.smartgwt.client.tools.EditProxy#getInlineEditEvent inline editing} for this viewer edits the {@link
     * com.smartgwt.client.widgets.viewer.DetailViewer#getData DetailViewer.data}, character that can be used to enter literal
     * separator chars (such as the {@link com.smartgwt.client.tools.DetailViewerEditProxy#getDataSeparatorChar
     * dataSeparatorChar}) or literal leading or trailing whitespace. <p> Repeat this character twice to enter it literally. 
     * For example, with the default of "\", inputting "\\" would result in a literal backslash in the value.
     *
     * @param dataEscapeChar New dataEscapeChar value. Default value is "\"
     * @return {@link com.smartgwt.client.tools.DetailViewerEditProxy DetailViewerEditProxy} instance, for chaining setter calls
     * @throws IllegalStateException this property cannot be changed after the underlying component has been created
     */
    public DetailViewerEditProxy setDataEscapeChar(String dataEscapeChar)  throws IllegalStateException {
        return (DetailViewerEditProxy)setAttribute("dataEscapeChar", dataEscapeChar, false);
    }

    /**
     * If {@link com.smartgwt.client.tools.EditProxy#getInlineEditEvent inline editing} for this viewer edits the {@link
     * com.smartgwt.client.widgets.viewer.DetailViewer#getData DetailViewer.data}, character that can be used to enter literal
     * separator chars (such as the {@link com.smartgwt.client.tools.DetailViewerEditProxy#getDataSeparatorChar
     * dataSeparatorChar}) or literal leading or trailing whitespace. <p> Repeat this character twice to enter it literally. 
     * For example, with the default of "\", inputting "\\" would result in a literal backslash in the value.
     *
     * @return Current dataEscapeChar value. Default value is "\"
     */
    public String getDataEscapeChar()  {
        return getAttributeAsString("dataEscapeChar");
    }
    

    /**
     * If {@link com.smartgwt.client.tools.EditProxy#getInlineEditEvent inline editing} for this viewer edits the {@link
     * com.smartgwt.client.widgets.viewer.DetailViewer#getData DetailViewer.data}, character that should be used as a separator
     * between values, or between pairs of field name vs values if the user is entering such a {@link
     * com.smartgwt.client.types.ValueMap} using the {@link
     * com.smartgwt.client.tools.DetailViewerEditProxy#getDataDisplaySeparatorChar dataDisplaySeparatorChar}. <p> If {@link
     * com.smartgwt.client.tools.EditProxy#getInlineEditMultiline EditProxy.inlineEditMultiline} is enabled, newlines will be
     * used as value separators and the <code>dataSeparatorChar</code> <p> The {@link
     * com.smartgwt.client.tools.DetailViewerEditProxy#getDataEscapeChar dataEscapeChar} can be used to enter the separator
     * char as part of a field name or value.
     *
     * @param dataSeparatorChar New dataSeparatorChar value. Default value is ","
     * @return {@link com.smartgwt.client.tools.DetailViewerEditProxy DetailViewerEditProxy} instance, for chaining setter calls
     * @throws IllegalStateException this property cannot be changed after the underlying component has been created
     */
    public DetailViewerEditProxy setDataSeparatorChar(String dataSeparatorChar)  throws IllegalStateException {
        return (DetailViewerEditProxy)setAttribute("dataSeparatorChar", dataSeparatorChar, false);
    }

    /**
     * If {@link com.smartgwt.client.tools.EditProxy#getInlineEditEvent inline editing} for this viewer edits the {@link
     * com.smartgwt.client.widgets.viewer.DetailViewer#getData DetailViewer.data}, character that should be used as a separator
     * between values, or between pairs of field name vs values if the user is entering such a {@link
     * com.smartgwt.client.types.ValueMap} using the {@link
     * com.smartgwt.client.tools.DetailViewerEditProxy#getDataDisplaySeparatorChar dataDisplaySeparatorChar}. <p> If {@link
     * com.smartgwt.client.tools.EditProxy#getInlineEditMultiline EditProxy.inlineEditMultiline} is enabled, newlines will be
     * used as value separators and the <code>dataSeparatorChar</code> <p> The {@link
     * com.smartgwt.client.tools.DetailViewerEditProxy#getDataEscapeChar dataEscapeChar} can be used to enter the separator
     * char as part of a field name or value.
     *
     * @return Current dataSeparatorChar value. Default value is ","
     */
    public String getDataSeparatorChar()  {
        return getAttributeAsString("dataSeparatorChar");
    }
    

    // ********************* Methods ***********************
	/**
     * Returns the text based on the current component state to be edited inline. Called by the {@link
     * com.smartgwt.client.tools.EditProxy#getInlineEditForm EditProxy.inlineEditForm} to obtain the starting edit value. <p>
     * Returns the component's data one-field-per-line as specified in {@link
     * com.smartgwt.client.tools.DetailViewerEditProxy#getDataDisplaySeparatorChar dataDisplaySeparatorChar}.
     */
    public native void getInlineEditText() /*-{
        if (this.@com.smartgwt.client.core.BaseClass::isConfigOnly()()) {
            @com.smartgwt.client.util.ConfigUtil::warnOfPostConfigInstantiation(Ljava/lang/Class;Ljava/lang/String;Ljava/lang/String;)(this.@java.lang.Object::getClass()(), "getInlineEditText", "");
        }
        var self = this.@com.smartgwt.client.core.BaseClass::getOrCreateJsObj()();
        self.getInlineEditText();
    }-*/;

	/**
     * Save the new value into the component's state. Called by the {@link
     * com.smartgwt.client.tools.EditProxy#getInlineEditForm EditProxy.inlineEditForm} to commit the change. <p> Updates the
     * component's <code>data</code> and <code>fields</code>.
     * @param newValue the new component data
     */
    public native void setInlineEditText(String newValue) /*-{
        if (this.@com.smartgwt.client.core.BaseClass::isConfigOnly()()) {
            @com.smartgwt.client.util.ConfigUtil::warnOfPostConfigInstantiation(Ljava/lang/Class;Ljava/lang/String;Ljava/lang/String;)(this.@java.lang.Object::getClass()(), "setInlineEditText", "String");
        }
        var self = this.@com.smartgwt.client.core.BaseClass::getOrCreateJsObj()();
        self.setInlineEditText(newValue);
    }-*/;


    // ********************* Static Methods ***********************

    // ***********************************************************

}
