org.nuxeo.ecm.platform.forms.layout.io

Class JSONLayoutExporter

java.lang.Object

org.nuxeo.ecm.platform.forms.layout.io.JSONLayoutExporter

public class JSONLayoutExporter
extends Object

JSON exporter for layout objects

Since:

5.4.2

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCODED_VALUES_ENCODING

Constructor Summary

Constructors

Constructor and Description
JSONLayoutExporter()

Method Summary

Modifier and Type	Method and Description
static net.sf.json.JSONObject	decode(String json)
static String	encode(net.sf.json.JSONObject jsonObject)
static void	export(List<WidgetTypeDefinition> defs, OutputStream out)
static void	export(String category, LayoutDefinition layoutDef, LayoutConversionContext ctx, List<WidgetDefinitionConverter> widgetConverters, OutputStream out)
static void	export(WidgetTypeDefinition def, OutputStream out)
static void	exportLayoutType(LayoutTypeDefinition def, OutputStream out)
static void	exportLayoutTypes(List<LayoutTypeDefinition> defs, OutputStream out)
static net.sf.json.JSONObject	exportPropsByModeToJson(Map<String,Map<String,Serializable>> propsByMode)
static net.sf.json.JSONObject	exportPropsToJson(Map<String,Serializable> defProps)
static net.sf.json.JSONObject	exportRenderingInfosByModeToJson(Map<String,List<RenderingInfo>> infosByMode)
static net.sf.json.JSONArray	exportRenderingInfosToJson(List<RenderingInfo> infos)
static net.sf.json.JSONObject	exportStringPropsToJson(Map<String,String> defProps)
static net.sf.json.JSONObject	exportToJson(FieldDefinition fieldDef)
static net.sf.json.JSONObject	exportToJson(Layout layout)
static net.sf.json.JSONObject	exportToJson(LayoutRow layoutRow)
static net.sf.json.JSONObject	exportToJson(LayoutRowDefinition layoutRowDef)
static net.sf.json.JSONObject	exportToJson(LayoutRowDefinition layoutRowDef, String defaultRowName)
static net.sf.json.JSONObject	exportToJson(LayoutTypeConfiguration conf)
static net.sf.json.JSONObject	exportToJson(LayoutTypeDefinition def)
static net.sf.json.JSONObject	exportToJson(RenderingInfo info)
static net.sf.json.JSONObject	exportToJson(String category, LayoutDefinition layoutDef)
static net.sf.json.JSONObject	exportToJson(String category, LayoutDefinition layoutDef, LayoutConversionContext ctx, List<WidgetDefinitionConverter> widgetConverters) Returns the JSON export of this layout definition
static net.sf.json.JSONObject	exportToJson(Widget widget)
static net.sf.json.JSONObject	exportToJson(WidgetDefinition widgetDef, LayoutConversionContext ctx, List<WidgetDefinitionConverter> widgetConverters)
static net.sf.json.JSONObject	exportToJson(WidgetReference widgetRef)
static net.sf.json.JSONObject	exportToJson(WidgetSelectOption selectOption)
static net.sf.json.JSONObject	exportToJson(WidgetTypeConfiguration conf)
static net.sf.json.JSONObject	exportToJson(WidgetTypeDefinition def)
protected static WidgetDefinition	exportWidgetReference(WidgetReference widgetRef, String category, LayoutDefinition layoutDef, LayoutConversionContext ctx, LayoutStore webLayoutManager, List<WidgetDefinitionConverter> widgetConverters)
static FieldDefinition	importFieldDefinition(net.sf.json.JSONObject fieldDef)
static LayoutDefinition	importLayoutDefinition(net.sf.json.JSONObject layoutDef)
static LayoutRowDefinition	importLayoutRowDefinition(net.sf.json.JSONObject layoutRowDef)
static LayoutTypeConfiguration	importLayoutTypeConfiguration(net.sf.json.JSONObject conf)
static LayoutTypeDefinition	importLayoutTypeDefinition(net.sf.json.JSONObject jsonDef)
static Map<String,Serializable>	importProps(net.sf.json.JSONObject defProps)
static Map<String,Map<String,Serializable>>	importPropsByMode(net.sf.json.JSONObject propsByMode)
static RenderingInfo	importRenderingInfo(net.sf.json.JSONObject fieldDef)
static List<RenderingInfo>	importRenderingInfos(net.sf.json.JSONArray jinfos)
static Map<String,List<RenderingInfo>>	importRenderingInfosByMode(net.sf.json.JSONObject infosByMode)
static Map<String,String>	importStringProps(net.sf.json.JSONObject defProps)
static WidgetDefinition	importWidgetDefinition(net.sf.json.JSONObject widgetDef)
static WidgetReference	importWidgetReference(net.sf.json.JSONObject widgetRef)
static WidgetSelectOption	importWidgetSelectionOption(net.sf.json.JSONObject selectOption)
static WidgetTypeConfiguration	importWidgetTypeConfiguration(net.sf.json.JSONObject conf)
static WidgetTypeDefinition	importWidgetTypeDefinition(net.sf.json.JSONObject jsonDef)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENCODED_VALUES_ENCODING

public static final String ENCODED_VALUES_ENCODING

See Also:

Constant Field Values

Constructor Detail

JSONLayoutExporter

public JSONLayoutExporter()

Method Detail

encode

public static String encode(net.sf.json.JSONObject jsonObject)
                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

decode

public static net.sf.json.JSONObject decode(String json)
                                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

export

public static void export(String category,
                          LayoutDefinition layoutDef,
                          LayoutConversionContext ctx,
                          List<WidgetDefinitionConverter> widgetConverters,
                          OutputStream out)
                   throws IOException

Throws:

IOException

Since:

5.5

export

public static void export(WidgetTypeDefinition def,
                          OutputStream out)
                   throws IOException

Throws:

IOException

export

public static void export(List<WidgetTypeDefinition> defs,
                          OutputStream out)
                   throws IOException

Throws:

IOException

exportLayoutType

public static void exportLayoutType(LayoutTypeDefinition def,
                                    OutputStream out)
                             throws IOException

Throws:

IOException

Since:

6.0

exportLayoutTypes

public static void exportLayoutTypes(List<LayoutTypeDefinition> defs,
                                     OutputStream out)
                              throws IOException

Throws:

IOException

Since:

6.0

exportToJson

public static net.sf.json.JSONObject exportToJson(WidgetTypeDefinition def)

importWidgetTypeDefinition

public static WidgetTypeDefinition importWidgetTypeDefinition(net.sf.json.JSONObject jsonDef)

exportToJson

public static net.sf.json.JSONObject exportToJson(WidgetTypeConfiguration conf)

importWidgetTypeConfiguration

public static WidgetTypeConfiguration importWidgetTypeConfiguration(net.sf.json.JSONObject conf)

exportToJson

public static net.sf.json.JSONObject exportToJson(LayoutTypeDefinition def)

Since:

6.0

importLayoutTypeDefinition

public static LayoutTypeDefinition importLayoutTypeDefinition(net.sf.json.JSONObject jsonDef)

Since:

6.0

exportToJson

public static net.sf.json.JSONObject exportToJson(LayoutTypeConfiguration conf)

Since:

6.0

importLayoutTypeConfiguration

public static LayoutTypeConfiguration importLayoutTypeConfiguration(net.sf.json.JSONObject conf)

Since:

6.0

exportToJson

public static net.sf.json.JSONObject exportToJson(String category,
                                                  LayoutDefinition layoutDef)

exportToJson

public static net.sf.json.JSONObject exportToJson(String category,
                                                  LayoutDefinition layoutDef,
                                                  LayoutConversionContext ctx,
                                                  List<WidgetDefinitionConverter> widgetConverters)

Returns the JSON export of this layout definition

Parameters:

category - the category of the layout, needed for retrieval of referenced global widgets.

layoutDef - the layout definition

ctx - the widget conversion context

widgetConverters - the list of ordered widget converters to use before export

Since:

5.5

exportWidgetReference

protected static WidgetDefinition exportWidgetReference(WidgetReference widgetRef,
                                                        String category,
                                                        LayoutDefinition layoutDef,
                                                        LayoutConversionContext ctx,
                                                        LayoutStore webLayoutManager,
                                                        List<WidgetDefinitionConverter> widgetConverters)

importLayoutDefinition

public static LayoutDefinition importLayoutDefinition(net.sf.json.JSONObject layoutDef)

exportToJson

public static net.sf.json.JSONObject exportToJson(LayoutRowDefinition layoutRowDef,
                                                  String defaultRowName)

Since:

6.0

exportToJson

public static net.sf.json.JSONObject exportToJson(LayoutRowDefinition layoutRowDef)

importLayoutRowDefinition

public static LayoutRowDefinition importLayoutRowDefinition(net.sf.json.JSONObject layoutRowDef)

exportToJson

public static net.sf.json.JSONObject exportToJson(WidgetDefinition widgetDef,
                                                  LayoutConversionContext ctx,
                                                  List<WidgetDefinitionConverter> widgetConverters)

Parameters:

widgetDef -

ctx -

widgetConverters -

Returns:

Since:

5.5

importWidgetDefinition

public static WidgetDefinition importWidgetDefinition(net.sf.json.JSONObject widgetDef)

exportToJson

public static net.sf.json.JSONObject exportToJson(FieldDefinition fieldDef)

importFieldDefinition

public static FieldDefinition importFieldDefinition(net.sf.json.JSONObject fieldDef)

exportToJson

public static net.sf.json.JSONObject exportToJson(WidgetReference widgetRef)

importWidgetReference

public static WidgetReference importWidgetReference(net.sf.json.JSONObject widgetRef)

exportToJson

public static net.sf.json.JSONObject exportToJson(Layout layout)

Since:

7.3

exportToJson

public static net.sf.json.JSONObject exportToJson(LayoutRow layoutRow)

Since:

7.3

exportToJson

public static net.sf.json.JSONObject exportToJson(Widget widget)

Since:

7.3

exportToJson

public static net.sf.json.JSONObject exportToJson(WidgetSelectOption selectOption)

importWidgetSelectionOption

public static WidgetSelectOption importWidgetSelectionOption(net.sf.json.JSONObject selectOption)

exportPropsByModeToJson

public static net.sf.json.JSONObject exportPropsByModeToJson(Map<String,Map<String,Serializable>> propsByMode)

importPropsByMode

public static Map<String,Map<String,Serializable>> importPropsByMode(net.sf.json.JSONObject propsByMode)

exportPropsToJson

public static net.sf.json.JSONObject exportPropsToJson(Map<String,Serializable> defProps)

importProps

public static Map<String,Serializable> importProps(net.sf.json.JSONObject defProps)

exportStringPropsToJson

public static net.sf.json.JSONObject exportStringPropsToJson(Map<String,String> defProps)

importStringProps

public static Map<String,String> importStringProps(net.sf.json.JSONObject defProps)

exportRenderingInfosByModeToJson

public static net.sf.json.JSONObject exportRenderingInfosByModeToJson(Map<String,List<RenderingInfo>> infosByMode)

importRenderingInfosByMode

public static Map<String,List<RenderingInfo>> importRenderingInfosByMode(net.sf.json.JSONObject infosByMode)

exportRenderingInfosToJson

public static net.sf.json.JSONArray exportRenderingInfosToJson(List<RenderingInfo> infos)

importRenderingInfos

public static List<RenderingInfo> importRenderingInfos(net.sf.json.JSONArray jinfos)

exportToJson

public static net.sf.json.JSONObject exportToJson(RenderingInfo info)

importRenderingInfo

public static RenderingInfo importRenderingInfo(net.sf.json.JSONObject fieldDef)