您的位置:首页 > 移动开发 > Android开发

开源侧滑菜单SlidingMenu主要方法介绍

2013-09-27 19:08 363 查看
SlidingMenu是一个很好使用的侧滑菜单开源项目,它的表现形式类似于DrawerLayout和SlidingDrawer,具体效果如下图所示,左侧为侧滑Menu菜单,右侧黑色部分为内容显示视图Content:



         下面是SlidingMenu主要的方法:

全局常量:

         //侧滑菜单通过手势的打开方式

         publicstatic final int TOUCHMODE_MARGIN = 0;    //触摸屏幕边缘打开侧滑菜单

         publicstatic final int TOUCHMODE_FULLSCREEN = 1;//触摸屏幕的任何位置打开侧滑菜单

         publicstatic final int TOUCHMODE_NONE = 2;          //禁止通过手势打开侧滑菜单

         //侧滑菜单的显示位置

         publicstatic final int LEFT = 0;                                      //侧滑菜单显示在内容视图左边

         publicstatic final int RIGHT = 1;                                  //侧滑菜单显示在内容视图右边

         publicstatic final int LEFT_RIGHT = 2;                       //侧滑菜单放在内容视图的左边和右边

公用方法:

/**
*设置内容显示视图的布局资源
* @param res 布局文件资源ID
*/
public void setContent(int res) {
setContent(LayoutInflater.from(getContext()).inflate(res, null));
}

/**
* 设置内容显示视图的布局资源
* @param view 自定义View视图
*/
public void setContent(View view) {
mViewAbove.setContent(view);
showContent();
}

/**
* 返回内容显示视图
* @return 当前内容显示视图
*/
public View getContent() {
return mViewAbove.getContent();
}

/**
* 设置侧滑菜单的布局*
* @param res 布局资源id
*/
public void setMenu(int res) {
setMenu(LayoutInflater.from(getContext()).inflate(res, null));
}

/**
* 设置侧滑菜单的界面
* @param view 自定义View视图
*/
public void setMenu(View v) {
mViewBehind.setContent(v);
}

/**
* 获取侧滑菜单视图
* @return 侧滑菜单视图
*/
public View getMenu() {
return mViewBehind.getContent();
}

/**
* 是否使能侧滑菜单,如果设置为false则表示不能通过手势或者其它方式呼出侧滑菜单
* @param b 是否使能侧滑菜单
*/
public void setSlidingEnabled(boolean b) {
mViewAbove.setSlidingEnabled(b);
}

/**
* 返回侧滑菜单的使能状态
*
* @return true, 侧滑菜单可用
*/
public boolean isSlidingEnabled() {
return mViewAbove.isSlidingEnabled();
}

/**
* 设置侧滑菜单的显示方式
* @param mode 设置侧滑菜单显示位置 LEFT/RIGHT/LEFT_RIGHT
*/
public void setMode(int mode) {
if (mode != LEFT && mode != RIGHT && mode != LEFT_RIGHT) {
throw new IllegalStateException("SlidingMenu mode must be LEFT, RIGHT, or LEFT_RIGHT");
}
mViewBehind.setMode(mode);
}

/**
* 返回当前侧滑菜单处于那种显示模式
* @return 侧滑菜单当前显示模式,LEFT/RIGHT
*/
public int getMode() {
return mViewBehind.getMode();
}

/**
* 设置侧滑菜单是否处于静止状态
* @param b true侧滑菜单处于静止状态, false 禁止侧滑菜单处于静止状态
*/
public void setStatic(boolean b) {
if (b) {
setSlidingEnabled(false);
mViewAbove.setCustomViewBehind(null);
mViewAbove.setCurrentItem(1);
} else {
mViewAbove.setCurrentItem(1);
mViewAbove.setCustomViewBehind(mViewBehind);
setSlidingEnabled(true);
}
}

/**
* 显示侧滑菜单
*/
public void showMenu() {
showMenu(true);
}

/**
* 显示侧滑菜单
*
* @param animate true打开侧滑菜单时有动画效果, false 打开侧滑菜单时没有动画效果
*/
public void showMenu(boolean animate) {
mViewAbove.setCurrentItem(0, animate);
}

/**
* 关闭侧滑菜单并显示内容视图
*/
public void showContent() {
showContent(true);
}

/**
*关闭侧滑菜单并显示内容视图
*
* @param animate true 打开内容显示视图时有动画效果, false打开内容视图时没有动画效果
*/
public void showContent(boolean animate) {
mViewAbove.setCurrentItem(1, animate);
}

/**
* 切换侧滑菜单和内容显示视图的显示状态
* 切换侧滑菜单视图和内容显示视图,显示隐藏都带动画
*/
public void toggle() {
toggle(true);
}

/**
* 切换侧滑菜单视图和内容显示视图,可设置显示隐藏是否带动画
* @param animate true 切换时有动画效果, false切换时没有动画效果
*/
public void toggle(boolean animate) {
if (isMenuShowing()) {
showContent(animate);
} else {
showMenu(animate);
}
}

/**
* 侧滑菜单是否处于显示状态
* @return true 侧滑显示处于显示状态 false 侧滑菜单处于不可见状态
*/
public boolean isMenuShowing() {
return mViewAbove.getCurrentItem() == 0 || mViewAbove.getCurrentItem() == 2;
}

/**
* 得到侧滑菜单右侧相对于屏幕右侧的距离
* @return 侧滑菜单右侧相对于屏幕右侧的距离
*/
public int getBehindOffset() {
return ((RelativeLayout.LayoutParams)mViewBehind.getLayoutParams()).rightMargin;
}

/**
* 设置侧滑菜右侧相对于屏幕右侧的距离
* @param i 侧滑菜右侧相对于屏幕右侧的距离
*/
public void setBehindOffset(int i) {
mViewBehind.setWidthOffset(i);
}

/**
* 设置侧滑菜单宽度
* @param i 侧滑菜单宽度*/
@SuppressWarnings("deprecation")
public void setBehindWidth(int i)

/**
* 获取slidingmenu手势打开模式
* @return slidingmenu手势打开模式
*/
public int getTouchModeAbove() {
return mViewAbove.getTouchMode();
}

/**
* 设置SlidingMenu手势打开模式
* @param i SlidingMenu手势打开模式
*/
public void setTouchModeAbove(int i) {
if (i != TOUCHMODE_FULLSCREEN && i != TOUCHMODE_MARGIN
&& i != TOUCHMODE_NONE) {
throw new IllegalStateException("TouchMode must be set to either" +
"TOUCHMODE_FULLSCREEN or TOUCHMODE_MARGIN or TOUCHMODE_NONE.");
}
mViewAbove.setTouchMode(i);
}

/**
* 设置阴影宽度
* @param 阴影宽度,单位为像素
*/
public void setShadowWidth(int pixels) {
mViewBehind.setShadowWidth(pixels);
}


附件:https://github.com/zmywly8866/SlidingMenu?source=cc
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
相关文章推荐