com.goldencode.p2j.ui

Class MenuWidget

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.ui.GenericWidget<T>

com.goldencode.p2j.ui.BaseEntity<T>

com.goldencode.p2j.ui.MenuContainerWidget<MenuConfig>

com.goldencode.p2j.ui.MenuWidget

All Implemented Interfaces:

Checkable, CommonWidget, ConfigOwner<MenuConfig>, CustomFont, DisableRedraw, ImageSupport, ImageWidgetSupport, MenuInterface, TitledElement, WidgetContainer, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, CommonHandleTree, Coordinates, DatabaseInfo, Deletable, DynamicResource, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, WrappedResource, Printable

public class MenuWidget
extends MenuContainerWidget<MenuConfig>
implements MenuInterface, TitledElement

This class represents menu widget.

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity

BaseEntity.CharsPixels

Field Summary

Fields

Modifier and Type	Field and Description
private GenericWidget<?>	owner OWNER property: window for menubar or other widget for popup menu
private int64	titleBgColor Private storage for TITLE-BGCOLOR: honored, but not acted upon by the client
private int64	titleDColor Private storage for TITLE-DCOLOR: honored, but not acted upon by the client
private int64	titleFgColor Private storage for TITLE-FGCOLOR: honored, but not acted upon by the client
private int64	titleFont Private storage for TITLE-FONT: honored, but not acted upon by the client

Fields inherited from class com.goldencode.p2j.ui.BaseEntity

group

Fields inherited from class com.goldencode.p2j.ui.GenericWidget

config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
MenuWidget(boolean dynamic) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	activate(int64 xPos, int64 yPos) Deprecated.
static <T extends MenuDefinition> T	createStaticMenu(java.lang.Class<T> defCls, java.lang.String name) Creates new menu as a proxy object (as a local resource).
static <T extends MenuDefinition> T	createStaticSharedMenu(java.lang.Class<T> defCls, java.lang.String name) Creates new shared menu.
(package private) void	detachMenu(MenuContainerWidget<?> comp) Detach the specified descendant from this menu.
(package private) void	detachMenu(MenuItemWidget comp) Detach the specified descendant from this menu.
MenuItemWidget	findMenuItem(java.lang.String name) Finds menu-item in this menu tree.
SubMenuWidget	findSubMenu(java.lang.String name) Finds sub-menu in this menu tree.
handle	firstChild() Accesses the first window in the list of contained windows, having this window as parent.
GenericWidget<?>	getOwner() Get owner widget.
handle	getOwnerHandle() Get handle of an owner widget.
integer	getTitleBgColor() Gets the TITLE-BGCOLOR writable attribute.
integer	getTitleDColor() Gets the TITLE-DCOLOR writable attribute.
integer	getTitleFgColor() Gets the TITLE-FGCOLOR writable attribute.
integer	getTitleFont() Get the TITLE-FONT attribute of this browse column widget.
static <T extends MenuDefinition> T	importStaticSharedMenu(java.lang.Class<T> iface, java.lang.String name) Import an existing menu
logical	isPopupOnly() POPUP-ONLY attribute (Graphical interfaces only)
handle	lastChild() Accesses the last window in the list of contained windows, having this window as parent.
void	setOwner(GenericWidget<?> owner) Set owner widget.
void	setPopupOnly(boolean popupOnly) Set POPUP-ONLY option.
void	setPopupOnly(logical popupOnly) Set POPUP-ONLY option.
void	setSensitive(boolean s) Sets new value of SENSITIVE attribute.
void	setTitleBgColor(int64 bgcolor) Sets the TITLE-BGCOLOR writable attribute.
void	setTitleBgColor(long bgcolor) Sets the TITLE-BGCOLOR writable attribute.
void	setTitleDColor(int64 dcolor) Sets the TITLE-DCOLOR writable attribute.
void	setTitleDColor(long dcolor) Sets the TITLE-DCOLOR writable attribute.
void	setTitleFgColor(int64 fgcolor) Sets the TITLE-FGCOLOR writable attribute.
void	setTitleFgColor(long fgcolor) Sets the TITLE-FGCOLOR writable attribute.
void	setTitleFont(int64 fontNum) Set the TITLE-FONT attribute of this browse widget.
void	setTitleFont(long fontNum) Set the TITLE-FONT attribute of this browse widget.

Methods inherited from class com.goldencode.p2j.ui.MenuContainerWidget

addWidget, batch, batch, canPushWidgetAttr, coreInitialize, delete, findMenuItemInt, findRootMenu, findSubMenuInt, finishConfigProcessing, getFirstChild, getId, getLastChild, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, isAttachedMenu, isBatch, isShared, listMenuTree, pushMenuDescription, pushScreenDefinition, removeWidget, resourceDelete, setShared, valid, widgets

Methods inherited from class com.goldencode.p2j.ui.BaseEntity

_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, changeFontWorker, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColor, getBgColorRgb, getColumn, getDColor, getFgColor, getFgColorRgb, getFont, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getParent, getParent, getPfColor, getRow, getSizeAttrs, getTitle, getTooltip, getValidParentTypes, getWidthChars, getWidthPixels, getX, getY, isFontBold, isFontItalic, isFontUnderline, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, resetAutoResize, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFont, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setGroup, setHeightChars, setHeightChars, setHeightCharsWorker, setHeightImpl, setHeightPixels, setHeightPixels, setHeightPixelsWorker, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setSystemParent, setTabStop, setTabStop, setTitle, setTitle, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthChars, setWidthChars, setWidthCharsWorker, setWidthImpl, setWidthPixels, setWidthPixels, setWidthPixelsWorker, setX, setX, setXorY, setXOrYWorker, setY, setY, useHandleChainSiblings, validateParent, validateSize, validColumnOrRow

Methods inherited from class com.goldencode.p2j.ui.GenericWidget

_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _name, _setDynamic, _setVisible, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, editUndo, enable, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDataType, getDbName, getFormat, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getPreviousTabItem, getQuery, getRetainShape, getScreenValue, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTabPosition, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoCompletion, isAutoResize, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMultiple, isNotEntered, isReadOnly, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, processSideLabel, pushWidgetAttr, pushWidgetAttr, readOnlyError, readOnlyError, realize, refresh, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAtFormatLength, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setAutoCompletion, setAutoCompletion, setAutoResize, setAutoResize, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setColumnLabel, setColumnLabel, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDataType, setDataType, setDbname, setDeblank, setDisableAutoZap, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setFromOCX, setHeader, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabel, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValue, setScreenValueInt, setScreenValueNoErrorHandling, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setThreeD, setThreeD, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setVisible, setVisible, setWidgetId, setWidgetId, setWidth, truncatePixelSize, type, underline, underline, validate, validateFields, validateFields, validateFields, validateFields, validateLabelAssignment, view, warningAlreadyRealized, widgetName

Methods inherited from class com.goldencode.p2j.util.HandleChain

firstResource, firstResource, getHead, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.ui.MenuInterface

activate

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget

getIdEx, getListItems, isEditCanUndo, setListItems, setListItems, setScreenValue

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain

getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable

name, name

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw

setDisableRedraw

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable

setReadOnly

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

owner

private GenericWidget<?> owner

OWNER property: window for menubar or other widget for popup menu

titleBgColor

private int64 titleBgColor

Private storage for TITLE-BGCOLOR: honored, but not acted upon by the client

titleDColor

private int64 titleDColor

Private storage for TITLE-DCOLOR: honored, but not acted upon by the client

titleFgColor

private int64 titleFgColor

Private storage for TITLE-FGCOLOR: honored, but not acted upon by the client

titleFont

private int64 titleFont

Private storage for TITLE-FONT: honored, but not acted upon by the client

Constructor Detail

MenuWidget

public MenuWidget(boolean dynamic)

Default constructor.

Parameters:

dynamic - Flag indicating if this is a static or dynamic resource.

Method Detail

isPopupOnly

public logical isPopupOnly()

POPUP-ONLY attribute (Graphical interfaces only)

Specified by:

isPopupOnly in interface MenuInterface

Returns:

The attribute value.

setPopupOnly

public void setPopupOnly(boolean popupOnly)

Set POPUP-ONLY option.

Specified by:

setPopupOnly in interface MenuInterface

Parameters:

popupOnly - true if this menu is popup-only, false otherwise.

setPopupOnly

public void setPopupOnly(logical popupOnly)

Set POPUP-ONLY option.

Specified by:

setPopupOnly in interface MenuInterface

Parameters:

popupOnly - true if this menu is popup-only, false otherwise.

getOwnerHandle

public handle getOwnerHandle()

Get handle of an owner widget.

Specified by:

getOwnerHandle in interface MenuInterface

Returns:

See above.

getOwner

public GenericWidget<?> getOwner()

Get owner widget.

Returns:

See above.

setOwner

public void setOwner(GenericWidget<?> owner)

Set owner widget.

Parameters:

owner - The widget that will be own this menu.

getTitleBgColor

public integer getTitleBgColor()

Gets the TITLE-BGCOLOR writable attribute.

Specified by:

getTitleBgColor in interface TitledElement

Returns:

The current value of the TITLE-BGCOLOR attribute.

setTitleBgColor

public void setTitleBgColor(int64 bgcolor)

Sets the TITLE-BGCOLOR writable attribute.

Specified by:

setTitleBgColor in interface TitledElement

Parameters:

bgcolor - The new value for the TITLE-BGCOLOR attribute.

setTitleBgColor

public void setTitleBgColor(long bgcolor)

Sets the TITLE-BGCOLOR writable attribute.

Specified by:

setTitleBgColor in interface TitledElement

Parameters:

bgcolor - The new value for the TITLE-BGCOLOR attribute.

getTitleDColor

public integer getTitleDColor()

Gets the TITLE-DCOLOR writable attribute.

Specified by:

getTitleDColor in interface TitledElement

Returns:

The current value of the TITLE-DCOLOR attribute.

setTitleDColor

public void setTitleDColor(int64 dcolor)

Sets the TITLE-DCOLOR writable attribute.

Specified by:

setTitleDColor in interface TitledElement

Parameters:

dcolor - The new value for the TITLE-DCOLOR attribute.

setTitleDColor

public void setTitleDColor(long dcolor)

Sets the TITLE-DCOLOR writable attribute.

Specified by:

setTitleDColor in interface TitledElement

Parameters:

dcolor - The new value for the TITLE-DCOLOR attribute.

getTitleFgColor

public integer getTitleFgColor()

Gets the TITLE-FGCOLOR writable attribute.

Specified by:

getTitleFgColor in interface TitledElement

Returns:

The current value of the TITLE-FGCOLOR attribute.

setTitleFgColor

public void setTitleFgColor(int64 fgcolor)

Sets the TITLE-FGCOLOR writable attribute.

Specified by:

setTitleFgColor in interface TitledElement

Parameters:

fgcolor - The new value for the TITLE-FGCOLOR attribute.

setTitleFgColor

public void setTitleFgColor(long fgcolor)

Sets the TITLE-FGCOLOR writable attribute.

Specified by:

setTitleFgColor in interface TitledElement

Parameters:

fgcolor - The new value for the TITLE-FGCOLOR attribute.

getTitleFont

public integer getTitleFont()

Get the TITLE-FONT attribute of this browse column widget.

Specified by:

getTitleFont in interface CommonWidget

Specified by:

getTitleFont in interface TitledElement

Overrides:

getTitleFont in class GenericWidget<MenuConfig>

Returns:

A value representing an entry in the user's font-table.

setTitleFont

public void setTitleFont(int64 fontNum)

Set the TITLE-FONT attribute of this browse widget.

Specified by:

setTitleFont in interface CommonWidget

Specified by:

setTitleFont in interface TitledElement

Overrides:

setTitleFont in class GenericWidget<MenuConfig>

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

setTitleFont

public void setTitleFont(long fontNum)

Set the TITLE-FONT attribute of this browse widget.

Specified by:

setTitleFont in interface CommonWidget

Specified by:

setTitleFont in interface TitledElement

Overrides:

setTitleFont in class GenericWidget<MenuConfig>

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

findMenuItem

public MenuItemWidget findMenuItem(java.lang.String name)

Finds menu-item in this menu tree. It can appear on different levels. Menu-item is searched using some sort of depth-first algorithm. See MenuContainerWidget.findMenuItemInt(String)

Parameters:

name - MENU-ITEM name.

Returns:

concrete MenuItemWidget or null if not found.

findSubMenu

public SubMenuWidget findSubMenu(java.lang.String name)

Finds sub-menu in this menu tree. It can appear only once. Simple depth-first search is used.

Parameters:

name - Sub-menu name.

Returns:

concrete SubMenuWidget or null if not found.

firstChild

public handle firstChild()

Accesses the first window in the list of contained windows, having this window as parent.

Specified by:

firstChild in interface CommonHandleTree

Returns:

The first widget or null if no widgets are contained.

lastChild

public handle lastChild()

Accesses the last window in the list of contained windows, having this window as parent.

Specified by:

lastChild in interface CommonHandleTree

Returns:

The last widget or null if no widgets are contained.

setSensitive

public void setSensitive(boolean s)

Sets new value of SENSITIVE attribute.

Specified by:

setSensitive in interface Sensitive

Overrides:

setSensitive in class MenuContainerWidget<MenuConfig>

Parameters:

s - new value of SENSITIVE attribute

activate

@Deprecated
public void activate(int64 xPos,
                                 int64 yPos)

Deprecated.

Activates POPUP menu.

Specified by:

activate in interface MenuInterface

Parameters:

xPos - The X position for top-left corner to displau menu.

yPos - The Y position for top-left corner to displau menu.

detachMenu

void detachMenu(MenuItemWidget comp)

Detach the specified descendant from this menu.

Parameters:

comp - The descendant to detach.

detachMenu

void detachMenu(MenuContainerWidget<?> comp)

Detach the specified descendant from this menu.

Parameters:

comp - The descendant to detach.

createStaticMenu

public static <T extends MenuDefinition> T createStaticMenu(java.lang.Class<T> defCls,
                                                            java.lang.String name)

Creates new menu as a proxy object (as a local resource). This loads the static menu definition.

Type Parameters:

T - Menu definition class type.

Parameters:

defCls - The class of menu definition.

name - The name of menu.

Returns:

The created menu widget.

createStaticSharedMenu

public static <T extends MenuDefinition> T createStaticSharedMenu(java.lang.Class<T> defCls,
                                                                  java.lang.String name)

Creates new shared menu.

Type Parameters:

T - Menu definition class type.

Parameters:

defCls - The class of menu definition.

name - The name of menu.

Returns:

The created menu definition.

importStaticSharedMenu

public static <T extends MenuDefinition> T importStaticSharedMenu(java.lang.Class<T> iface,
                                                                  java.lang.String name)

Import an existing menu

Type Parameters:

T - MenuDefinition interface type.

Parameters:

iface - The class of the interface definition.

name - The menu name.

Returns:

The menu frame.