Skip to content

Commit

Permalink
Created methods for showing ToolTipViews below ActionBar items
Browse files Browse the repository at this point in the history
  • Loading branch information
@nhaarman
nhaarman committed Aug 5, 2013
1 parent 774c2a5 commit 93662ce
Show file tree
Hide file tree
Showing 2 changed files with 513 additions and 337 deletions.
213 changes: 190 additions & 23 deletions library/src/com/haarman/supertooltips/ToolTipRelativeLayout.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,35 +15,202 @@

package com.haarman.supertooltips;

import android.annotation.TargetApi;
import android.app.ActionBar;
import android.app.Activity;
import android.content.Context;
import android.content.res.Resources;
import android.util.AttributeSet;
import android.view.View;
import android.view.ViewGroup;
import android.widget.RelativeLayout;

public class ToolTipRelativeLayout extends RelativeLayout {

public ToolTipRelativeLayout(Context context) {
super(context);
}

public ToolTipRelativeLayout(Context context, AttributeSet attrs) {
super(context, attrs);
}

public ToolTipRelativeLayout(Context context, AttributeSet attrs, int defStyle) {
super(context, attrs, defStyle);
}

/**
* Shows a ToolTipView based on gived ToolTip at the proper location relative to given View.
*
* @return the ToolTipView that was created.
*/
public ToolTipView showToolTipForView(ToolTip toolTip, final View view) {
final ToolTipView toolTipView = new ToolTipView(getContext());
toolTipView.setToolTip(toolTip, view);
addView(toolTipView);
return toolTipView;
}
public ToolTipRelativeLayout(Context context) {
super(context);
}

public ToolTipRelativeLayout(Context context, AttributeSet attrs) {
super(context, attrs);
}

public ToolTipRelativeLayout(Context context, AttributeSet attrs, int defStyle) {
super(context, attrs, defStyle);
}

/**
* Shows a {@link ToolTipView} based on given {@link ToolTip} at the proper
* location relative to given {@link View}.
*
* @param toolTip
* the ToolTip to show.
* @param view
* the View to position the ToolTipView relative to.
*
* @return the ToolTipView that was created.
*/
public ToolTipView showToolTipForView(final ToolTip toolTip, final View view) {
final ToolTipView toolTipView = new ToolTipView(getContext());
toolTipView.setToolTip(toolTip, view);
addView(toolTipView);
return toolTipView;
}

/**
* Shows a {@link ToolTipView} based on given {@link ToolTip} at the proper
* location relative to the {@link View} with given resource id.</p>NOTE:
* This method will throw a {@link ViewNotFoundRuntimeException} if the View
* is not found. You can choose to ignore this by catching the
* ViewNotFoundRuntimeException.
*
* @param activity
* the Activity which holds the ActionBar.
* @param toolTip
* the ToolTip to show.
* @param resId
* the resource id of the View to position the ToolTipView
* relative to.
* @return the ToolTipView that was created.
*/
public ToolTipView showToolTipForViewResId(final Activity activity, final ToolTip toolTip, final int resId) {
final ToolTipView toolTipView = new ToolTipView(getContext());
final View decorView = activity.getWindow().getDecorView();
final View view = decorView.findViewById(resId);

if (view == null) {
throw new ViewNotFoundRuntimeException();
}

toolTipView.setToolTip(toolTip, view);
addView(toolTipView);
return toolTipView;
}

/**
* Shows a {@link ToolTipView} based on given {@link ToolTip} at the proper
* location relative to the {@link ActionBar} home {@link View}.
*
* @param activity
* the Activity which holds the ActionBar.
* @param toolTip
* the ToolTip to show.
* @return the ToolTipView that was created.
*/
@TargetApi(11)
public ToolTipView showToolTipForActionBarHome(final Activity activity, final ToolTip toolTip) {
final int homeResId = android.R.id.home;
return showToolTipForViewResId(activity, toolTip, homeResId);
}

/**
* Shows a {@link ToolTipView} based on given {@link ToolTip} at the proper
* location relative to the {@link ActionBar} title {@link View}.</p>NOTE:
* This method will throw a {@link NoTitleViewRuntimeException} if the title
* View is not found. You can choose to ignore this by catching the
* NoTitleViewRuntimeException.</p>NOTE: This method uses an internal API to
* find the View. It MAY cause your application to crash in future Android
* versions.
*
* @param activity
* the Activity which holds the ActionBar.
* @param toolTip
* the ToolTip to show.
* @return the ToolTipView that was created.
*/
@TargetApi(11)
public ToolTipView showToolTipForActionBarTitle(final Activity activity, final ToolTip toolTip) {
final int titleResId = Resources.getSystem().getIdentifier("action_bar_title", "id", "android");
if (titleResId == 0) {
throw new NoTitleViewRuntimeException();
}
return showToolTipForViewResId(activity, toolTip, titleResId);
}

/**
* Shows a {@link ToolTipView} based on given {@link ToolTip} at the proper
* location relative to the overflow menu button.</p>NOTE: This method will
* throw a {@link NoOverflowMenuRuntimeException} if the overflow menu is
* not found. This happens when there simply is no overflow menu button, or
* the menu isn't initialised yet. You can choose to ignore this by catching
* the NoOverflowMenuRuntimeException.</p>NOTE: This method uses an internal
* API to find the View. It MAY cause your application to crash in future
* Android versions.
*
* @param activity
* the Activity which holds the ActionBar.
* @param toolTip
* the ToolTip to show.
* @return the ToolTipView that was created.
*/
@TargetApi(11)
public ToolTipView showToolTipForActionBarOverflowMenu(final Activity activity, final ToolTip toolTip) {
return showToolTipForView(toolTip, findActionBarOverflowMenuView(activity));
}

@TargetApi(11)
private View findActionBarOverflowMenuView(final Activity activity) {
final ViewGroup decorView = (ViewGroup) activity.getWindow().getDecorView();

final int actionBarViewResId = Resources.getSystem().getIdentifier("action_bar", "id", "android");
final ViewGroup actionBarView = (ViewGroup) decorView.findViewById(actionBarViewResId);

ViewGroup actionMenuView = null;
for (int i = 0; i < actionBarView.getChildCount(); ++i) {
if (actionBarView.getChildAt(i).getClass().getSimpleName().equals("ActionMenuView")) {
actionMenuView = (ViewGroup) actionBarView.getChildAt(i);
}
}

if (actionMenuView == null) {
throw new NoOverflowMenuRuntimeException();
}

View overflowMenuButton = null;
for (int i = 0; i < actionMenuView.getChildCount(); ++i) {
if (actionMenuView.getChildAt(i).getClass().getSimpleName().equals("OverflowMenuButton")) {
overflowMenuButton = actionMenuView.getChildAt(i);
}
}

if (overflowMenuButton == null) {
throw new NoOverflowMenuRuntimeException();
}

return overflowMenuButton;
}

/**
* A {@link RuntimeException} that is thrown if there is no {@link View}
* found with given resource id. You can choose to ignore this by catching
* the ViewNotFoundRuntimeException.
*/
public class ViewNotFoundRuntimeException extends RuntimeException {
public ViewNotFoundRuntimeException() {
super("View not found for this resource id. Are you sure it exists?");
}
}

/**
* A {@link RuntimeException} that is thrown if the title view in the
* {@link ActionBar} is not found. You can choose to ignore this by catching
* the NoTitleViewRuntimeException.
*/
public class NoTitleViewRuntimeException extends RuntimeException {
public NoTitleViewRuntimeException() {
super("No title View found. Are you sure it exists?");
}
}

/**
* A {@link RuntimeException} that is thrown if the overflow menu is not
* found. This happens when there simply is no overflow menu button, or the
* menu isn't initialised yet. You can choose to ignore this by catching the
* NoOverflowMenuRuntimeException.
*/
public class NoOverflowMenuRuntimeException extends RuntimeException {
public NoOverflowMenuRuntimeException() {
super("No overflow menu found. Are you sure the overflow menu button is visible? Check the docs for showToolTipForActionBarOverflowMenu(Activity, ToolTip) again!");
}
}
}
Loading

0 comments on commit 93662ce

Please sign in to comment.