com.goldencode.p2j.ui

Interface ButtonList

All Superinterfaces:

CommonField, CommonHandle, CommonHandleChain, CommonWidget, Coordinates, CustomFont, DatabaseInfo, DisableRedraw, HasVisible, ImageSupport, ImageWidgetSupport, Nameable, Sizeable, WrappedResource, WriteProtectable

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

ButtonListWidget

public interface ButtonList
extends WrappedResource, CommonWidget, CustomFont

Interface for the server side ButtonList widget implementation.

Method Summary

Modifier and Type	Method and Description
handle	addGroup(NumberType bgIndex, character bgKey, character bgDesc) Add a new ButtonListGroup.
logical	clearButtonList() Remove all ButtonListGroupItem and ButtonListGroup from the ButtonList.
integer	getButtonFont() Get the font table index used for ButtonList.
handle	getCurrentGroup() Get the currently opened ButtonListGroup.
character	getCurrentGroupKey() Gets the current group key.
integer	getItemFont() Get the font table index used for ButtonList.
void	setBgColorRgb(NumberType bgcolorRgb) Sets the BGCOLOR-RGB writable attribute.
void	setButtonFont(int64 fontIndex) Set the font table index used for ButtonList.
handle	setCurrentGroup(handle groupHandle) Sets and opens the specified ButtonListGroup, and returns it.
void	setCurrentGroupKey(character groupKey) Sets the current group by its key and returns it.
void	setFgColorRgb(NumberType fgcolorRgb) Sets the FGCOLOR-RGB writable attribute.
void	setItemFont(integer fontIndex) Set the font table index used for ButtonList.

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

apply, apply, apply, apply, asWidgetHandle, colorDisplay, colorPrompt, deselectRows, disable, editUndo, enable, getBgColor, getBgColorRgb, getColumnFont, getContextHelpId, getCursorOffset, getDColor, getFgColor, getFgColorRgb, getFont, getFrame, getFrameColumn, getFrameHandle, getFrameName, getFrameRow, getFrameX, getFrameY, getHWND, getId, getIdEx, getImage, getLabelFont, getLabelStr, getListItems, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParent, getParentHandle, getPfColor, getPopupMenu, getPreviousTabItem, getQuery, getScreenValue, getSideLabelHandle, getTabPosition, getTitle, getTitleFont, getTooltip, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, hide, hide, inputValue, isAutoCompletion, isAutoResize, isEditCanUndo, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMovable, isMultiple, isNotEntered, isResizable, isScrollable, isSelectable, isSelected, isSelected, isSelected, isTabStop, isThreeD, isValidatable, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, openPopup, preRealizeCheck, realize, refresh, selectAll, selectFocusedRow, setAtFormatLength, setAutoCompletion, setAutoCompletion, setAutoResize, setAutoResize, setBgColor, setBlank, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setCursorOffset, setCursorOffset, setDColor, setDColor, setDeblank, setDisableAutoZap, setFgColor, setFont, setFont, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setGroup, setHeader, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabelFont, setLabelFont, setListItems, setListItems, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMovable, setMovable, setMultiple, setMultiple, setNextTabItem, setNumSelectedRows, setParent, setParentHandle, setParentHandle, setPfColor, setPfColor, setPopupMenu, setPopupMenu, setQuery, setResizable, setResizable, setScreenValue, setScreenValue, setScrollable, setScrollable, setSelectable, setSelectable, setSelected, setSelected, setSensitive, setSideLabelHandle, setTabStop, setTabStop, setThreeD, setThreeD, setTitle, setTitle, setTitleFont, setTitleFont, setTooltip, setTooltip, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setWidgetId, setWidgetId, underline, underline, valid, validateFields, validateFields, validateFields, view

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

getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData

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

readOnlyError, readOnlyError, resourceType

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

id, id, unknown

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

name, name, name

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

getColumnLabel, getDataType, getFormat, getHelp, getLabel, setColumnLabel, setColumnLabel, setDataType, setDataType, setFormat, setHelp, setHelp, setLabel, setLabel, setLabel

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

getDbName, getTable

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

isDisableRedraw, setDisableRedraw, setDisableRedraw

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

isVisible, setVisible, setVisible

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

getHeight, getHeightChars, getHeightPixels, getWidth, getWidthChars, getWidthPixels, setHeight, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidth, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels

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

getColumn, getRow, getX, getY, setColumn, setColumn, setRow, setRow, setX, setX, setY, setY

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

getRetainShape, getStretchToFit, getTransparent, setRetainShape, setRetainShape, setStretchToFit, setStretchToFit, setTransparent, setTransparent

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

getConvert3D, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, setConvert3D, setConvert3D

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

isReadOnly, setReadOnly, setReadOnly

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

getFontInfo, getFontName, getFontSize, isFontBold, isFontItalic, isFontUnderline, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline

Method Detail

getCurrentGroup

handle getCurrentGroup()

Get the currently opened ButtonListGroup.

Returns:

The handle wrapped resource of type ButtonListGroup or unknown.

setCurrentGroup

handle setCurrentGroup(handle groupHandle)

Sets and opens the specified ButtonListGroup, and returns it.

Parameters:

groupHandle - Handle of the ButtonListGroup to open.

Returns:

The handle wrapped resource of the newly opened ButtonListGroup or unknown.

setCurrentGroupKey

void setCurrentGroupKey(character groupKey)

Sets the current group by its key and returns it.

Parameters:

groupKey - The key of the button list group to be set the current group.

getCurrentGroupKey

character getCurrentGroupKey()

Gets the current group key.

Returns:

The handle wrapped resource of the current ButtonListGroup or unknown.

clearButtonList

logical clearButtonList()

Remove all ButtonListGroupItem and ButtonListGroup from the ButtonList.

Returns:

Success (true) or failure (false).

addGroup

handle addGroup(NumberType bgIndex,
                character bgKey,
                character bgDesc)

Add a new ButtonListGroup.

Parameters:

bgIndex - Indexed location to place new ButtonListGroup (indexed from 1)

bgKey - The ButtonListGroup key.

bgDesc - The ButtonListGroup text.

Returns:

The handle wrapped resource of the newly added ButtonListGroupWidget.

setBgColorRgb

void setBgColorRgb(NumberType bgcolorRgb)

Sets the BGCOLOR-RGB writable attribute. This is a FWD extension attribute.

Specified by:

setBgColorRgb in interface CommonWidget

Parameters:

bgcolorRgb - The new value for the BGCOLOR-RGB attribute.

setFgColorRgb

void setFgColorRgb(NumberType fgcolorRgb)

Sets the FGCOLOR-RGB writable attribute. This is a FWD extension attribute.

Specified by:

setFgColorRgb in interface CommonWidget

Parameters:

fgcolorRgb - The new value for the FGCOLOR-RGB attribute.

getButtonFont

integer getButtonFont()

Get the font table index used for ButtonList.

Returns:

fontIndex The index into the font table.

setButtonFont

void setButtonFont(int64 fontIndex)

Set the font table index used for ButtonList. This will be applied to the Button text.

Parameters:

fontIndex - The index into the font table.

getItemFont

integer getItemFont()

Get the font table index used for ButtonList.

Returns:

fontIndex The index into the font table.

setItemFont

void setItemFont(integer fontIndex)

Set the font table index used for ButtonList. This will be applied to the itemtext.

Parameters:

fontIndex - The index into the font table.