com.goldencode.p2j.ui.client.gui

Class BrowsePopupMenu

java.lang.Object

com.goldencode.p2j.ui.client.widget.AbstractWidget<O>

com.goldencode.p2j.ui.client.widget.AbstractContainer<O>

com.goldencode.p2j.ui.client.Menu<GuiOutputManager>

com.goldencode.p2j.ui.client.gui.MenuGuiImpl

com.goldencode.p2j.ui.client.gui.BrowsePopupMenu

All Implemented Interfaces:

MouseWidgetsEnumerator, MenuStructure<GuiOutputManager>, Container<GuiOutputManager>, Widget<GuiOutputManager>, WidgetWithConfig<MenuConfig>, ConfigOwner<MenuConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

class BrowsePopupMenu
extends MenuGuiImpl

Popup menu for browse

Nested Class Summary

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

Menu.PopupKeyListener

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	log Logger.
private static int	MAX_FONT_SIZE Maximum size of the font allowed for selection.
private static int	MIN_FONT_SIZE Minimum size of the font allowed for selection.

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Modifier	Constructor and Description
private	BrowsePopupMenu(Browse browse) Constructs a popup menu.

Method Summary

Modifier and Type	Method and Description
static BrowsePopupMenu	create(BrowseGuiImpl browse, BrowseColumnGuiImpl column, boolean promptColumn) Create a popup menu for the given browse.
private static MenuItemGuiImpl	createExportMenuItem(Browse browse, MediaType outputFormat) Create menu item that calls export to the specified format.
private static SubMenuGuiImpl	createSelectColorSubmenu(java.lang.String submenuTitle, java.awt.event.MouseAdapter selectRgbColorAdapter, java.awt.event.MouseAdapter selectColorIndexAdapter, java.awt.event.MouseAdapter resetAdapter, boolean usePrompt) Create "Select RGB Color/Select Color From Color Table/Reset" submenu.
private static SubMenuGuiImpl	createSelectResetSubmenu(java.lang.String submenuTitle, java.awt.event.MouseAdapter selectAdapter, java.awt.event.MouseAdapter resetAdapter, boolean usePrompt) Create "Select/Reset" submenu.
private static MenuItemGuiImpl	createSeparatorsItem(BrowseGuiImpl browse, EnhancedBrowseParameter param) Create menu item for switching on/off rows/column/all separators.
private static void	eventDrawingBracket(Widget<?> widget, java.lang.Runnable code) Convenience wrapper for ThinClient.eventDrawingBracket(Widget, Runnable).
private static SubMenuGuiImpl	getBrowseColorChangeSubmenu(BrowseGuiImpl browse, EnhancedBrowseParameter param, java.lang.String submenuTitle) Create a "Select/Reset" submenu that calls color change dialog for the browse or resets the color.
private static SubMenuGuiImpl	getBrowseFontChangeSubmenu(BrowseGuiImpl browse, EnhancedBrowseParameter param, java.lang.String submenuTitle) Create a "Select/Reset" submenu that calls font change dialog for the browse or resets the color.
private static SubMenuGuiImpl	getColumnColorChangeSubmenu(BrowseGuiImpl browse, BrowseColumnGuiImpl targetColumn, EnhancedBrowseParameter param, java.lang.String submenuTitle) Create a "Select/Reset" submenu that calls color change dialog for the browse column or resets the color.
private static SubMenuGuiImpl	getColumnFontChangeSubmenu(BrowseGuiImpl browse, BrowseColumnGuiImpl targetColumn, EnhancedBrowseParameter param, java.lang.String submenuTitle) Create a "Select/Reset" submenu that calls font change dialog for the browse column or resets the color.
private static java.lang.String	getColumnLabel(BrowseColumnGuiImpl column) Get a formatted name to represent the column label.
private static SubMenuGuiImpl	getReportTitleChangeSubmenu(BrowseGuiImpl browse) Create a "Set/Reset" submenu that calls Report Title change dialog for the browse or resets the title.
private static java.awt.event.MouseAdapter	getResetTargetAdapter(BrowseGuiImpl browse, EnhancedBrowseSaveTarget resetTarget) Get mouse adapter which resets the enhanced browse configuration at the specified level of configurations.
private static java.awt.event.MouseAdapter	getSaveTargetAdapter(BrowseGuiImpl browse, EnhancedBrowseSaveTarget saveTarget) Get mouse adapter which saves the enhanced browse configuration into the specified save target.
private static java.lang.String	getSaveTargetDescription(EnhancedBrowseSaveTarget saveTarget) Get description of the specified save target.
private static BrowseColumnGuiImpl	resolveColumn(BrowseGuiImpl browse, BrowseColumnGuiImpl column, boolean visible) Query the user for a column if it is not known.

Methods inherited from class com.goldencode.p2j.ui.client.gui.MenuGuiImpl

clearItemsHighlight, doLayout, doShowPopup, draw, findMenuMouseSource, findMouseSource, getFirstEnabledWidget, getFirstFocusableItem, getLastFocusableItem, getMouseWidgets, height, hide, initialize, isLegacyFocus, isMnemonicsOn, leaveMenu, mouseActions, mouseClicked, processAccelerator, processKeyEvent, setMnemonicsOn, setVisible, width

Methods inherited from class com.goldencode.p2j.ui.client.Menu

afterConfigUpdate, config, currentFocus, destroy, enterMenu, focusWorker, getMenu, getTabItemList, hasFocus, hasMenuFocus, isMenubarElement, processKeyAccelerator, setMenuClosedHandler, showPopup, triggerMenuClosed

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, cycleFocus, defaultFocus, deregisterSelectedWidget, detach, dimension, dumpCurrentWidgets, dumpWidgets, endSizeChange, firstFocus, focus, focusTraversable, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, hasFocusable, insets, lastFocus, minimumSize, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, reflectAncestorChange, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, repaint, replace, requestFocus, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setSize, setTabItemList, setWidth, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

_setHidden, _setVisible, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestor, ancestorId, autoResize, bounds, clear, clearWidget, clipRectangle, clipRectangle, clipWith, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getDefaultEvent, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hidden, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized, window

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.MenuStructure

getParentMenu, getParentMenuContainer, getParentSubMenu, getParentSubMenuBody, getRootSubMenu

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, config, defaultMousePtr, destroy, dimension, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, highlighted, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, window

Methods inherited from interface java.awt.event.MouseListener

mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Container

widgetsAsList

Field Detail

log

private static CentralLogger log

Logger.

MIN_FONT_SIZE

private static final int MIN_FONT_SIZE

Minimum size of the font allowed for selection.

See Also:

Constant Field Values

MAX_FONT_SIZE

private static final int MAX_FONT_SIZE

Maximum size of the font allowed for selection.

See Also:

Constant Field Values

Constructor Detail

BrowsePopupMenu

private BrowsePopupMenu(Browse browse)

Constructs a popup menu.

Parameters:

browse - Parent browse.

Method Detail

create

public static BrowsePopupMenu create(BrowseGuiImpl browse,
                                     BrowseColumnGuiImpl column,
                                     boolean promptColumn)

Create a popup menu for the given browse.

Parameters:

browse - Parent browse.

column - Column which was right-clicked, or null if the right click was performed outside of the columns area.

promptColumn - true if this should prompt for a column in case the column is unknown; otherwise, the column-specific actions will be invisible

Returns:

popup menu for the given browse.

createExportMenuItem

private static MenuItemGuiImpl createExportMenuItem(Browse browse,
                                                    MediaType outputFormat)

Create menu item that calls export to the specified format.

Parameters:

browse - Parent browse.

outputFormat - Report output format.

Returns:

menu item that calls export to the specified format.

getColumnColorChangeSubmenu

private static SubMenuGuiImpl getColumnColorChangeSubmenu(BrowseGuiImpl browse,
                                                          BrowseColumnGuiImpl targetColumn,
                                                          EnhancedBrowseParameter param,
                                                          java.lang.String submenuTitle)

Create a "Select/Reset" submenu that calls color change dialog for the browse column or resets the color.

Parameters:

browse - The browse which contains the column.

targetColumn - Target browse column.

param - Parameter which specifies which type of color should be changed: can be EnhancedBrowseParameter.FG_COLOR, EnhancedBrowseParameter.BG_COLOR, EnhancedBrowseParameter.LABEL_FG_COLOR, EnhancedBrowseParameter.LABEL_BG_COLOR or EnhancedBrowseParameter.ALTERNATING_BG_COLOR.

submenuTitle - Submenu title.

Returns:

"Select/Reset" submenu that calls color change dialog for the browse column or resets the color.

getBrowseColorChangeSubmenu

private static SubMenuGuiImpl getBrowseColorChangeSubmenu(BrowseGuiImpl browse,
                                                          EnhancedBrowseParameter param,
                                                          java.lang.String submenuTitle)

Create a "Select/Reset" submenu that calls color change dialog for the browse or resets the color.

Parameters:

browse - Target browse.

param - Parameter which specifies which type of color should be changed: can be EnhancedBrowseParameter.FG_COLOR, EnhancedBrowseParameter.BG_COLOR, EnhancedBrowseParameter.LABEL_FG_COLOR, EnhancedBrowseParameter.LABEL_BG_COLOR, EnhancedBrowseParameter.SEPARATORS_COLOR or EnhancedBrowseParameter.ALTERNATING_BG_COLOR.

submenuTitle - Submenu title.

Returns:

"Select/Reset" submenu that calls color change dialog for the browse or resets the color.

getColumnFontChangeSubmenu

private static SubMenuGuiImpl getColumnFontChangeSubmenu(BrowseGuiImpl browse,
                                                         BrowseColumnGuiImpl targetColumn,
                                                         EnhancedBrowseParameter param,
                                                         java.lang.String submenuTitle)

Create a "Select/Reset" submenu that calls font change dialog for the browse column or resets the color.

Parameters:

browse - The browse which contains the column.

targetColumn - Target browse column.

param - Parameter which specifies which type of font should be changed: can be EnhancedBrowseParameter.CELLS_FONT or EnhancedBrowseParameter.LABEL_FONT.

submenuTitle - Submenu title.

Returns:

"Select/Reset" submenu that calls font change dialog for the browse column or resets the color.

getBrowseFontChangeSubmenu

private static SubMenuGuiImpl getBrowseFontChangeSubmenu(BrowseGuiImpl browse,
                                                         EnhancedBrowseParameter param,
                                                         java.lang.String submenuTitle)

Create a "Select/Reset" submenu that calls font change dialog for the browse or resets the color.

Parameters:

browse - Target browse.

param - Parameter which specifies which type of font should be changed: can be EnhancedBrowseParameter.CELLS_FONT or EnhancedBrowseParameter.LABEL_FONT.

submenuTitle - Submenu title.

Returns:

"Select/Reset" submenu that calls font change dialog for the browse or resets the color.

getReportTitleChangeSubmenu

private static SubMenuGuiImpl getReportTitleChangeSubmenu(BrowseGuiImpl browse)

Create a "Set/Reset" submenu that calls Report Title change dialog for the browse or resets the title.

Parameters:

browse - Target browse.

Returns:

"Set/Reset" submenu that calls Report Title change dialog for the browse or resets the title.

createSeparatorsItem

private static MenuItemGuiImpl createSeparatorsItem(BrowseGuiImpl browse,
                                                    EnhancedBrowseParameter param)

Create menu item for switching on/off rows/column/all separators.

Parameters:

browse - Parent browse.

param - Parameter which specifies which type of separators should be changed: can be EnhancedBrowseParameter.SEPARATORS or EnhancedBrowseParameter.ROW_SEPARATORS or EnhancedBrowseParameter.COLUMN_SEPARATORS.

Returns:

menu item for switching specific type of separators.

getSaveTargetAdapter

private static java.awt.event.MouseAdapter getSaveTargetAdapter(BrowseGuiImpl browse,
                                                                EnhancedBrowseSaveTarget saveTarget)

Get mouse adapter which saves the enhanced browse configuration into the specified save target.

Parameters:

browse - Target browse.

saveTarget - Save target (if configuration is applied to "all browses" / "specific browse" and "all users" / "current user").

Returns:

mouse adapter which saves the enhanced browse configuration using the specified save target.

getResetTargetAdapter

private static java.awt.event.MouseAdapter getResetTargetAdapter(BrowseGuiImpl browse,
                                                                 EnhancedBrowseSaveTarget resetTarget)

Get mouse adapter which resets the enhanced browse configuration at the specified level of configurations.

Parameters:

browse - Target browse.

resetTarget - Reset target (if configuration is reset for "all browses" / "specific browse" and "all users" / "current user").

Returns:

mouse adapter which resets the enhanced browse configuration at the specified level of configurations.

getSaveTargetDescription

private static java.lang.String getSaveTargetDescription(EnhancedBrowseSaveTarget saveTarget)

Get description of the specified save target.

Parameters:

saveTarget - Save target (target server, target account, applied to all browses or not).

Returns:

description of the specified save target.

eventDrawingBracket

private static void eventDrawingBracket(Widget<?> widget,
                                        java.lang.Runnable code)

Convenience wrapper for ThinClient.eventDrawingBracket(Widget, Runnable).

Parameters:

widget - The widget which triggered this drawing. If is null, the window as returned by WindowManager.findWindow(int) will be used; otherwise, the widget's window will be used.

code - Logic to safely execute inside the event bracket.

createSelectResetSubmenu

private static SubMenuGuiImpl createSelectResetSubmenu(java.lang.String submenuTitle,
                                                       java.awt.event.MouseAdapter selectAdapter,
                                                       java.awt.event.MouseAdapter resetAdapter,
                                                       boolean usePrompt)

Create "Select/Reset" submenu.

Parameters:

submenuTitle - Submenu title.

selectAdapter - Mouse adapter for "select" action.

resetAdapter - Mouse adapter for "reset" action.

usePrompt - Flag to indicate that after pressing one option a prompt will be displayed.

Returns:

created "Select/Reset" submenu.

createSelectColorSubmenu

private static SubMenuGuiImpl createSelectColorSubmenu(java.lang.String submenuTitle,
                                                       java.awt.event.MouseAdapter selectRgbColorAdapter,
                                                       java.awt.event.MouseAdapter selectColorIndexAdapter,
                                                       java.awt.event.MouseAdapter resetAdapter,
                                                       boolean usePrompt)

Create "Select RGB Color/Select Color From Color Table/Reset" submenu.

Parameters:

submenuTitle - Submenu title.

selectRgbColorAdapter - Mouse adapter for "Select RGB Color" action.

selectColorIndexAdapter - Mouse adapter for "Select Color From Color Table" action.

resetAdapter - Mouse adapter for "reset" action.

usePrompt - Flag to indicate that after pressing one option a prompt will be displayed.

Returns:

created submenu.

resolveColumn

private static BrowseColumnGuiImpl resolveColumn(BrowseGuiImpl browse,
                                                 BrowseColumnGuiImpl column,
                                                 boolean visible)

Query the user for a column if it is not known. This is used when triggering column-specific actions, but the column is not known. This method will display a dialog with a combo-box containing all visible columns. The selection will be returned.

Parameters:

browse - The browse for which the column-specific action is done.

column - The column for which the action was triggered. If null, a prompt is displayed.

visible - Flag to indicate if a visible column should be resolved or an invisible one.

Returns:

The given column or a user-selected column if the provided one was null.

getColumnLabel

private static java.lang.String getColumnLabel(BrowseColumnGuiImpl column)

Get a formatted name to represent the column label.

Parameters:

column - The column for which the name should be retrieved.

Returns:

A formatted string meant to identify the column based on its label.