package com.jmobilecore.ui.core;

import javax.microedition.lcdui.Font;

/**
 * The interface ListComponent is required for all list-related components.
 * In this respect, the class ListComponent is analogous to the abstract superclass Component
 * for jMobileCore components.
 *
 * @author Greg Gridin
 */
public interface ListComponent {

    /**
     * Get textual representation of the <code>ListComponent</code>
     *
     * @return the textual representation of the component
     */
    public String getText();

    /**
     * Sets the textual representation of the <code>ListComponent</code>
     *
     * @param text the new textual representation of the component
     */
    public void setText(String text);

    /**
     * Get the list component's font
     *
     * @return the current font
     */
    public Font getFont();

    /**
     * Sets the font of this list component.
     *
     * @param font the font to become this list component's font;
     */
    public void setFont(Font font);

    /**
     * Get the key code shortcut for this list component
     *
     * @return the keycode shortcut
     */
    public int getShortcut();

    /**
     * Sets the key code shortcut for this list component
     *
     * @param shortcut the keycode - new shortcut value
     */
    public void setShortcut(int shortcut);

    /**
     * Get the object representing the list component's action
     *
     * @return the object associated with this list component
     */
    public Object getAction();

    /**
     * Sets the object as list component's action
     *
     * @param action the object - new action value
     */
    public void setAction(Object action);

} // interface ListComponent