ria.ui

Class Config

java.lang.Object

ria.ui.Config

public class Config
extends java.lang.Object

Config provides the API interface for customizing the Report Studio UI configuration.

Since:

V18.3

Constructor Summary

Constructors

Constructor and Description
Config() Constructs a Config.

Method Summary

Modifier and Type	Method and Description
static void	addAttrName(java.lang.String name) Adds an attribute name.
void	addItemsDef(ItemsDef itemsDef) Adds ItemsDef with the specified ID.
UIDef	createMode(java.lang.String id, java.lang.String... refs) Creates the mode UIDef.
UIDef	define(java.lang.String id) Creates UIDef, and adds this UIDef in definitions library.
UIDef	define(java.lang.String id, java.lang.String... refs) Creates UIDef, and adds this UIDef in definitions library.
UIDef	define(java.lang.String id, UIDef... defs) Creates UIDef, and adds this UIDef in definitions library.
java.util.Collection<ItemsDef>	getAllItemsDef() Returns all Item in enumerations library.
java.util.Collection<UIDef>	getAllUIDefs() Returns all UIDef in the definitions library.
UIDef	getDefinedUIDef(java.lang.String id) Returns UIDef in definitions library.
UIDef	getMode(java.lang.String id) Returns the mode UIDef.
java.util.List<UIDef>	getModes() Returns the mode list which contains UIDef.
boolean	hasDefinedUIDef(java.lang.String id) Returns true if the specified UIDef ID exists.
boolean	hasItemsDef(java.lang.String id)
static boolean	isAttrName(java.lang.String name) Returns true if this specified name is an attribute name.
JSONObject	mergedJSON() Gets the Config JSONObject for UI.
static Config	parse(JSONObject json) Returns the Config.
void	removeMode(java.lang.String id) Removes the mode UIDef.
java.lang.Object	toJSON() Gets the Config JSONObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config()

Constructs a Config.

Method Detail

addAttrName

public static void addAttrName(java.lang.String name)

Adds an attribute name.

Parameters:

name - The attribute name

isAttrName

public static boolean isAttrName(java.lang.String name)

Returns true if this specified name is an attribute name.

Parameters:

name - The attribute name

Returns:

define

public UIDef define(java.lang.String id)

Creates UIDef, and adds this UIDef in definitions library.

Parameters:

id - The ID

Returns:

Throws:

java.lang.RuntimeException - when this ID exists

define

public UIDef define(java.lang.String id,
                    java.lang.String... refs)

Creates UIDef, and adds this UIDef in definitions library.

Parameters:

id - The ID

refs - The reference object ID

Returns:

Throws:

java.lang.RuntimeException - when this ID exists

define

public UIDef define(java.lang.String id,
                    UIDef... defs)

Creates UIDef, and adds this UIDef in definitions library.

Parameters:

id - The id

defs - The reference objects

Returns:

Throws:

java.lang.RuntimeException - when this ID exists

getDefinedUIDef

public UIDef getDefinedUIDef(java.lang.String id)

Returns UIDef in definitions library.

Parameters:

id - The ID

Returns:

hasDefinedUIDef

public boolean hasDefinedUIDef(java.lang.String id)

Returns true if the specified UIDef ID exists.

Parameters:

id - The ID

Returns:

createMode

public UIDef createMode(java.lang.String id,
                        java.lang.String... refs)

Creates the mode UIDef.

Parameters:

id - The ID

refs - The reference object ID

Returns:

getMode

public UIDef getMode(java.lang.String id)

Returns the mode UIDef.

Parameters:

id - The ID

Returns:

removeMode

public void removeMode(java.lang.String id)

Removes the mode UIDef.

Parameters:

id - The ID

getModes

public java.util.List<UIDef> getModes()

Returns the mode list which contains UIDef.

Returns:

getAllUIDefs

public java.util.Collection<UIDef> getAllUIDefs()

Returns all UIDef in the definitions library.

Returns:

hasItemsDef

public boolean hasItemsDef(java.lang.String id)

addItemsDef

public void addItemsDef(ItemsDef itemsDef)

Adds ItemsDef with the specified ID.

Parameters:

itemsDef - Item.ItemsDef

getAllItemsDef

public java.util.Collection<ItemsDef> getAllItemsDef()

Returns all Item in enumerations library.

Returns:

toJSON

public java.lang.Object toJSON()

Gets the Config JSONObject.

Returns:

mergedJSON

public JSONObject mergedJSON()

Gets the Config JSONObject for UI.

Returns:

parse

public static Config parse(JSONObject json)

Returns the Config.

Parameters:

json - The Config JSONObject

Returns: