com.goldencode.p2j.ui

Class MenuItemWidget

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

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

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

com.goldencode.p2j.ui.MenuItemWidget

All Implemented Interfaces:

Checkable, CommonWidget, ConfigOwner<MenuItemConfig>, CustomFont, DisableRedraw, ImageSupport, ImageWidgetSupport, MenuItemInterface, MnemonicInterface, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, Coordinates, DatabaseInfo, Deletable, DynamicResource, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, SubTypeAttribute, WrappedResource, Printable

public class MenuItemWidget
extends BaseEntity<MenuItemConfig>
implements SubTypeAttribute, MenuItemInterface, WriteProtectable, Checkable

This class represents menu-item widget.

Nested Class Summary

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

BaseEntity.CharsPixels

Field Summary

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
MenuItemWidget(boolean dynamic) Default constructor for dynamic menu-items
MenuItemWidget(java.lang.String subtype) Constructor for static menu-item of non standard sub-type: RULE or SKIP.
MenuItemWidget(java.lang.String name, java.lang.String label) Default constructor for static menu-item

Method Summary

Modifier and Type	Method and Description
protected boolean	canPushWidgetAttr() Returns true if the configuration can be pushed to the client-side.
void	delete() Perform actual delete of an resource.
static MenuItemWidget	findMenuItemStatic(java.lang.String name) Finds the first MENU-ITEM with specified name in all menus.
character	getAccelerator() Get this menu-item accelerator - KEYLABEL of the short key assigned to this menu-item.
int	getId() Gets the numeric ID of this widget (this is used as an index into the screen-buffer among other things).
character	getLabel() Get this menu-item's label.
integer	getMnemonic() Gets the mnemonic for this menu-item or sub-menu.
handle	getNextSibling() Get the next-sibling attribute for this widget.
character	getPreprocessedLabel() Gets the preprocessed label text, as it appears in the UI.
handle	getPrevSibling() Get the prev-sibling attribute for this widget.
character	getSubType() Returns the sub-type of this menu-item.
protected java.lang.String[]	getValidParentTypes() Returns the widget types that can act as parent for this widget.
logical	isChecked() Gets the CHECKED writable attribute.
logical	isReadOnly() Checks whether the widget is write-protected.
logical	isToggleBox() Gets the TOGGLE-BOX attribute value.
protected void	pushScreenDefinition() Conditionally call GenericFrame.pushScreenDefinition(), depending if the frame was set or not for this widget.
protected boolean	resourceDelete() Delete the resource.
void	setAccelerator(character accel) Sets this menu-item accelerator.
void	setAccelerator(java.lang.String accelerator) Set this menu-item accelerator - KEYLABEL of the short key assigned to this menu-item.
void	setChecked(boolean checked) Set CHECKED attribute value.
void	setChecked(logical checked) Set CHECKED attribute value.
void	setInitDisabled(boolean disabled) Sets disabled flag during construction in menu definition class.
void	setLabel(java.lang.String label) Sets the label text, parsing mnemonic.
void	setReadOnly(boolean r) Sets the READ-ONLY attribute of the widget.
void	setReadOnly(logical r) Sets the READ-ONLY attribute of the widget.
void	setSensitive(boolean s) Sets new value of SENSITIVE attribute.
void	setSubType(character value) Sets the the sub-type of the object.
void	setSubType(java.lang.String value) Sets the the sub-type of the object.
private void	setSubTypeInt(java.lang.String value) Sets the the sub-type of the object.
void	setToggleBox(boolean toggleBox) Sets the TOGGLE-BOX attribute of the menu-item.
void	setToggleBox(logical toggleBox) Sets the TOGGLE-BOX attribute of the menu-item.
boolean	valid() Reports if this widget object is valid for use.

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, 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, finishConfigProcessing, 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, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getPreviousTabItem, getQuery, getRetainShape, getScreenValue, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoCompletion, isAutoResize, isAutoReturn, isChained, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMultiple, isNotEntered, 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, 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, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValue, setScreenValueInt, setScreenValueNoErrorHandling, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setThreeD, setThreeD, setTitleFont, setTitleFont, 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, getNextSibling, getPrevSibling, 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.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.util.Printable

asString, print

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

allowDelete

Constructor Detail

MenuItemWidget

public MenuItemWidget(boolean dynamic)

Default constructor for dynamic menu-items

Parameters:

dynamic - The dynamic flag.

MenuItemWidget

public MenuItemWidget(java.lang.String name,
                      java.lang.String label)

Default constructor for static menu-item

Parameters:

name - The name of menu-item.

label - MENU-ITEM label.

MenuItemWidget

public MenuItemWidget(java.lang.String subtype)

Constructor for static menu-item of non standard sub-type: RULE or SKIP.

Parameters:

subtype - MENU-ITEM sub-type. One of 3 constants: MenuItemConfig.SBTP_NORMAL, MenuItemConfig.SBTP_RULE or MenuItemConfig.SBTP_SKIP

Method Detail

getMnemonic

public integer getMnemonic()

Gets the mnemonic for this menu-item or sub-menu. This is a FWD extension, not a real 4GL attribute.

Specified by:

getMnemonic in interface MnemonicInterface

Returns:

See above.

getPreprocessedLabel

public character getPreprocessedLabel()

Gets the preprocessed label text, as it appears in the UI. This is a FWD extension, not a real 4GL attribute.

Specified by:

getPreprocessedLabel in interface MnemonicInterface

Returns:

See above.

getNextSibling

public handle getNextSibling()

Get the next-sibling attribute for this widget.

Specified by:

getNextSibling in interface CommonHandleChain

Overrides:

getNextSibling in class BaseEntity<MenuItemConfig>

Returns:

See above.

getPrevSibling

public handle getPrevSibling()

Get the prev-sibling attribute for this widget.

Specified by:

getPrevSibling in interface CommonHandleChain

Overrides:

getPrevSibling in class BaseEntity<MenuItemConfig>

Returns:

See above.

setLabel

public void setLabel(java.lang.String label)

Sets the label text, parsing mnemonic. TODO: find out what is going on with undocumented feature of very long label See parent's javadoc.

Specified by:

setLabel in interface CommonField

Overrides:

setLabel in class GenericWidget<MenuItemConfig>

Parameters:

label - The new label text.

getLabel

public character getLabel()

Get this menu-item's label.

Specified by:

getLabel in interface CommonField

Overrides:

getLabel in class GenericWidget<MenuItemConfig>

Returns:

See above.

isReadOnly

public logical isReadOnly()

Checks whether the widget is write-protected.

Specified by:

isReadOnly in interface WriteProtectable

Overrides:

isReadOnly in class GenericWidget<MenuItemConfig>

Returns:

true if the widget is write-protected.

setReadOnly

public void setReadOnly(logical r)

Sets the READ-ONLY attribute of the widget.

Specified by:

setReadOnly in interface WriteProtectable

Overrides:

setReadOnly in class GenericWidget<MenuItemConfig>

Parameters:

r - true if the widget should be write-protected.

setReadOnly

public void setReadOnly(boolean r)

Sets the READ-ONLY attribute of the widget.

Specified by:

setReadOnly in interface WriteProtectable

Parameters:

r - true if the widget should be write-protected.

setInitDisabled

public void setInitDisabled(boolean disabled)

Sets disabled flag during construction in menu definition class. Intended only on for construction step and must no be called elsewhere.

Parameters:

disabled - true means menu-item is disabled.

Throws:

java.lang.IllegalStateException - thrown if this method is called somewhere else except menu definition class.

isToggleBox

public logical isToggleBox()

Gets the TOGGLE-BOX attribute value.

Specified by:

isToggleBox in interface MenuItemInterface

Returns:

TOGGLE-BOX attribute value: true if the menu-item should have a checkbox.

setToggleBox

public void setToggleBox(boolean toggleBox)

Sets the TOGGLE-BOX attribute of the menu-item.

Specified by:

setToggleBox in interface MenuItemInterface

Parameters:

toggleBox - true if the menu-item should have a checkbox.

setToggleBox

public void setToggleBox(logical toggleBox)

Sets the TOGGLE-BOX attribute of the menu-item.

Specified by:

setToggleBox in interface MenuItemInterface

Parameters:

toggleBox - true if the menu-item should have a checkbox.

getAccelerator

public character getAccelerator()

Get this menu-item accelerator - KEYLABEL of the short key assigned to this menu-item.

Specified by:

getAccelerator in interface MenuItemInterface

Returns:

See above.

setAccelerator

public void setAccelerator(java.lang.String accelerator)

Set this menu-item accelerator - KEYLABEL of the short key assigned to this menu-item.

Specified by:

setAccelerator in interface MenuItemInterface

Parameters:

accelerator - The valid key-label, that will be target accelerator.

setAccelerator

public void setAccelerator(character accel)

Sets this menu-item accelerator.

Specified by:

setAccelerator in interface MenuItemInterface

Parameters:

accel - The valid key-label, that will be target accelerator.

getSubType

public character getSubType()

Returns the sub-type of this menu-item.

Specified by:

getSubType in interface SubTypeAttribute

Returns:

See above.

setSubType

public void setSubType(character value)

Sets the the sub-type of the object.

Specified by:

setSubType in interface SubTypeAttribute

Parameters:

value - The new value of the sub-type object attribute.

setSubType

public void setSubType(java.lang.String value)

Sets the the sub-type of the object.

Specified by:

setSubType in interface SubTypeAttribute

Parameters:

value - The new value of the sub-type object attribute.

setSensitive

public void setSensitive(boolean s)

Sets new value of SENSITIVE attribute. Overrides GenericWidget logic (that enables widget in its frame).

Specified by:

setSensitive in interface Sensitive

Overrides:

setSensitive in class GenericWidget<MenuItemConfig>

Parameters:

s - The new value of the SENSITIVE attribute.

getId

public int getId()

Gets the numeric ID of this widget (this is used as an index into the screen-buffer among other things).

Specified by:

getId in interface CommonWidget

Overrides:

getId in class GenericWidget<MenuItemConfig>

Returns:

The numeric ID of this widget.

isChecked

public logical isChecked()

Gets the CHECKED writable attribute.

Specified by:

isChecked in interface Checkable

Overrides:

isChecked in class GenericWidget<MenuItemConfig>

Returns:

The current value of the CHECKED attribute.

setChecked

public void setChecked(boolean checked)

Set CHECKED attribute value.

Specified by:

setChecked in interface Checkable

Overrides:

setChecked in class GenericWidget<MenuItemConfig>

Parameters:

checked - New value for the attribute.

setChecked

public void setChecked(logical checked)

Set CHECKED attribute value.

Specified by:

setChecked in interface Checkable

Overrides:

setChecked in class GenericWidget<MenuItemConfig>

Parameters:

checked - New value for the attribute.

findMenuItemStatic

public static MenuItemWidget findMenuItemStatic(java.lang.String name)

Finds the first MENU-ITEM with specified name in all menus.

Parameters:

name - The name of searched MENU-ITEM

Returns:

The first found MenuItemWidget or null.

pushScreenDefinition

protected void pushScreenDefinition()

Conditionally call GenericFrame.pushScreenDefinition(), depending if the frame was set or not for this widget.

Overrides:

pushScreenDefinition in class GenericWidget<MenuItemConfig>

getValidParentTypes

protected java.lang.String[] getValidParentTypes()

Returns the widget types that can act as parent for this widget.

Overrides:

getValidParentTypes in class BaseEntity<MenuItemConfig>

Returns:

see above.

resourceDelete

protected boolean resourceDelete()

Delete the resource.

Overrides:

resourceDelete in class GenericWidget<MenuItemConfig>

Returns:

true if the resource was deleted.

delete

public void delete()

Perform actual delete of an resource. At the time of this call, it is assumed the resource is valid for deletion (the handle and the resource are both valid).

The method first calls resourceDelete(), if the method returns false, the deletion is aborted.

Specified by:

delete in interface Deletable

Overrides:

delete in class GenericWidget<MenuItemConfig>

valid

public boolean valid()

Reports if this widget object is valid for use.

The validity of the widget object is determined solely by the scope of the containing frame.

Specified by:

valid in interface CommonWidget

Specified by:

valid in interface WrappedResource

Overrides:

valid in class GenericWidget<MenuItemConfig>

Returns:

true if we are valid (can be used).

canPushWidgetAttr

protected boolean canPushWidgetAttr()

Returns true if the configuration can be pushed to the client-side.

Overrides:

canPushWidgetAttr in class GenericWidget<MenuItemConfig>

Returns:

True if the configuration can be pushed to the client-side.

setSubTypeInt

private void setSubTypeInt(java.lang.String value)

Sets the the sub-type of the object.

Parameters:

value - The new value of the sub-type object attribute.