com.jinfonet.web.ui.config

Class WebUIConfig

java.lang.Object

com.jinfonet.web.ui.config.Container

com.jinfonet.web.ui.config.WebUIConfig

All Implemented Interfaces:

com.jinfonet.web.ui.config.UIObject, com.jinfonet.web.util.json.JSONObject.JSONObjectable, java.io.Serializable

public class WebUIConfig
extends com.jinfonet.web.ui.config.Container

WebUIConfig provides the API interface for customizing the toolbar in Web Report Studio.

Since:

V14

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	addToolbarButton(java.lang.String mode, java.lang.String group, java.lang.String buttonId, boolean visible) Adds a button in the toolbar.
void	addToolbarButton(java.lang.String mode, java.lang.String group, java.lang.String buttonId, java.util.HashMap<java.lang.String,java.lang.Object> attrs) Adds a button in the toolbar.
void	deleteToolbarButton(java.lang.String mode, java.lang.String buttonId) Deletes a button in the toolbar.
static WebUIConfig	getDefaultWebUIConfig() Gets the default WebUIConfig.
java.lang.String	getObjectClass()
static void	getWebUIConfig(com.jinfonet.web.beans.KVMapDef profileMap, com.jinfonet.web.beans.KVMapDef preferMap) Gets the WebUIConfig according to profileMap and preferMap.
static WebUIConfig	parse(com.jinfonet.web.util.json.JSONObject o)
void	setMenuGroupVisible(java.lang.String mode, java.lang.String group, boolean visible) Sets whether the menu item by group name is visible.
void	setMenuItemVisible(java.lang.String mode, java.lang.String menuId, boolean visible) Sets whether the menu item is visible.
void	setPanelVisible(java.lang.String mode, java.lang.String panelId, boolean visible) Sets whether the panel is visible.
void	setToolbarButtonVisible(java.lang.String mode, java.lang.String[] buttonIds, boolean visible) Sets whether the toolbar button is visible.
void	setToolbarButtonVisible(java.lang.String mode, java.lang.String buttonId, boolean visible) Sets whether the toolbar button is visible.
void	setToolbarVisible(java.lang.String mode, boolean visible) Sets whether the toolbar is visible.
void	setVisible(java.lang.String mode, java.lang.String containerId, java.lang.String id, boolean visible) Sets whether the UI object is visible.
java.lang.Object	toJSONObject()
java.lang.String	toString() Gets the WebUIConfig String for UI
java.lang.Object	toUIJSONObject() Gets the WebUIConfig JSONObject for UI

Methods inherited from class com.jinfonet.web.ui.config.Container

add, add, getID, getIndex, remove

Methods inherited from class java.lang.Object

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

Method Detail

addToolbarButton

public void addToolbarButton(java.lang.String mode,
                             java.lang.String group,
                             java.lang.String buttonId,
                             boolean visible)
                      throws com.jinfonet.web.WRException

Adds a button in the toolbar. If the buttonId exists in toolbar, only change its group and visible status.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

WebUIConfigConstant.VIEW_MODE;

group - the group name in the toolbar. If group is null it means inserting a button in the toolbar.
The default toolbar group name is defined in WebUIConfigConstant.java, and starts with TOOLBAR_GROUP_.

buttonId - the button name in the toolbar.
The default toolbar button name is defined in WebUIConfigConstant.java, and starts with TOOLBAR_.

visible - the visible status of the button.

Throws:

com.jinfonet.web.WRException

addToolbarButton

public void addToolbarButton(java.lang.String mode,
                             java.lang.String group,
                             java.lang.String buttonId,
                             java.util.HashMap<java.lang.String,java.lang.Object> attrs)
                      throws com.jinfonet.web.WRException

Adds a button in the toolbar. If the buttonId exists in the toolbar, only change its group and attributes. If the buttonId is default as defined in WebUIConfigConstant.java, and starts with TOOLBAR_, only change its group and visible status.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

WebUIConfigConstant.VIEW_MODE;

group - the group name in the toolbar. If group is null it means inserting a button in the toolbar.
The default toolbar group name is defined in WebUIConfigConstant.java, and starts with TOOLBAR_GROUP_.

buttonId - the button name in the toolbar.
The default toolbar button name is defined in WebUIConfigConstant.java, and starts with TOOLBAR_.

attrs - the button attributes. The key is defined in WebUIConfigConstant.java:

WebUIConfigConstant.TOOLBAR_ATTRS_VISIBLE;

WebUIConfigConstant.TOOLBAR_ATTRS_ICON;

WebUIConfigConstant.TOOLBAR_ATTRS_TIP;

Throws:

com.jinfonet.web.WRException

setToolbarButtonVisible

public void setToolbarButtonVisible(java.lang.String mode,
                                    java.lang.String buttonId,
                                    boolean visible)
                             throws com.jinfonet.web.WRException

Sets whether the toolbar button is visible.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

WebUIConfigConstant.VIEW_MODE;

buttonId - the button name in the toolbar.
The default toolbar button name is defined in WebUIConfigConstant.java, and starts with TOOLBAR_.

visible - the visible status of the button.

Throws:

com.jinfonet.web.WRException

setToolbarButtonVisible

public void setToolbarButtonVisible(java.lang.String mode,
                                    java.lang.String[] buttonIds,
                                    boolean visible)
                             throws com.jinfonet.web.WRException

Sets whether the toolbar button is visible.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

WebUIConfigConstant.VIEW_MODE;

buttonIds - the button names in the toolbar.
The default toolbar button name is defined in WebUIConfigConstant.java, and starts with TOOLBAR_.

visible - the visible status of the button.

Throws:

com.jinfonet.web.WRException

setToolbarVisible

public void setToolbarVisible(java.lang.String mode,
                              boolean visible)
                       throws com.jinfonet.web.WRException

Sets whether the toolbar is visible.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

WebUIConfigConstant.VIEW_MODE;

visible - the visible status of the toolbar.

Throws:

com.jinfonet.web.WRException

setMenuItemVisible

public void setMenuItemVisible(java.lang.String mode,
                               java.lang.String menuId,
                               boolean visible)
                        throws com.jinfonet.web.WRException

Sets whether the menu item is visible.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

menuId - the menu name in the menu.
The default menu name is defined in WebUIConfigConstant.java, and starts with MENU_.

visible - the visible status of the item.

Throws:

com.jinfonet.web.WRException

setMenuGroupVisible

public void setMenuGroupVisible(java.lang.String mode,
                                java.lang.String group,
                                boolean visible)
                         throws com.jinfonet.web.WRException

Sets whether the menu item by group name is visible.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

group - the menu group name in the menu.
The default menu group name is in WebUIConfigConstant.MENU_GROUPS.

visible - the visible status of the item.

Throws:

com.jinfonet.web.WRException

setPanelVisible

public void setPanelVisible(java.lang.String mode,
                            java.lang.String panelId,
                            boolean visible)
                     throws com.jinfonet.web.WRException

Sets whether the panel is visible.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

WebUIConfigConstant.VIEW_MODE;

panelId - the panel name in the sideArea.
The default panel name is defined in WebUIConfigConstant.java, and starts with PANEL_.

visible - the visible status of the item.

Throws:

com.jinfonet.web.WRException

setVisible

public void setVisible(java.lang.String mode,
                       java.lang.String containerId,
                       java.lang.String id,
                       boolean visible)
                throws com.jinfonet.web.WRException

Sets whether the UI object is visible.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

WebUIConfigConstant.VIEW_MODE;

containerId - the UI ojbect container name.
The default container name is defined in WebUIConfigConstant.java, and starts with COMP_.

id - the UI object name.

visible - the visible status of the item.

Throws:

com.jinfonet.web.WRException

deleteToolbarButton

public void deleteToolbarButton(java.lang.String mode,
                                java.lang.String buttonId)
                         throws com.jinfonet.web.WRException

Deletes a button in the toolbar.

Parameters:

mode - the mode name which is defined in WebUIConfigConstant.java:

WebUIConfigConstant.EDIT_MODE;

WebUIConfigConstant.VIEW_MODE;

buttonId - the button name in the toolbar.
The default toolbar button name is defined in WebUIConfigConstant.java, and starts with TOOLBAR_.

Throws:

com.jinfonet.web.WRException

parse

public static WebUIConfig parse(com.jinfonet.web.util.json.JSONObject o)

toJSONObject

public java.lang.Object toJSONObject()
                              throws com.jinfonet.web.util.json.JSONException

Specified by:

toJSONObject in interface com.jinfonet.web.util.json.JSONObject.JSONObjectable

Overrides:

toJSONObject in class com.jinfonet.web.ui.config.Container

Throws:

com.jinfonet.web.util.json.JSONException

getDefaultWebUIConfig

public static WebUIConfig getDefaultWebUIConfig()

Gets the default WebUIConfig.

Returns:

getObjectClass

public java.lang.String getObjectClass()

toUIJSONObject

public java.lang.Object toUIJSONObject()
                                throws com.jinfonet.web.util.json.JSONException

Gets the WebUIConfig JSONObject for UI

Specified by:

toUIJSONObject in interface com.jinfonet.web.ui.config.UIObject

Overrides:

toUIJSONObject in class com.jinfonet.web.ui.config.Container

Throws:

com.jinfonet.web.util.json.JSONException

toString

public java.lang.String toString()

Gets the WebUIConfig String for UI

Overrides:

toString in class java.lang.Object

getWebUIConfig

public static void getWebUIConfig(com.jinfonet.web.beans.KVMapDef profileMap,
                                  com.jinfonet.web.beans.KVMapDef preferMap)

Gets the WebUIConfig according to profileMap and preferMap. Then put the WebUIConfig mode to preferMap. So this method no return.

Parameters:

profileMap -

preferMap -