alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Android example source code file (SubMenu.java)

This example Android source code file (SubMenu.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Android by Example" TM.

Java - Android tags/keywords

android, drawable, drawing, graphics, menu, menuitem, paint, submenu, ui

The SubMenu.java Android example source code

/*
 * Copyright (C) 2007 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.view;

import android.graphics.drawable.Drawable;

/**
 * Subclass of {@link Menu} for sub menus.
 * <p>
 * Sub menus do not support item icons, or nested sub menus.
 */

public interface SubMenu extends Menu {
    /**
     * Sets the submenu header's title to the title given in <var>titleRes
     * resource identifier.
     * 
     * @param titleRes The string resource identifier used for the title.
     * @return This SubMenu so additional setters can be called.
     */
    public SubMenu setHeaderTitle(int titleRes);

    /**
     * Sets the submenu header's title to the title given in <var>title.
     * 
     * @param title The character sequence used for the title.
     * @return This SubMenu so additional setters can be called.
     */
    public SubMenu setHeaderTitle(CharSequence title);
    
    /**
     * Sets the submenu header's icon to the icon given in <var>iconRes
     * resource id.
     * 
     * @param iconRes The resource identifier used for the icon.
     * @return This SubMenu so additional setters can be called.
     */
    public SubMenu setHeaderIcon(int iconRes);

    /**
     * Sets the submenu header's icon to the icon given in <var>icon
     * {@link Drawable}.
     * 
     * @param icon The {@link Drawable} used for the icon.
     * @return This SubMenu so additional setters can be called.
     */
    public SubMenu setHeaderIcon(Drawable icon);
    
    /**
     * Sets the header of the submenu to the {@link View} given in
     * <var>view. This replaces the header title and icon (and those
     * replace this).
     * 
     * @param view The {@link View} used for the header.
     * @return This SubMenu so additional setters can be called.
     */
    public SubMenu setHeaderView(View view);
    
    /**
     * Clears the header of the submenu.
     */
    public void clearHeader();
    
    /**
     * Change the icon associated with this submenu's item in its parent menu.
     * 
     * @see MenuItem#setIcon(int)
     * @param iconRes The new icon (as a resource ID) to be displayed.
     * @return This SubMenu so additional setters can be called.
     */
    public SubMenu setIcon(int iconRes);
    
    /**
     * Change the icon associated with this submenu's item in its parent menu.
     * 
     * @see MenuItem#setIcon(Drawable)
     * @param icon The new icon (as a Drawable) to be displayed.
     * @return This SubMenu so additional setters can be called.
     */
    public SubMenu setIcon(Drawable icon);
    
    /**
     * Gets the {@link MenuItem} that represents this submenu in the parent
     * menu.  Use this for setting additional item attributes.
     * 
     * @return The {@link MenuItem} that launches the submenu when invoked.
     */
    public MenuItem getItem();
}

Other Android examples (source code examples)

Here is a short list of links related to this Android SubMenu.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.