Update README

Author: itzikBraun

.idea/modules.xml

@@ -3,23 +3,26 @@
 
 ![alt tag](http://raw.github.com/ItzikBraun/TutorialView/master/screen_shots/example.gif)
 
-An Android library project providing Activity with explenation about views in your app.
+An Android library project providing `Activity` with explanation about views in your app.
 
-The TutorialActivity can be used as a walk through for the entire screen that is currently visible, Or just for one view on the screen.
+The `TutorialActivity` can be used as a walk through for the entire screen that is currently visible, Or just for one view on the screen.
 
-To get the intent to start the TutorialActivity you need to use the TutorialIntentBuilder, The builder will help you build the intent to start the activity, You would have to pass a Tutorial object to the intent builder.
+To get the intent to start the `TutorialActivity` you need to use the `TutorialIntentBuilder`,
+The builder will help you build the intent to start the activity, You would have to pass a `Tutorial` object to the intent builder.
 
 ###Usage
 ####Tutorial
-The tutorial object holds the tutorial info and attributes. You can create a Tutorial by using the TutorialBuilder.
+The tutorial object holds the tutorial info and attributes. You can create a Tutorial by using the `TutorialBuilder`.
 You can customize the following:
-* Title - Will apear on the top of the view, If the view that is surrounded is on top it will be shown below it.
-* TutorialText - The explanation of about the view, It will apear above or below the view.
+* Title - Will appear on the top of the view, If the view that is surrounded is on top it will be shown below it.
+* TutorialText - The explanation of about the view, It will appear above or below the view.
 * BackgroundColor - The background color of the view.
-* TutorialTextSize - The size that will be used for the tutorial explantion text.
+* TutorialTextSize - The size that will be used for the tutorial explanation text.
 * TypefaceName - The path to the wanted typeface to use for all text view in the tutorial, Example: "/fonts/arial.ttf".
 * AnimationDuration - the duration time in milliseconds that will be used for the animation.
-* ~~AnimatinType - the animation that will be used for showing and hiding the tutorial~~ This is a work in progress currently not working.
+* InfoPosition - The position of the info text, This could be Above, Below, LeftOf and Right of all relevant to the view that need to be surrounded. Values are stored in `Tutorial.InfoPosition`
+* GotItPosition - The position of the "GotIt" button, This could be Top(If has title it will be below it) and Bottom. Values are stored in `Tutorial.GotItPosition`
+* ~~AnimationType - the animation that will be used for showing and hiding the tutorial~~ This is a work in progress currently not working.
 
 Each tutorial that was passed holds it's position on screen, title, background color, the text explenation and more customizable attributes.
 
@@ -66,7 +69,7 @@ overridePendingTransition(R.anim.dummy, R.anim.dummy);
 ```
 
 ####Important!
-You should override the activity pending transition aniamtion like this, If you wont override it the TutorialActivity would animate itself in and will ruin the view animation. (Call it after you call startActivity(Intent) ).
+You should override the `Activity` pending transition animation like this, If you wont override it the `TutorialActivity` would animate itself in and will ruin the view animation. (Call it after you call `startActivity(Intent)` ).
 
 
 ``` java
@@ -92,7 +95,7 @@ include':tutorial_view'
 ```
 
 ###TODO:
-* Return result when TutorialActivity finishes so you could know when it was done and if was skipped.
+* Return result when `TutorialActivity` finishes so you could know when it was done and if was skipped.
 
 ###Author
 [Itzik Braun - Google+](https://plus.google.com/+ItzikBraunster)

README.md

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$" external.system.id="GRADLE" type="JAVA_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="java-gradle" name="Java-Gradle">
+      <configuration>
+        <option name="BUILD_FOLDER_PATH" value="$MODULE_DIR$/build" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="false">
+    <output url="file://$MODULE_DIR$/build/classes/main" />
+    <output-test url="file://$MODULE_DIR$/build/classes/test" />
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.gradle" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>
+

TutorialView.iml

@@ -87,4 +87,12 @@ public interface TutorialInterface {
     public void setAnimationDuration(long duration);
 
     public long getAnimationDuration();
+
+    public void setTutorialInfoTextPosition(int infoTextPosition);
+
+    public int getTutorialInfoTextPosition();
+
+    public void setTutorialGotItPosition(int gotItPosition);
+
+    public int getTutorialGotItPosition();
 }

tutorial_view/src/main/java/com/braunster/tutorialview/TutorialInterface.java

@@ -4,6 +4,7 @@
 import android.os.Parcel;
 import android.os.Parcelable;
 import android.view.View;
+import android.widget.RelativeLayout;
 
 import com.braunster.tutorialview.TutorialInterface;
 import com.braunster.tutorialview.view.AbstractTutorialView;
@@ -20,6 +21,20 @@ public class Tutorial implements Parcelable , TutorialInterface {
      * */
     private String mInfoText;
 
+    /**
+     * Holds the value that will be used for placing the info text in the tutorial view.
+     * 
+     * @see com.braunster.tutorialview.object.Tutorial.InfoPosition 
+     */
+    private int mTutorialInfoTextPosition = InfoPosition.AUTO;
+
+    /**
+     * Holds the value that will be used for placing the "GotIt" button in the tutorial view.
+     *
+     * @see com.braunster.tutorialview.object.Tutorial.GotItPosition
+     */
+    private int mTutorialGotItPosition = GotItPosition.AUTO;
+    
     private float mPositionToSurroundX, mPositionToSurroundY;
     private int mPositionToSurroundWidth, mPositionToSurroundHeight;
 
@@ -185,6 +200,26 @@ public long getAnimationDuration() {
         return mAnimationDuration;
     }
 
+    @Override
+    public void setTutorialInfoTextPosition(int infoTextPosition) {
+        this.mTutorialInfoTextPosition = infoTextPosition;
+    }
+
+    @Override
+    public int getTutorialInfoTextPosition() {
+        return mTutorialInfoTextPosition;
+    }
+
+    @Override
+    public void setTutorialGotItPosition(int gotItPosition) {
+        this.mTutorialGotItPosition = gotItPosition;
+    }
+
+    @Override
+    public int getTutorialGotItPosition() {
+        return mTutorialGotItPosition;
+    }
+
     @Override
     public void setAnimationDuration(long mAnimationDuration) {
         this.mAnimationDuration = mAnimationDuration;
@@ -194,7 +229,6 @@ public void setAnimationDuration(long mAnimationDuration) {
     public void setTutorialTextTypeFace(String mTutorialTextTypeFaceName) {
         this.mTutorialTextTypeFaceName = mTutorialTextTypeFaceName;
     }
-
 
     public String getTutorialTextTypeFace() {
         return mTutorialTextTypeFaceName;
@@ -217,6 +251,8 @@ public String getTutorialTextTypeFace() {
         this.mTutorialTextTypeFaceName = in.readString();
         this.mTutorialTextColor = in.readInt();
         this.mTutorialTextSize = in.readInt();
+        this.mTutorialInfoTextPosition = in.readInt();
+        this.mTutorialGotItPosition = in.readInt();
     }
 
     public static final Parcelable.Creator<Tutorial> CREATOR
@@ -250,5 +286,41 @@ public void writeToParcel(Parcel dest, int flags) {
         dest.writeString(mTutorialTextTypeFaceName);
         dest.writeInt(mTutorialTextColor);
         dest.writeInt(mTutorialTextSize);
+        dest.writeInt(mTutorialInfoTextPosition);
+        dest.writeInt(mTutorialGotItPosition);
+    }
+
+
+    /**
+     * Static values representing available positions for placing the info text in the TutorialView.
+     *
+     * @see Tutorial#mTutorialInfoTextPosition
+     **/
+    public class InfoPosition{
+        public static final int AUTO = -1991, LEFT_OF = RelativeLayout.LEFT_OF, RIGHT_OF = RelativeLayout.RIGHT_OF, ABOVE = RelativeLayout.ABOVE, BELOW = RelativeLayout.BELOW;
+    }
+
+    /**
+     * Static values representing available positions for placing the "GotIt" button in the TutorialView.
+     *
+     * @see Tutorial#mTutorialGotItPosition
+     **/
+    public class GotItPosition{
+
+        /**
+         * The "GotIt" button position will be automatically calculated according to the view to surround position.
+         **/
+        public static final int AUTO = -1991;
+        
+        /** 
+         * Set the "GotIt" button to be in the top part of the tutorial,
+         * If the tutorial has a title then the button will be placed below it.
+         **/
+        public static final int TOP = 0;
+        
+        /**
+         * Set the position of the "GotIt" button to be at the bottom of the tutorial.
+         **/
+        public static final int BOTTOM = 1;
     }
 }

tutorial_view/src/main/java/com/braunster/tutorialview/object/Tutorial.java

@@ -20,6 +20,20 @@ public class TutorialBuilder  {
     private float mPositionToSurroundX = -1, mPositionToSurroundY = -1;
     private int mPositionToSurroundWidth = -1, mPositionToSurroundHeight = -1;
 
+    /**
+     * Holds the value that will be used for placing the info text in the tutorial view.
+     *
+     * @see com.braunster.tutorialview.object.Tutorial.InfoPosition
+     */
+    private int mTutorialInfoTextPosition = Tutorial.InfoPosition.AUTO;
+
+    /**
+     * Holds the value that will be used for placing the "GotIt" button in the tutorial view.
+     *
+     * @see com.braunster.tutorialview.object.Tutorial.GotItPosition
+     */
+    private int mTutorialGotItPosition = Tutorial.GotItPosition.AUTO;
+    
     /**
      * Holds the animation duration that will be used to animate the tutorial in and out.
      *
@@ -148,6 +162,16 @@ public TutorialBuilder setAnimationDuration(long mAnimationDuration) {
         return this;
     }
 
+    public TutorialBuilder setTutorialInfoTextPosition(int infoTextPosition) {
+        this.mTutorialInfoTextPosition = infoTextPosition;
+        
+        return this;
+    }
+
+    public void setTutorialGotItPosition(int gotItPosition) {
+        this.mTutorialGotItPosition = gotItPosition;
+    }
+
     public Tutorial build(){
         Tutorial tutorial = new Tutorial();
 
@@ -173,6 +197,8 @@ public Tutorial build(){
         tutorial.setAnimationDuration(mAnimationDuration);
         tutorial.setAnimationType(mAnimationType);
         tutorial.setTutorialTextTypeFace(mTutorialTextTypeFaceName);
+        tutorial.setTutorialInfoTextPosition(mTutorialInfoTextPosition);
+        tutorial.setTutorialGotItPosition(mTutorialGotItPosition);
 
         return tutorial;
     }

tutorial_view/src/main/java/com/braunster/tutorialview/object/TutorialBuilder.java

@@ -44,7 +44,6 @@ public TutorialIntentBuilder(Intent intent){
     }
 
 
-
     public TutorialIntentBuilder hasStatusBar(boolean hasStatusBar){
         intent.putExtra(HAS_STATUS_BAR, hasStatusBar);
         return this;