/*
 * 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.*;


/**
 * Configuration for {@link com.smartgwt.client.tools.Reify#publishScreen Reify.publishScreen()}.
 */
@BeanFactory.FrameworkClass
public class PublishScreenConfig extends DataClass {

    public static PublishScreenConfig getOrCreateRef(JavaScriptObject jsObj) {
        if(jsObj == null) return null;
        return new PublishScreenConfig(jsObj);
    }
        


    public PublishScreenConfig(){
        
    }

    public PublishScreenConfig(JavaScriptObject jsObj){
        
        setJavaScriptObject(jsObj);
    }



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

    /**
     * DataSource IDs to register in the project's <code>&lt;datasources&gt;</code> section via {@link
     * com.smartgwt.client.tools.Reify#addDataSourcesToProject Reify.addDataSourcesToProject()}.  The DS definitions must
     * already exist in <code>vbDataSources</code> storage.
     *
     * @param dataSources New dataSources value. Default value is null
     * @return {@link com.smartgwt.client.tools.PublishScreenConfig PublishScreenConfig} instance, for chaining setter calls
     */
    public PublishScreenConfig setDataSources(String... dataSources) {
        return (PublishScreenConfig)setAttribute("dataSources", dataSources);
    }

    /**
     * DataSource IDs to register in the project's <code>&lt;datasources&gt;</code> section via {@link
     * com.smartgwt.client.tools.Reify#addDataSourcesToProject Reify.addDataSourcesToProject()}.  The DS definitions must
     * already exist in <code>vbDataSources</code> storage.
     *
     * @return Current dataSources value. Default value is null
     */
    public String[] getDataSources()  {
        return com.smartgwt.client.util.ConvertTo.arrayOfString(getAttributeAsJavaScriptObject("dataSources"));
    }
    

    /**
     * The EditContext whose contents should be published.  Mutually exclusive with {@link
     * com.smartgwt.client.tools.PublishScreenConfig#getScreenXml screenXml}.  The EditContext is serialized and wrapped in a
     * DataView root via {@link com.smartgwt.client.tools.Reify#_ensureDataViewRoot Reify._ensureDataViewRoot()} automatically.
     *
     * @param editContext New editContext value. Default value is null
     * @return {@link com.smartgwt.client.tools.PublishScreenConfig PublishScreenConfig} instance, for chaining setter calls
     */
    public PublishScreenConfig setEditContext(EditContext editContext) {
        return (PublishScreenConfig)setAttribute("editContext", editContext == null ? null : editContext.getOrCreateJsObj());
    }

    /**
     * The EditContext whose contents should be published.  Mutually exclusive with {@link
     * com.smartgwt.client.tools.PublishScreenConfig#getScreenXml screenXml}.  The EditContext is serialized and wrapped in a
     * DataView root via {@link com.smartgwt.client.tools.Reify#_ensureDataViewRoot Reify._ensureDataViewRoot()} automatically.
     *
     * @return Current editContext value. Default value is null
     */
    public EditContext getEditContext()  {
        return EditContext.getOrCreateRef(getAttributeAsJavaScriptObject("editContext"));
    }
    

    /**
     * Name of the Reify project the screen is added to.  Created if it does not exist.
     *
     * @param projectName New projectName value. Default value is "GeneratedReports"
     * @return {@link com.smartgwt.client.tools.PublishScreenConfig PublishScreenConfig} instance, for chaining setter calls
     */
    public PublishScreenConfig setProjectName(String projectName) {
        return (PublishScreenConfig)setAttribute("projectName", projectName);
    }

    /**
     * Name of the Reify project the screen is added to.  Created if it does not exist.
     *
     * @return Current projectName value. Default value is "GeneratedReports"
     */
    public String getProjectName()  {
        return getAttributeAsString("projectName");
    }
    

    /**
     * Name for the screen in Reify storage.  If omitted, a timestamp-suffixed name is generated automatically
     * (<code>Screen_YYYYMMDD_HHMMSS</code>).
     *
     * @param screenName New screenName value. Default value is null
     * @return {@link com.smartgwt.client.tools.PublishScreenConfig PublishScreenConfig} instance, for chaining setter calls
     */
    public PublishScreenConfig setScreenName(String screenName) {
        return (PublishScreenConfig)setAttribute("screenName", screenName);
    }

    /**
     * Name for the screen in Reify storage.  If omitted, a timestamp-suffixed name is generated automatically
     * (<code>Screen_YYYYMMDD_HHMMSS</code>).
     *
     * @return Current screenName value. Default value is null
     */
    public String getScreenName()  {
        return getAttributeAsString("screenName");
    }
    

    /**
     * Raw screen XML to publish.  Mutually exclusive with {@link com.smartgwt.client.tools.PublishScreenConfig#getEditContext
     * editContext}.  Must already have a DataView root.
     *
     * @param screenXml New screenXml value. Default value is null
     * @return {@link com.smartgwt.client.tools.PublishScreenConfig PublishScreenConfig} instance, for chaining setter calls
     */
    public PublishScreenConfig setScreenXml(String screenXml) {
        return (PublishScreenConfig)setAttribute("screenXml", screenXml);
    }

    /**
     * Raw screen XML to publish.  Mutually exclusive with {@link com.smartgwt.client.tools.PublishScreenConfig#getEditContext
     * editContext}.  Must already have a DataView root.
     *
     * @return Current screenXml value. Default value is null
     */
    public String getScreenXml()  {
        return getAttributeAsString("screenXml");
    }
    

    /**
     * Skin name baked into the published URL.
     *
     * @param skin New skin value. Default value is null
     * @return {@link com.smartgwt.client.tools.PublishScreenConfig PublishScreenConfig} instance, for chaining setter calls
     */
    public PublishScreenConfig setSkin(String skin) {
        return (PublishScreenConfig)setAttribute("skin", skin);
    }

    /**
     * Skin name baked into the published URL.
     *
     * @return Current skin value. Default value is null
     */
    public String getSkin()  {
        return getAttributeAsString("skin");
    }
    

    // ********************* Methods ***********************

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

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

}
