Update README.md

Carbs0126 · Jul 4, 2016 · df56c41 · df56c41
1 parent 3aa7f46
commit df56c41
Showing 1 changed file with 127 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,20 +1,137 @@
 # MDDialog
-[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-MDDialog-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/3822)
+
+[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-MDDialog-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/3822)<br>
+* [English](#english)
+
+## 前言
+`MDDialog`是一款`Material Designed`风格的`Dialog`，可以灵活定制其内容以及显示方式，如：可以添加中间的`ContentView`，可以对`ContentView`自由的添加代码操作，如添加点击事件等等；对于多个选项风格的dialog，提供了直接设置多个选项的功能，并提供了精细的UI按下效果、点击回调函数等等。
+
+## 介绍
+这款`Material Designed`风格的`Dialog`的设计灵感来自于MD设计理念，你可以通过使用和`AlertDialog`相似的代码来构建`MDDialog`。
+
+`MDDialog`具有多种有趣的属性：<br>
+1. 可以设置显示/隐藏title、显示/隐藏 确定/取消按钮（或者同时隐藏两个button，具体UI效果可见微信的选择对话框）；<br>
+2. 可以向`MDDialog`添加一个自定义的`View`，同时可以在构建`MDDialog`时，使用`setContentViewOperator(...)`函数，添加操作自定义view的代码；<br>
+3. 可以给`MDDialog`设置`String[] messages`，构建`MDDialog`的`builder`中提供了响应点击每一个`String`的回调函数，即，通过`setOnItemClickListener(...)`设置点击每一条目的回调；<br>
+4. 可以自由定制`MDialog`的四个角的半径大小；<br>
+5. `MDDialog`自动为每个`message`提供了按下效果，且按下效果会随着此`item`是否具有圆角而改变；<br>
+6. 可以通过两种方式设置`MDDialog`的宽度，使用宽度占整个屏幕宽度的比值，或使用是精确的尺寸；<br>
+<br>
+  Author:Carbs.Wang<br>
+  Email:yeah0126#yeah.net<br>
+
+## 截图
+<center>
+![you can check the MDDialog_setView.png](https://github.com/Carbs0126/Screenshot/blob/master/md_dialog_setview.png)
+</center><br>
+<center>
+![添加message MDDialog_setMessages](https://github.com/Carbs0126/Screenshot/blob/master/md_dialog_setmessages.png)
+</center>
+
+## 使用
+ 首先添加依赖
+```
+  dependencies {
+    compile 'cn.carbs.android:MDDialog:1.0.0'
+  }
+```
+ 在`java`代码中构造`MDDialog`
+```
+可以构建两种不同模式的MDDialog，这两种模式不能够同时使用
+  1.为MDDialog设置自定义View:
+  new MDDialog.Builder(ActivityMain.this)
+//              .setContentView(customizedView)
+                .setContentView(R.layout.content_dialog)
+                .setContentViewOperator(new MDDialog.ContentViewOperator() {
+                  @Override
+                  public void operate(View contentView) {//这里的contentView就是上面代码中传入的自定义的View或者layout资源inflate出来的view
+                    EditText et = (EditText) contentView.findViewById(R.id.edit0);
+                    et.setHint("hint set in operator");
+                  }
+                })
+                .setTitle("添加")
+                .setNegativeButton(new View.OnClickListener() {
+                  @Override
+                  public void onClick(View v) {
+                  }
+                })
+                .setPositiveButton(new View.OnClickListener() {
+                  @Override
+                  public void onClick(View v) {
+                  }
+                })
+                .setPositiveButtonMultiListener(new MDDialog.OnMultiClickListener() {
+                  @Override
+                    public void onClick(View clickedView, View contentView) {
+					//这里的contentView就是上面代码中传入的自定义的View或者layout资源inflate出来的view，目的是方便在确定/取消按键中对contentView进行操作，如获取数据等。
+                      EditText et = (EditText) contentView.findViewById(R.id.edit0);
+                      Toast.makeText(getApplicationContext(), "edittext 0 : " + et.getText(), Toast.LENGTH_SHORT).show();
+                    }
+                  })
+                .setNegativeButtonMultiListener(new MDDialog.OnMultiClickListener() {
+                  @Override
+                  public void onClick(View clickedView, View contentView) {
+                    EditText et = (EditText) contentView.findViewById(R.id.edit1);
+                    Toast.makeText(getApplicationContext(), "edittext 1 : " + et.getText(), Toast.LENGTH_SHORT).show();
+                  }
+                })
+                .setWidthMaxDp(600)
+//              .setShowTitle(false)//default is true
+//              .setShowButtons(true)//default is true
+                .create()
+              .show();
+            
+    2.设置 String[] messages，每一个String都将对应一个item，具体可以看效果图
+    
+    final String[] messages = new String[]{"两个黄鹂鸣翠柳，一行白鹭上青天。",
+                "窗含西岭千秋雪，门泊东吴万里船。",
+                "君不见，黄河之水天上来，奔流到海不复回；君不见，高堂明镜悲白发，朝如青丝暮如雪。"};
+    new MDDialog.Builder(ActivityMain.this)
+                        .setMessages(messages)
+                        .setTitle("一首古诗")
+                        .setNegativeButton(new View.OnClickListener() {
+                            @Override
+                            public void onClick(View v) {
+                            }
+                        })
+                        .setPositiveButton(new View.OnClickListener() {
+                            @Override
+                            public void onClick(View v) {
+                                Toast.makeText(getApplicationContext(), "positive", Toast.LENGTH_SHORT).show();
+                            }
+                        })
+                        .setOnItemClickListener(new MDDialog.OnItemClickListener() {
+                            @Override
+                            public void onItemClicked(int index) {
+                                Toast.makeText(getApplicationContext(), messages[index], Toast.LENGTH_SHORT).show();
+                            }
+                        })
+                        .setWidthMaxDp(600)
+                        .setShowTitle(false)
+                        .setShowButtons(true)
+                        .create()
+                      .show();
+    
+```
+
+
+#English
 
 ## Abstract
 a material designed style dialog, can add operation of content view, set messages, respond to onclick of messages items and so on
 
 ## Introduction
-an MDDialog inspired by the Material Design Pattern. You can get a MD style dialog quickly by using MDDialog Builder.
-this MDDialog has many interesting configurations such as :
+the `MDDialog` inspired by the `Material Design` Pattern. You can get a MD style dialog quickly by using `MDDialog Builder`.
+this `MDDialog` has many interesting configurations such as :
   1. you can hide or show title or positive/negative button(or both)
-  2. you can add a customized view into the MDDialog, and can add code to control the customized view in Builder' fuction "setContentViewOperator(...)"
-  3. you can set an String[] messages into MDDialog, and each item of messages will be one view in MDDialog, and can set setOnItemClickListener(...) for each item of messages.
-  4. you can customize the corner's radius of MDDialog.
-  5. MDDialog has the pressed effect of each messages item, and the shape of pressed effect is the same as item's shape
-  6. two ways to set the MDDialog width, the ratio of screen width, or the exact dimension
+  2. you can add a `customized view` into the `MDDialog`, and can add code to control the customized view in Builder' fuction `setContentViewOperator(...)`
+  3. you can set an `String[] messages` into `MDDialog`, and each item of messages will be one view in `MDDialog`, and can set `setOnItemClickListener(...)` for each item of messages.
+  4. you can customize the corner's radius of `MDDialog`.
+  5. `MDDialog` has the pressed effect of each messages item, and the shape of pressed effect is the same as item's shape
+  6. two ways to set the `MDDialog` width, the ratio of screen width, or the exact dimension<br>
+  <br>
   Author:Carbs.Wang
-
+  <br>
   Email:yeah0126#yeah.net
 
 ## Screenshot
@@ -32,7 +149,7 @@ this MDDialog has many interesting configurations such as :
     compile 'cn.carbs.android:MDDialog:1.0.0'
   }
 ```
- how to build the MDDialog in java code
+ how to build the `MDDialog` in java code
 ```
 two mode to create MDDialog
   1.set customize view :