/**
*
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "[]"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2016 Alibaba Group
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.taobao.weex.dom;
import android.os.Handler;
import android.os.Message;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.text.TextUtils;
import com.alibaba.fastjson.JSONObject;
import com.taobao.weex.WXEnvironment;
import com.taobao.weex.WXSDKManager;
import com.taobao.weex.common.Constants;
import com.taobao.weex.common.WXRuntimeException;
import com.taobao.weex.common.WXThread;
import com.taobao.weex.ui.WXRenderManager;
import com.taobao.weex.utils.FontDO;
import com.taobao.weex.utils.TypefaceUtil;
import com.taobao.weex.utils.WXUtils;
import java.util.Iterator;
import java.util.Map.Entry;
import java.util.concurrent.ConcurrentHashMap;
/**
* Class for managing dom operation. This class works as the client in the command pattern, it
* will call {@link WXDomStatement} for creating command object and invoking corresponding
* operation.
* Methods in this class normally need to be invoked in dom thread, otherwise, {@link
* WXRuntimeException} may be thrown.
*/
public final class WXDomManager {
private WXThread mDomThread;
/** package **/ Handler mDomHandler;
private WXRenderManager mWXRenderManager;
private ConcurrentHashMap<String, WXDomStatement> mDomRegistries;
public WXDomManager(WXRenderManager renderManager) {
mWXRenderManager = renderManager;
mDomRegistries = new ConcurrentHashMap<>();
mDomThread = new WXThread("WeeXDomThread", new WXDomHandler(this));
mDomHandler = mDomThread.getHandler();
}
public void sendEmptyMessageDelayed(int what, long delayMillis) {
if (mDomHandler == null || mDomThread == null
|| !mDomThread.isWXThreadAlive() || mDomThread.getLooper() == null) {
return;
}
mDomHandler.sendEmptyMessageDelayed(what, delayMillis);
}
public void sendMessage(Message msg) {
if (msg == null || mDomHandler == null || mDomThread == null
|| !mDomThread.isWXThreadAlive() || mDomThread.getLooper() == null) {
return;
}
mDomHandler.sendMessage(msg);
}
/**
* Remove the specified dom statement. This is called when {@link WXSDKManager} destroy
* instances.
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
*/
public void removeDomStatement(String instanceId) {
if (!WXUtils.isUiThread()) {
throw new WXRuntimeException("[WXDomManager] removeDomStatement");
}
final WXDomStatement statement = mDomRegistries.remove(instanceId);
if (statement != null) {
post(new Runnable() {
@Override
public void run() {
statement.destroy();
}
});
}
}
public void post(Runnable task) {
if (mDomHandler == null || task == null || mDomThread == null || !mDomThread.isWXThreadAlive()
|| mDomThread.getLooper() == null) {
return;
}
mDomHandler.post(WXThread.secure(task));
}
/**
* Destroy current instance
*/
public void destroy() {
if (mDomThread != null && mDomThread.isWXThreadAlive()) {
mDomThread.quit();
}
if (mDomRegistries != null) {
mDomRegistries.clear();
}
mDomHandler = null;
mDomThread = null;
}
/**
* Invoke {@link WXDomStatement} for creating body according to the JSONObject.
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
* @param element the jsonObject according to which to create command object.
*/
void createBody(String instanceId, JSONObject element) {
if (!isDomThread()) {
throw new WXRuntimeException("Create body operation must be done in dom thread");
}
WXDomStatement statement = new WXDomStatement(instanceId, mWXRenderManager);
mDomRegistries.put(instanceId, statement);
statement.createBody(element);
}
private boolean isDomThread() {
return !WXEnvironment.isApkDebugable() || Thread.currentThread().getId() == mDomThread.getId();
}
/**
* Batch the execution of {@link WXDomStatement}
*/
void batch() {
if (!isDomThread()) {
throw new WXRuntimeException("Batch operation must be done in dom thread");
}
Iterator<Entry<String, WXDomStatement>> iterator = mDomRegistries.entrySet().iterator();
while (iterator.hasNext()) {
iterator.next().getValue().batch();
}
}
/**
* Invoke {@link WXDomStatement} for adding a dom node to its parent in a specific location.
*
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
* @param element the dom object in the form of JSONObject
* @param parentRef parent to which the dom is added.
* @param index the location of which the dom is added.
*/
void addDom(String instanceId, String parentRef, JSONObject element, int index) {
if (!isDomThread()) {
throw new WXRuntimeException("Add dom operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.addDom(element, parentRef, index);
}
/**
* Invoke {@link WXDomStatement} for removing the specified {@link WXDomObject}.
*
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
* @param ref of the dom.
*/
//removeElement(ref:String)
void removeDom(String instanceId, String ref) {
if (!isDomThread()) {
throw new WXRuntimeException("Remove dom operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.removeDom(ref);
}
/**
* Invoke {@link WXDomStatement} for moving the specific {@link WXDomObject} to a new parent.
*
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
* @param ref of the dom to be moved.
* @param parentRef of the new parent DOM node
* @param index the index of the dom to be inserted in the new parent.
*/
void moveDom(String instanceId, String ref, String parentRef, int index) {
if (!isDomThread()) {
throw new WXRuntimeException("Move dom operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.moveDom(ref, parentRef, index);
}
/**
* Invoke {@link WXDomStatement} for updating the attributes according to the
* given attribute.
*
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
* @param ref of the dom.
* @param attr the new attribute. This attribute is only a part of the full attribute, and will be
* merged into attributes
*/
void updateAttrs(String instanceId, String ref, JSONObject attr) {
if (!isDomThread()) {
throw new WXRuntimeException("UpdateAttrs operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.updateAttrs(ref, attr);
}
/**
* Invoke {@link WXDomStatement} for updating style
*
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
* @param ref the given dom object
* @param style the given style.
*/
void updateStyle(String instanceId, String ref, JSONObject style) {
if (!isDomThread()) {
throw new WXRuntimeException("UpdateStyle operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.updateStyle(ref, style);
}
/**
* Invoke {@link WXDomStatement} for adding a default event listener to the corresponding {@link
* WXDomObject}.
*
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
* @param ref of the dom.
* @param type the type of the event, this may be a plain event defined in
* {@link com.taobao.weex.common.Constants.Event} or a gesture defined in {@link com.taobao
* .weex.ui.view.gesture.WXGestureType}
*/
void addEvent(String instanceId, String ref, String type) {
if (!isDomThread()) {
throw new WXRuntimeException("AddEvent operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.addEvent(ref, type);
}
/**
* Invoke the {@link WXDomStatement} for removing the event listener of the corresponding {@link
* WXDomObject}.
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance
* @param ref of the dom.
* @param type the type of the event, this may be a plain event defined in
* {@link com.taobao.weex.common.Constants.Event} or a gesture defined in {@link com.taobao
* .weex.ui.view.gesture.WXGestureType}
*/
void removeEvent(String instanceId, String ref, String type) {
if (!isDomThread()) {
throw new WXRuntimeException("RemoveEvent operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.removeEvent(ref, type);
}
/**
* Invoke the {@link WXDomStatement} for scrolling the given view to the specified position.
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance to
* scroll.
* @param ref of the dom.
* @param options the specified position
*/
void scrollToDom(String instanceId, String ref, JSONObject options) {
if (!isDomThread()) {
throw new WXRuntimeException("ScrollToDom operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.scrollToDom(ref, options);
}
/**
* Notify the creating of whole dom tree has finished. This message is sent by JS.
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance to
* notify.
*/
void createFinish(String instanceId) {
if (!isDomThread()) {
throw new WXRuntimeException("CreateFinish operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.createFinish();
}
/**
* Notify the refreshing has finished.
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance to
* notify.
*/
void refreshFinish(String instanceId) {
if (!isDomThread()) {
throw new WXRuntimeException("RefreshFinish operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.refreshFinish();
}
/**
* Notify the update has finished.
* @param instanceId {@link com.taobao.weex.WXSDKInstance#mInstanceId} for the instance to
* notify.
*/
void updateFinish(String instanceId) {
if (!isDomThread()) {
throw new WXRuntimeException("RefreshFinish operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.updateFinish();
}
void startAnimation(@NonNull String instanceId,
@NonNull String ref,
@NonNull String animation,
@Nullable String callBack){
if (!isDomThread()) {
throw new WXRuntimeException("RefreshFinish operation must be done in dom thread");
}
WXDomStatement statement = mDomRegistries.get(instanceId);
if (statement == null) {
return;
}
statement.startAnimation(ref,animation,callBack);
}
public void addRule(final String type,final JSONObject jsonObject) {
if (Constants.Name.FONT_FACE.equals(type)) {
FontDO fontDO = parseFontDO(jsonObject);
if (fontDO != null && !TextUtils.isEmpty(fontDO.getFontFamilyName())) {
FontDO cacheFontDO = TypefaceUtil.getFontDO(fontDO.getFontFamilyName());
if (cacheFontDO == null || !TextUtils.equals(cacheFontDO.getUrl(), fontDO.getUrl())) {
TypefaceUtil.putFontDO(fontDO);
TypefaceUtil.loadTypeface(fontDO);
} else {
TypefaceUtil.loadTypeface(cacheFontDO);
}
}
}
}
private FontDO parseFontDO(JSONObject jsonObject) {
if(jsonObject == null) {
return null;
}
String src = jsonObject.getString(Constants.Name.SRC);
String name = jsonObject.getString(Constants.Name.FONT_FAMILY);
return new FontDO(name, src);
}
}