ria.ui

Class UIDef

java.lang.Object

Item

ria.ui.UIDef

public class UIDef
extends Item

UIDef is a JSON Object used to describe a specific UI element. The element can be a button, or a menu item; or as large as a complete menu, or a complete dialog.

Since:

V18.3

Method Summary

Modifier and Type	Method and Description
UIDef	chainDefine(java.lang.String id, java.lang.String... refs)
java.lang.String	chainRef(java.lang.String... refs) Generate the ref id based on the current definition.
UIDef	define(java.lang.String id, java.lang.String... refs) Returns UIDef's child with the specified ID.
UIDef	get(java.lang.String id) Returns UIDef's child with the specified ID.
java.util.List<UIDef>	getChildren() Returns UIDef's all children.
Config	getConfig() Returns UIDef's Config.
java.lang.String[]	getItems() Returns UIDef's all children's ID.
UIDef	getRef() Gets UIDef's reference object.
boolean	hasChild(java.lang.String id) Tests whether the specified child UIDef ID exists.
JSONObject	mergedJSON()
void	parse(JSONObject json)
UIDef	removeAttr(java.lang.String name) Removes UIDef's attribute.
UIDef	setAttr(java.lang.String name, java.lang.Object value) Sets UIDef's attribute.
UIDef	setAttr(java.lang.String name, java.lang.String nlsKey, java.lang.String nlsDefault) Sets UIDef's attribute.
UIDef	setItems(java.lang.String... ids) Sets UIDef's children's ID.
java.lang.Object	toJSON()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getConfig

public Config getConfig()

Returns UIDef's Config.

Returns:

setAttr

public UIDef setAttr(java.lang.String name,
                     java.lang.Object value)

Sets UIDef's attribute.

Parameters:

name - The attribute's name

value - The attribute's value

Returns:

setAttr

public UIDef setAttr(java.lang.String name,
                     java.lang.String nlsKey,
                     java.lang.String nlsDefault)

Sets UIDef's attribute.

Parameters:

name - The attribute's name

nlsKey - The attribute's NLS key

nlsDefault - The attribute's NLS value

Returns:

removeAttr

public UIDef removeAttr(java.lang.String name)

Removes UIDef's attribute.

Parameters:

name - The attribute's name

Returns:

chainRef

public java.lang.String chainRef(java.lang.String... refs)

Generate the ref id based on the current definition.

Returns:

getRef

public UIDef getRef()

Gets UIDef's reference object.

Returns:

setItems

public UIDef setItems(java.lang.String... ids)

Sets UIDef's children's ID.

Parameters:

ids - The children's ID

Returns:

getItems

public java.lang.String[] getItems()

Returns UIDef's all children's ID.

Returns:

getChildren

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

Returns UIDef's all children.

Returns:

get

public UIDef get(java.lang.String id)

Returns UIDef's child with the specified ID.

Parameters:

id - The ID

Returns:

hasChild

public boolean hasChild(java.lang.String id)

Tests whether the specified child UIDef ID exists.

Parameters:

id -

Returns:

define

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

Returns UIDef's child with the specified ID.

Parameters:

id - The ID.

refs - The reference object ID

Returns:

chainDefine

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

toString

public java.lang.String toString()

toJSON

public java.lang.Object toJSON()

mergedJSON

public JSONObject mergedJSON()

parse

public void parse(JSONObject json)