Make an android custom view,Publish and Open Source

Today I’m going to create an android custom view to implement circular SeekBar like the mockup below, make it as a library, open source at GitHub, and publish it to JCenter. In this post, I will cover several fundamental concepts of android custom view, write a helpful README on GitHub, and how to publish your library.

Before you start…

Try to understand the requirement or design specification, take a look at this widget first, the user can touch the indicator icon through this arc to set the current progress level. The indicator icon will stop dragging when exceeding max or min progress. It works like an extension of circular SeekBar with customized appearances and motion event.

Get started:

All the android view widgets are based on View, to implement custom view, you will start a subclass of View and override several lifecycle callback methods of view, so you need to understand the view lifecycle at first. The following diagram shows some important methods to override:

To get started, the first thing we have to do is to create a class that extends View, and provide two default constructors which allows us to create the view programmatically (1st constructor) or in XML layout (2nd constructor). The SwagPoint(Context context, AttributeSet attrs) constructor is more important here because it is used when Android inflates the view from XML layout file, otherwise you will get exception.

public class SwagPoints extends View {

  // used in view creation programmatically
  public SwagPoints(Context context) {
      super(context);
  }

  // used in XML layout file
  public SwagPoints(Context context, AttributeSet attrs) {
      super(context, attrs);
  }
  
}

Then, there are several things we have to control or modify in our custom view:

Attributes: What things are customizable in your view? Determine custom attributes that allow developer to change its appearance and behavior in XML layout file according to their design.
Size: Determine the dimensions of the view and every components in this custom view on the screen.
Drawing: Determine how the view and components to render on the screen which contains the shape, location, appearance.
Touch: Determine the way the user can interact with the view by touching.

1. Attribute:

Here we provide several customizable attributes for developer: the initial progress points, the range of progress max/min, the interval when user change the progress step, the color and size of progress/arc/text. To define custom attributes, we create res/values/attrs.xml file and define custom attributes for your view in a <declare-styleable> resource element as below.

<resources>
    <declare-styleable name="SwagPoints">
        <attr name="points" format="integer" />
        <attr name="max" format="integer" />
        <attr name="min" format="integer"/>
        <attr name="step" format="integer"/>

        <attr name="indicatorIcon" format="reference" />

        <attr name="progressWidth" format="dimension" />
        <attr name="progressColor" format="color" />

        <attr name="arcWidth" format="dimension" />
        <attr name="arcColor" format="color" />

        <attr name="textSize" format="dimension"/>
        <attr name="textColor" format="color"/>

        <attr name="clockwise" format="boolean" />
        <attr name="enabled" format="boolean" />

    </declare-styleable>

</resources>

After adding res/values/attrs.xml file, to use TypedArray to retrieve attribute value in class and define instance variables (the following variable with m as prefix name) to store. Here we add a init() method to put init() inside the constructor after super() method to do this job:

private void init(Context context, AttributeSet attrs) {

  float density = getResources().getDisplayMetrics().density;

  // Defaults, may need to link this into theme settings
  int arcColor = ContextCompat.getColor(context, R.color.color_arc);
  int progressColor = ContextCompat.getColor(context, R.color.color_progress);
  int textColor = ContextCompat.getColor(context, R.color.color_text);
  mProgressWidth = (int) (mProgressWidth * density);
  mArcWidth = (int) (mArcWidth * density);
  mTextSize = (int) (mTextSize * density);

  mIndicatorIcon = ContextCompat.getDrawable(context, R.drawable.indicator);

  if (attrs != null) {
      // Attribute initialization
      final TypedArray a = context.obtainStyledAttributes(attrs,
              R.styleable.SwagPoints, 0, 0);

      Drawable indicatorIcon = a.getDrawable(R.styleable.SwagPoints_indicatorIcon);
      if (indicatorIcon != null)
          mIndicatorIcon = indicatorIcon;

      int indicatorIconHalfWidth = mIndicatorIcon.getIntrinsicWidth() / 2;
      int indicatorIconHalfHeight = mIndicatorIcon.getIntrinsicHeight() / 2;
      mIndicatorIcon.setBounds(-indicatorIconHalfWidth, -indicatorIconHalfHeight, indicatorIconHalfWidth,
              indicatorIconHalfHeight);

      mPoints = a.getInteger(R.styleable.SwagPoints_points, mPoints);
      mMin = a.getInteger(R.styleable.SwagPoints_min, mMin);
      mMax = a.getInteger(R.styleable.SwagPoints_max, mMax);
      mStep = a.getInteger(R.styleable.SwagPoints_step, mStep);

      mProgressWidth = (int) a.getDimension(R.styleable.SwagPoints_progressWidth, mProgressWidth);
      progressColor = a.getColor(R.styleable.SwagPoints_progressColor, progressColor);

      mArcWidth = (int) a.getDimension(R.styleable.SwagPoints_arcWidth, mArcWidth);
      arcColor = a.getColor(R.styleable.SwagPoints_arcColor, arcColor);

      mTextSize = (int) a.getDimension(R.styleable.SwagPoints_textSize, mTextSize);
      mTextColor = a.getColor(R.styleable.SwagPoints_textColor, mTextColor);

      mClockwise = a.getBoolean(R.styleable.SwagPoints_clockwise,
              mClockwise);
      mEnabled = a.getBoolean(R.styleable.SwagPoints_enabled, mEnabled);
      a.recycle();
  }
}

2. Size:

In order to control the view dimension, we have to override View.onMeasure() method and calculate the size of each components. Here we have to define the arc radius according to the width/height of our view.

@Override
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {

  final int width = getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec);
  final int height = getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec);
  final int min = Math.min(width, height);

  mTranslateX = (int) (width * 0.5f);
  mTranslateY = (int) (height * 0.5f);

  int arcDiameter = min - getPaddingLeft();
  mArcRadius = arcDiameter / 2;
  float top = height / 2 - (arcDiameter / 2);
  float left = width / 2 - (arcDiameter / 2);
  mArcRect.set(left, top, left + arcDiameter, top + arcDiameter);

  updateIndicatorIconPosition();
  super.onMeasure(widthMeasureSpec, heightMeasureSpec);
}

3. Drawing:

Give you a pen and a paper, you can draw what you want. To draw the view, you have to override the onDraw(Canvas canvas) method. Before that, we have to know what to draw and how to draw. Android provides two classes to do this job:

What to draw, handled by Canvas which is provided as parameter in onDraw() method.
How to draw, handled by Paint.

Before you use Canvas to draw anything, it’s necessary to create Paint objects. For performance optimization, creating the Paint objects ahead is quite important, because the onDraw() method is called when redrawn is needed at anytime, we won’t create the Paint objects inside the onDraw() method, we should avoid any allocation in onDraw() method. Here we define these objects (one for arc, another for progress and the other for text) as instance variables and initialize at init() method:

private void init(Context context, AttributeSet attrs) {
  // ...
  
  mArcPaint = new Paint();
  mArcPaint.setColor(arcColor);
  mArcPaint.setAntiAlias(true);
  mArcPaint.setStyle(Paint.Style.STROKE);
  mArcPaint.setStrokeWidth(mArcWidth);

  mProgressPaint = new Paint();
  mProgressPaint.setColor(progressColor);
  mProgressPaint.setAntiAlias(true);
  mProgressPaint.setStyle(Paint.Style.STROKE);
  mProgressPaint.setStrokeWidth(mProgressWidth);

  mTextPaint = new Paint();
  mTextPaint.setColor(textColor);
  mTextPaint.setAntiAlias(true);
  mTextPaint.setStyle(Paint.Style.FILL);
  mTextPaint.setTextSize(mTextSize);
}

Once we have Paint objects defined, we can start to implement the onDraw(Canvas canvas) method, here we’re going to draw the text to display current progress number, the arc and current progress:

@Override
protected void onDraw(Canvas canvas) {
  if (!mClockwise) {
      canvas.scale(-1, 1, mArcRect.centerX(), mArcRect.centerY());
  }

  // draw the text
  String textPoint = String.valueOf(mPoints);
  mTextPaint.getTextBounds(textPoint, 0, textPoint.length(), mTextRect);
  // center the text
  int xPos = canvas.getWidth() / 2 - mTextRect.width() / 2;
  int yPos = (int)((mArcRect.centerY()) - ((mTextPaint.descent() + mTextPaint.ascent()) / 2));
  canvas.drawText(String.valueOf(mPoints), xPos, yPos, mTextPaint);

  // draw the arc and progress
  canvas.drawArc(mArcRect, ANGLE_OFFSET, 360, false, mArcPaint);
  canvas.drawArc(mArcRect, ANGLE_OFFSET, mProgressSweep, false, mProgressPaint);

  if (mEnabled) {
      // draw the indicator icon
      canvas.translate(mTranslateX - mIndicatorIconX, mTranslateY - mIndicatorIconY);
      mIndicatorIcon.draw(canvas);
  }
}

After overriding onDraw() method, there is one more important method about drawing to introduce: invalidate(), this method is used when any redrawing is needed, we won’t call onDraw() directly, we just call this method instead, you can use this method anywhere inside your custom view, however, for performance optimization, make sure it’s called as infrequently as possible.

4. Touching:

When the user touch the screen, Android calls the onTouchEvent() method, so we override View.onTouchEvent() to handle the user input gestures:

@Override
public boolean onTouchEvent(MotionEvent event) {
  if (mEnabled) {
      this.getParent().requestDisallowInterceptTouchEvent(true);

      switch (event.getAction()) {
          case MotionEvent.ACTION_DOWN:
              if (mOnSwagPointsChangeListener != null)
                  mOnSwagPointsChangeListener.onStartTrackingTouch(this);
              updateOnTouch(event);
              break;
          case MotionEvent.ACTION_MOVE:
              updateOnTouch(event);
              break;
          case MotionEvent.ACTION_UP:
              if (mOnSwagPointsChangeListener != null)
                  mOnSwagPointsChangeListener.onStopTrackingTouch(this);
              setPressed(false);
              this.getParent().requestDisallowInterceptTouchEvent(false);
              break;
          case MotionEvent.ACTION_CANCEL:
              if (mOnSwagPointsChangeListener != null)
                  mOnSwagPointsChangeListener.onStopTrackingTouch(this);
              setPressed(false);
              this.getParent().requestDisallowInterceptTouchEvent(false);
              break;
      }
      return true;
  }
  return false;
}

There are several things we have to control when user touches the indicator or other place of view:

Update the indicator icon position and progress text.
Draw the current progress on the arc.
Stop when reaching max or min.

To know the indicator icon position and the current progress to draw, we have to convert the touch coordinate on the screen to the angle of arc.

In our custom view, we consider the center of arc as origin (0, 0), and use trigonometric functions to transform the touch coordinate into the angle of the arc in degree (0, 360), and map to the current progress value of given range (min, max).

Here we have a method to convert from touch coordinate to the arc angle:

private double convertTouchEventPointToAngle(float xPos, float yPos) {
  // transform touch coordinate into component coordinate
  float x = xPos - mTranslateX;
  float y = yPos - mTranslateY;

  x = (mClockwise) ? x : -x;
  double angle = Math.toDegrees(Math.atan2(y, x) + (Math.PI / 2));
  angle = (angle < 0) ? (angle + 360) : angle;
  return angle;
}

Final demo

Open source at GitHub:

So you just finish a android custom view project, great! Let’s put on GitHub to get more developers to use you project. However, before you share your GitHub link to others, just make sure you have a nice document first. When developers are looking at you project, there are some points they care about:

Does this project fit my requirement or solve my problem?
If the answer is YES, how can I get starting right now?

A nice document is like a salesman for you project. The README plays this important role to give the first impression to the developers who are looking at your project, so providing a well-documented README is necessary and gives you more chance to promote you project.

Knowing how to write a REAME is equivalently important to write a clean code or design a great architecture.

1. Provide a screenshot and short description:

A picture is worth a thousand words, especially in a UI widget project, make sure that you provide a photo, GIF or video with a short description to demonstrate how your UI looks like or works. (If you are familiar with some design software, i.e. Sketch or PhotoShop, try to use them to help you make a great cover with the screenshot for your project)

Give easy installation/usage instruction

Before using you project, developer have to install it first, make sure to give a clean and easy installation instruction to get started. After installing you project successfully, just give some example code snippet to show what your project does, and how the developers can customize what they want, maybe just give a list of customizable attributes or provide an APK to install or sample module to run.

Publish your library:

After finish pushing your project to GitHub, there is the last step to get done: publish it so that developers can just add dependency

dependencies {
    ...
    compile 'com.dualcores.swagpoints:swagpoints:1.0.0'
}

to use you project. Here we go:

1. Sign-up or sign-in at JFrog Bintray.

2. Go to profile page to create a repository, package, and version:

The repository is the place to host your several projects. You can choose any repository name whatever you want, it doesn’t matter for other developers.

Inside the new repository, you can create a package, that is place to host your project. Your project also can import from GitHub.

For each package, you can create several versions, again, you can choose whatever name you want, not restricted to the traditional version number major.minor.patch rule.

3. Generate and upload the aar files:

We use gradle to do this job, here I use this library to help https://github.com/blundell/release-android-library. Open you library module gradle file, add the following code snippet to buttom of module build.gradle file:

// or use the remote copy to keep update with latest changes
apply from: 'https://raw.githubusercontent.com/blundell/release-android-library/master/android-release-aar.gradle'

and JCenter configuration:

then, sync your project and open your terminal, go to your project root path, execute the command:

./gradlew clean build generateRelease

If success, you will see the result in you terminal and you can upload the zip file from PROJECT_ROOT/library/build/release/1.0.0/:

4. Add to JCenter:

Go back to your project page in bintray, there will be a Add to JCenter button in right-hand column, just click it to fill out a message and wait to be accepted. It takes hours or several days to be accepted, just be patient. This step is required so that to make your project downloadable and discoverable by gradle dependencies.

5. Project is accepted and test if everything is all right:

You will receive an email to inform you that your Add to JCenter request is accepted.Once it is accepted, test if gradle dependency works well by adding the dependency to sample module and sync. If it builds successfully, congratulation!!!! You’ve done. Good job~

compile 'com.dualcores.swagpoints:swagpoints:1.0.0'

Solarex's Blog

我只想过，平平淡淡的生活，欲望啊，请放过脆弱的我

Make an Android Custom view,Publish and Open Source