danger.ui
Class BaseMenu

java.lang.Object
  |
  +--danger.app.Listener
        |
        +--danger.ui.View
              |
              +--danger.ui.Container
                    |
                    +--danger.ui.Control
                          |
                          +--danger.ui.BaseMenu

Direct Known Subclasses:

ListSelectMenu, Menu

public abstract class BaseMenu

extends Control

Field Summary

protected boolean

mTruncateOKToEllipsize

Fields inherited from class danger.ui.Control

mValue

Fields inherited from class danger.ui.View

mOriginX, mOriginY, mStyle, STATE_CAN_FOCUS, STATE_DEBUG_BOUNDS, STATE_ENABLED, STATE_FOCUSED, STATE_TRANSPARENT, STATE_VISIBLE

Constructor Summary

BaseMenu(java.lang.String inTitle)

BaseMenu(java.lang.String inTitle, boolean showTitle)

Method Summary

void	addDivider()
void	addDivider(int id)
int	addDividerAndReturnMappedID()
void	addDividerAtPosition(int position)
void	addFromResource(ResourceDatabase database, int id)
void	addFromResource(ResourceDatabase database, int id, Listener listener)
void	addFromResource(ResourceDatabase database, int id, Listener listener, Window textEditBaseWindow)
MenuItem	addItem(MenuItem m)
MenuItem	addItem(MenuItem m, int mapID)
MenuItem	addItem(java.lang.String inTitle)
MenuItem	addItem(java.lang.String inTitle, int inEventType)
MenuItem	addItem(java.lang.String inTitle, int eventType, int eventData, java.lang.Object eventArg, Listener listener)
MenuItem	addItem(java.lang.String inTitle, int eventType, int eventData, java.lang.Object eventArg, Listener listener, int itemID)
MenuItem	addItemAtPosition(MenuItem m, int position)
void	addItemFromResource(ResourceDatabase database, int id, int menuItemID, int eventData, java.lang.Object eventArg, Listener listener)
void	addItemFromResource(ResourceDatabase database, int id, int menuItemID, Listener listener)
void	addItems(MenuItem[] items)
MenuItem	addTextEditItems(Window inBaseWindow)
void	checkItem(int inWhichItem)
void	checkItemWithID(int inID)
void	disableItem(int inWhichItem)
void	disableItemWithID(int inID)
void	enableItem(int inWhichItem)
void	enableItemWithID(int inID)
void	enterMenu()
void	enterMenu(boolean springLoaded)
void	exitMenu(boolean inKeepSelection)
boolean	getAutoHideIfIdle()
Bitmap	getCheckedIcon()
int	getExplicitIDOfItem(MenuItem item)
Bitmap	getHierIcon()
int	getIDOfItem(MenuItem item)
MenuItem	getItem(int inWhichItem)
MenuItem	getItemFromID(int inID)
MenuItem	getItemFromShortcut(char shortcut)
int	getItemIndex(java.lang.String title)
java.lang.String	getItemText(int inWhichItem)
java.lang.Object	getItemUserData(int inWhichItem)
Bitmap	getMarkedIcon()
Window	getOwnerWindow()
MenuItem	getSelectedItem()
int	getSelectedItemID()
boolean	getShowTitle()
boolean	hasVisibleSubmenu()
int	IndexOfItem(MenuItem item)
boolean	isDefaultSelectionFirstMenuItem()
boolean	isItemChecked(int inWhichItem)
boolean	isItemCheckedWithID(int inID)
boolean	isItemDisabled(int inWhichItem)
boolean	isItemDisabledWithID(int inID)
boolean	isItemMarked(int inWhichItem)
boolean	isItemMarkedWithID(int inID)
boolean	isSubmenu()
int	itemCount()
void	markItem(int inWhichItem)
void	markItemWithID(int inID)
boolean	matchAndDispatchShortcut(char shortcut)
boolean	ownerWindowIsActive()
abstract void	paint(Pen p) Draw the contents of this View.
boolean	receiveEvent(Event event) Entry point for event processing.
void	removeAllItems()
void	removeItem(int index)
void	removeItem(java.lang.String inTitle)
void	removeItemWithID(int id)
void	sendSelectionChangedEvent()
void	setAutoHideIfIdle(boolean flag)
void	setCheckedIcon(Bitmap inIcon)
void	setDefaultSelectionToFirstMenuItem(boolean flag)
void	setItemText(int inWhichItem, java.lang.String inText)
void	setItemTextWithID(int inID, java.lang.String inText)
void	setItemUserData(int inWhichItem, java.lang.Object args)
void	setListenerForAllItems(Listener listener)
void	setMarkedIcon(Bitmap inIcon)
void	setMaxItemID(int id)
void	setSelectionChangedListener(Listener listener, int event)
void	setShowTitle(boolean flag)
void	setSubmenu(boolean inSubmenu)
void	setTitle(java.lang.String inTitle)
void	sortMenuItems()
void	truncateEllipsizeMenuText(boolean flag)
void	uncheckAll()
void	uncheckItem(int inWhichItem)
void	uncheckItemWithID(int inID)
void	unmarkAll()
void	unmarkItem(int inWhichItem)
void	unmarkItemWithID(int inID)
MenuItem	updateTextEditItems(Window inBaseWindow)

Methods inherited from class danger.ui.Control

drawFocusBox, drawIdleBox, drawIdleBox, getEvent, getEventListener, getEventType, getHasBorder, getString, getTitle, getValue, sendEvent, setEvent, setEvent, setEvent, setEvent, setEvent, setEventListener, setHasBorder, setValue

Methods inherited from class danger.ui.Container

addChild, addChild, addChildAt, advanceFocus, childCount, childIsOnScreen, disable, enable, eventKeyDown, eventKeyHeld, eventKeyRepeat, eventKeyUp, eventPeriodicPulse, eventShortcut, eventWidgetDown, eventWidgetHeld, eventWidgetUp, getBottomChild, getChildAt, getChildIndex, getChildWithID, getDescendantWithID, getFirstChild, getFirstFocusableChild, getFocusedChild, getLastChild, getLastFocusableChild, hideAllChildren, loseFocus, moveChildToIndex, paintChildren, reflowChildren, removeAllChildren, removeChild, reverseFocus, setFocusedChild, setFocusedChild, setWindow, showAllChildren, snapToChildren, takeFocus

Methods inherited from class danger.ui.View

clear, copyStyle, getAcceptFocus, getBackgroundColor, getBottom, getBounds, getBounds, getFrame, getFrame, getHeight, getInterestingRect, getInterestingRect, getLeft, getOrigin, getOrigin, getOriginX, getOriginY, getParent, getRight, getSibling, getStyle, getStyleColor, getStyleFont, getTop, getWidth, getWindow, globalToLocal, hide, invalidate, invalidate, invalidate, isEnabled, isFocusable, isFocused, isOnScreen, isTransparent, isVisible, keepRectInView, localToGlobal, localToGlobal, localToWindow, moveBy, offsetOrigin, offsetOrigin, onAddedToParent, onDecoded, onPeriodicPulse, onRemovedFromParent, onStyleChanged, onWindowPaint, receiveEventInternal, resetOrigin, sendEventToWindow, setAcceptFocus, setBackgroundColor, setBottom, setDebugBounds, setEnabled, setFrame, setHeight, setKeyedValue, setLeft, setOrigin, setOrigin, setPosition, setRight, setSize, setStyle, setStyleColor, setStyleFont, setStyleFrameColor, setTop, setTransparent, setVisible, setWidth, shouldDropEvent, show, styleIsDefault, willFocusWithin, windowToLocal

Methods inherited from class danger.app.Listener

cancelEvents, sendEvent, sendEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mTruncateOKToEllipsize

protected boolean mTruncateOKToEllipsize

Constructor Detail

BaseMenu

public BaseMenu(java.lang.String inTitle)

BaseMenu

public BaseMenu(java.lang.String inTitle,
                boolean showTitle)

Method Detail

setTitle

public void setTitle(java.lang.String inTitle)

Overrides:

setTitle in class Control

setMaxItemID

public void setMaxItemID(int id)

paint

public abstract void paint(Pen p)

Description copied from class: View

Draw the contents of this View. This method is called by the graphics system when the View needs to be repainted. A Pen will be provided which is appropriately clipped and translated for drawing on this View.

Overrides:

paint in class Container

itemCount

public int itemCount()

addFromResource

public void addFromResource(ResourceDatabase database,
                            int id)

addFromResource

public void addFromResource(ResourceDatabase database,
                            int id,
                            Listener listener)

addFromResource

public void addFromResource(ResourceDatabase database,
                            int id,
                            Listener listener,
                            Window textEditBaseWindow)

addItemFromResource

public void addItemFromResource(ResourceDatabase database,
                                int id,
                                int menuItemID,
                                Listener listener)

addItemFromResource

public void addItemFromResource(ResourceDatabase database,
                                int id,
                                int menuItemID,
                                int eventData,
                                java.lang.Object eventArg,
                                Listener listener)

addDivider

public final void addDivider(int id)

addDivider

public final void addDivider()

addDividerAndReturnMappedID

public final int addDividerAndReturnMappedID()

addItem

public final MenuItem addItem(java.lang.String inTitle,
                              int eventType,
                              int eventData,
                              java.lang.Object eventArg,
                              Listener listener,
                              int itemID)

addItem

public final MenuItem addItem(java.lang.String inTitle,
                              int eventType,
                              int eventData,
                              java.lang.Object eventArg,
                              Listener listener)

addItem

public final MenuItem addItem(java.lang.String inTitle,
                              int inEventType)

addItem

public final MenuItem addItem(java.lang.String inTitle)

addItem

public MenuItem addItem(MenuItem m)

addItem

public MenuItem addItem(MenuItem m,
                        int mapID)

addItemAtPosition

public MenuItem addItemAtPosition(MenuItem m,
                                  int position)

addDividerAtPosition

public final void addDividerAtPosition(int position)

addItems

public void addItems(MenuItem[] items)

removeItem

public final void removeItem(int index)

removeItemWithID

public final void removeItemWithID(int id)

removeItem

public final void removeItem(java.lang.String inTitle)

removeAllItems

public final void removeAllItems()

getItemText

public final java.lang.String getItemText(int inWhichItem)

setItemText

public final void setItemText(int inWhichItem,
                              java.lang.String inText)

setItemTextWithID

public final void setItemTextWithID(int inID,
                                    java.lang.String inText)

getItemUserData

public final java.lang.Object getItemUserData(int inWhichItem)

setItemUserData

public final void setItemUserData(int inWhichItem,
                                  java.lang.Object args)

enterMenu

public void enterMenu(boolean springLoaded)

enterMenu

public void enterMenu()

exitMenu

public void exitMenu(boolean inKeepSelection)

getItemFromID

public final MenuItem getItemFromID(int inID)

getItem

public final MenuItem getItem(int inWhichItem)

getItemIndex

public int getItemIndex(java.lang.String title)

checkItem

public void checkItem(int inWhichItem)

checkItemWithID

public void checkItemWithID(int inID)

uncheckItem

public void uncheckItem(int inWhichItem)

uncheckItemWithID

public void uncheckItemWithID(int inID)

uncheckAll

public final void uncheckAll()

isItemChecked

public final boolean isItemChecked(int inWhichItem)

isItemCheckedWithID

public final boolean isItemCheckedWithID(int inID)

setCheckedIcon

public final void setCheckedIcon(Bitmap inIcon)

getCheckedIcon

public Bitmap getCheckedIcon()

markItem

public void markItem(int inWhichItem)

markItemWithID

public final void markItemWithID(int inID)

unmarkItem

public void unmarkItem(int inWhichItem)

unmarkItemWithID

public final void unmarkItemWithID(int inID)

unmarkAll

public final void unmarkAll()

isItemMarked

public final boolean isItemMarked(int inWhichItem)

isItemMarkedWithID

public final boolean isItemMarkedWithID(int inID)

setMarkedIcon

public final void setMarkedIcon(Bitmap inIcon)

getMarkedIcon

public Bitmap getMarkedIcon()

getHierIcon

public Bitmap getHierIcon()

enableItem

public final void enableItem(int inWhichItem)

enableItemWithID

public final void enableItemWithID(int inID)

disableItem

public final void disableItem(int inWhichItem)

disableItemWithID

public final void disableItemWithID(int inID)

isItemDisabled

public final boolean isItemDisabled(int inWhichItem)

isItemDisabledWithID

public final boolean isItemDisabledWithID(int inID)

setShowTitle

public void setShowTitle(boolean flag)

getShowTitle

public boolean getShowTitle()

setDefaultSelectionToFirstMenuItem

public void setDefaultSelectionToFirstMenuItem(boolean flag)

isDefaultSelectionFirstMenuItem

public boolean isDefaultSelectionFirstMenuItem()

setAutoHideIfIdle

public void setAutoHideIfIdle(boolean flag)

getAutoHideIfIdle

public boolean getAutoHideIfIdle()

isSubmenu

public boolean isSubmenu()

matchAndDispatchShortcut

public boolean matchAndDispatchShortcut(char shortcut)

setListenerForAllItems

public void setListenerForAllItems(Listener listener)

setSelectionChangedListener

public void setSelectionChangedListener(Listener listener,
                                        int event)

sendSelectionChangedEvent

public final void sendSelectionChangedEvent()

getOwnerWindow

public Window getOwnerWindow()

ownerWindowIsActive

public boolean ownerWindowIsActive()

receiveEvent

public boolean receiveEvent(Event event)

Description copied from class: Listener

Entry point for event processing. Default behaviour is to do nothing and return false. Normally this method is called from a Dispatcher when it discovers an Event in its queue that is targetted at this Listener.

Overrides:

receiveEvent in class Container

sortMenuItems

public final void sortMenuItems()

hasVisibleSubmenu

public final boolean hasVisibleSubmenu()

getSelectedItem

public final MenuItem getSelectedItem()

getSelectedItemID

public final int getSelectedItemID()

addTextEditItems

public final MenuItem addTextEditItems(Window inBaseWindow)

updateTextEditItems

public final MenuItem updateTextEditItems(Window inBaseWindow)

setSubmenu

public void setSubmenu(boolean inSubmenu)

getItemFromShortcut

public MenuItem getItemFromShortcut(char shortcut)

IndexOfItem

public int IndexOfItem(MenuItem item)

getIDOfItem

public int getIDOfItem(MenuItem item)

getExplicitIDOfItem

public int getExplicitIDOfItem(MenuItem item)

truncateEllipsizeMenuText

public final void truncateEllipsizeMenuText(boolean flag)