08WAB入门-API参考

Css framework--jimu.js/css/jimu-theme.css

Main类

类名	描述
jimu-main-background	定义app的主色，应用到了app的主UI上
jimu-main-font	应用于body标签，如果不想覆盖默认字体，忽略即可
jimu-title	定义字体大小和颜色，应用于展示app标题的元素上
jimu-subtitle	定义字体大小和颜色，应用于展示app副标题的元素上
jimu-footer	定义字体大小和颜色，应用于展示app页脚的元素上
jimu-link	定义字体大小和颜色，应用于展示app链接的元素上
jimu-widget-onscreen-icon	定义背景色和边框，应用于on-screen widget的icon元素上
jimu-widget-placeholder	定义背景色和边框，应用于on-screen 占位空间上
jimu-overlay	应用到遮罩元素上

widget和panel类

类名	描述
jumu-widget	定义字体大小和颜色，应用于widget的外部容器
jimu-widget-title	定义字体大小和颜色，应用于展示widget标题的元素
jimu-widget-note	定义字体大小和颜色，应用于展示widget文本元素
jimu-panel	定义背景和边框，应用于panel的外部容器
jimu-panel-title	定义字体大小和颜色，应用于展示panel标题的元素

state 类

类名	描述
jimu-state-hover	鼠标浮动样式
jimu-state-focus	焦点获取样式
jimu-state-active	元素激活样式
jimu-state-disabled	元素禁用样式
jimu-state-error	元素显示错误消息样式

icon类

图像精灵文件 jimu.js/css/sprite.png

使用如下：

jimu-icon为图片的基础类，其下可以追加各种图片类

FeatureActionManager类

使用方式：

构造器：没有构造函数，使用FeatureActionManager.getInstance()来获取实例

方法：

方法名	参数	返回值	描述
getSupportedActions(featureSet)	featureSet	处理一系列actions的Deferred对象	获取featureSet支持功能集合
getAllActions	无	Feature action 数组	获取所有注册的feature actions
getActionsByWidgetId(widgetId)	widgetId	Feature action 数组	获取包含在对应widget中的feature actions
getActionsByActionName(actionName)	actionName	Feature action 数组	获取由系统的feature action类创建的多个实例

PanelManager类

该类用于管理panel，比如加载panel、改变panel的状态、销毁panel

构造器：没有构造函数，使用PanelManager.getInstance()获取实例

方法：

方法名	参数	返回值	描述
getInstance()	无	无	返回类的单例实例
showPanel(widgetJson/groupJson)	定义在app的config.json中的widget或者group对象	返回一个延迟对象，加载成功后处理	加载和打开panel
openPanel(panelId/panelInstance)	panel的ID或者panel的实例对象	无	打开一个已加载panel，改变panel状态为open 并且调用onOpen方法。如果panel未加载，不做任何处理
closePanel(panelId/panelInstance)	panel的ID或者panel的实例对象	无	挂壁一个已加载panel，改变panel状态为closed 并且调用onClose方法。如果panel未加载，不做任何处理
minimizePanel(panelId/panelInstance)	panel的ID或者panel的实例对象	无	最小化一个已加载panel，改变panel状态为minimized 并且调用onMinimize方法。如果panel未加载，不做任何处理
maximizePanel(panelId/panelInstance)	panel的ID或者panel的实例对象	无	最大化一个已加载panel，改变panel状态为maximized 并且调用onMaximize方法。如果panel未加载，不做任何处理
normalizePanel(panelId/panelInstance)	panel的ID或者panel的实例对象	无	同上normal以及onNormalize
getPanelById(panelId)	panel的Id	Panel 对象	返回对应id的panel对象，如果panel未加载，返回undefined
destroyPanel(panelId/panel)	panel的ID或者panel的实例对象	无	销毁指定的panel
destroyAllPanel()	无	无	销毁所有的panel

WidgetManager类

该类用于管理widget，比如加载widget、创建widget以及销毁widget

构造器：实例化的时候使用getInstance()

方法：

方法名	参数	返回值	描述
loadWidget(widgetJson)	在app的config.json中定义的widget的Json对象	返回一个延迟对象，当widget加载成功后resoved（widget实例）	加载以及创建widget
getWidgetById(widgetId)	widgetId	widget 实例对象	返回widiget ID所标示的widget对象，如果没有加载返回undefined
getWidgetsByName(widgetName)	widget Name	widget 数组	根据名称返回widget，如果没有返回空数据
getWidgetMarginBox(widget)	widget Id or widget instance	widget 外边距 box对象	返回widget的外边距box，在将一个off-panel widget放置到合适位置的时候会很有用。这个方法会调用setPosition方法，打开一个widget，然后获取domNode的外边box，然后关闭widget
getWidgetByLabel(widgetLabel)	widgetLabel	widget 实例对象	返回widget label所标示的widget
getAllWidgets	无	widget 数组	返回所有的widget对象
destroyAllWidgets	无	无	销毁所有的widget
openWidget(widget)	widget Id or widget instance	无	打开一个加载的widget，改变widgte状态到open并调用onOpen方法
maxmizeWidget(widget)	widget id or widget instance	无	最大化一个加载的widget，改变widgte状态到maximized并调用onMaximize方法
minimizeWidget(widget)	widget id or widget instance	无	最小化一个加载的widget，改变widgte状态到minimized并调用onMinimize方法
normalizeWidget(widget)	widget id or widget instance	无	改变widgte状态到normal并调用onNormalize方法
closeWidget(widget)	widget id or widget instance	无	关闭一个加载的widget，改变widgte状态到closed并调用onClose方法
destroyWidget(widget)	widget id or widget instance	无	销毁一个widget
tryLoadWidgetConfig(widgetJson)	在app的config.json中定义的widget的Json对象	返回一个延迟对象，当widget加载成功后resoved（widget实例）
loadWidgetSettingPage(widgetJson)	在app的config.json中定义的widget的Json对象	返回一个延迟对象，当widget加载成功后resoved（widget实例）	加载widget的设置页

utils类

该类包含了一些helper方法，可以不需要实例化使用

方法名	参数	返回值	描述
loadStyleLink(id,href,beforeId)	id:link/style的tagID href:文件的url beforeId:要在其之前插入的元素ID，如果未传入，则在head中插入	deffered对象，当css加载成功后resolved	动态加载css文件
isEqual(o1,o2)	需要进行对比的对象或者数组	boolean	对比两个对象或者数组是否相等
merge(target,source)	target:目标对象或数组 source：源对象或数组	合并后的对象或数组	合并两个对象或者数组
file.readFile(fileEvt,filter,maxSize,cd)	fileEvt:事件对象 filter:文件类型过滤，如：image/* 或者 image/png maxSize:文件的最大size cb:当文件读取完毕后的回调，有三个参数 err,fileName,fileData	无	使用Html5 的api读取文件。如果html5的api不被支持，则尝试使用flash去读取文件

来自为知笔记(Wiz)