BrowseColumnGuiImpl (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.ui.client.widget.AbstractWidget<O>
- - com.goldencode.p2j.ui.client.widget.AbstractContainer<O>
  - - com.goldencode.p2j.ui.client.BrowseColumn
    - - com.goldencode.p2j.ui.client.gui.BrowseColumnGuiImpl

All Implemented Interfaces:

DataContainer, FocusListener, Container, Widget, WidgetWithConfig, ConfigOwner, Hoverable, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener
```
public class BrowseColumnGuiImpl
extends BrowseColumn
implements Hoverable
```
GUI implementation of browse column.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BrowseColumnGuiImpl.ResizeArea
Enumeration for different resize areas.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BrowseColumnGuiImpl.ResizeArea` Enumeration for different resize areas.

Field Summary

Fields
Modifier and Type	Field and Description
`private BrowseGuiImpl`	`browse` Parent browse.
`private CoordinatesConversion`	`cc` Coordinates conversion.
`private FontDetails`	`cellsFont` Column font.
`private java.lang.String`	`columnFilterDataType` For enhanced filtering: data type used in column filter.
`private java.util.Map<java.lang.String,java.lang.String>`	`comboItemsCache` For combo-box columns: cache of "item value" -> "item description" elements, used in column rendering.
`private BrowseColumnGuiImpl.ResizeArea`	`currentResizeArea` Indicates the resize area over which the mouse pointer is hovering now.
`(package private) static int`	`FILTER_ENTRY_PADDING_BOTTOM` Bottom padding for column filter entry fields.
`private static int`	`FILTER_ENTRY_PADDING_SIDE` Side padding for column filter entry fields.
`private BrowseFilterEntryField`	`filterEntry` The column filter entry field for this column.
`static int`	`GAP_BETWEEN_SORT_ARROW_AND_NUMBER` Gap between sort arrow and sort number.
`private GuiDriver`	`gd` GUI driver.
`private java.lang.Boolean`	`implicitWidth` `true` if the column has implicit width.
`private int`	`initialDragRow` Initial row selected during mouse drag.
`private boolean`	`isDragged` `true` if the column is being dragged.
`private boolean`	`isPressed` If column is pressed (column label is pressed if ALLOW-COLUMN-SEARCHING is `true`).
`private boolean`	`isResized` `true` if the column is being resized.
`private boolean`	`isRowFocusing` Flag to indicate if a row was pressed and is currently dragged.
`static int`	`LABEL_PRESSED_OFFSET` Offset of the label text if the column is in pressed state.
`static int`	`LABEL_SHADOW_THICKNESS` Thickness of the shadow inside the column header.
`private FontDetails`	`labelFont` Label font.
`private java.lang.String[]`	`labelLines` The lines of which the label consist.
`private boolean`	`labelPressed` If column label is pressed this becoming true when owning window has 3-d falg on.
`private int`	`lastDragRow` Last row selected during mouse drag.
`private NativePoint`	`lastMousePosition` Last mouse position reported during mouse drag.
`private static CentralLogger`	`LOG` Logger.
`private boolean`	`markersColumn` If it is the markers (leftmost) column.
`private static int`	`PADDING` Difference between data width and actual column width (in pixels).
`(package private) static int`	`RESET_TO_UNK_BUTTON_PADDING` Padding for the "reset to unknown" button for column filter entries.
`static int`	`SORT_AREA_LEFT_CLIP` Left clipping for sort area (sort arrow and number).
`static int`	`SORT_AREA_RIGHT_CLIP` Right clipping for sort area (sort arrow and number).
`static int`	`SORT_ARROW_MAX_LEFT_OFFSET` Maximum offset between sort arrow and label text.
`private boolean`	`startedPress` `true` if user pressed down mouse button on a column label if ALLOW-COLUMN-SEARCHING is `true`.
`private int`	`visibleColumnIndex` 0-based index of the column among the visible columns.
`private double`	`width` Column width, in chars.

Fields inherited from class com.goldencode.p2j.ui.client.BrowseColumn
config

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget
listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors
Constructor and Description
`BrowseColumnGuiImpl(boolean markersColumn)` Constructor.
`BrowseColumnGuiImpl(WidgetId id, BrowseColumnConfig cfg)` Constructor.
`BrowseColumnGuiImpl(WidgetId id, BrowseColumnConfig cfg, boolean markersColumn)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterConfigUpdate(BrowseColumnConfig beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`int`	`calcColumnWidth()` Calculate column width.
`int`	`calcColumnWidth(boolean ignoreSaved)` Calculate column width.
`(package private) int`	`calcDataWidth(boolean ignoreSaved)` Calculate width of the data part of the column.
`Dimension`	`dimension()` Get widget dimension.
`void`	`draw()` Draw the widget.
`boolean`	`drawnAsNonSortable()` Returns `true` if this column should be drawn as non-sortable (the label area is marked with red).
`NativeRectangle`	`getActualBounds()` Get the column actual bounds.
`BrowseGuiImpl`	`getBrowse()` Obtain the `BrowseGuiImpl` this column is part of.
`FontDetails`	`getCellsFont()` Obtain the current `FontDetails` for this column.
`NativePoint`	`getCellTextClipPoint(int viewportIndex)` Get clipping point for a text inside a cell relatively to the column top.
`NativeRectangle`	`getCellTextClipRectangle(NativePoint point)` Get clipping rectangle for a text inside a cell.
`int`	`getCellTextTopOffset()` Get top offset for positioning text inside a cell.
`private java.lang.String`	`getColumnFilterDataType()` For enhanced filtering: returns data type used in column filter.
`int`	`getColumnLabelTextWidth()` Get width of the label text, in pixels.
`int`	`getColumnPadding()` Get column padding, i.e.
`(package private) java.lang.String`	`getComboBoxCellText(java.lang.String cellText)` Get text of the cell for this combo-box column.
`private int`	`getFilterFillInHeight()` Get the height of the column filter entry field, in pixels.
`private int`	`getFilterFillInWidth()` Get the width of the column filter entry field, in pixels.
`(package private) BaseDataType`	`getFilteringEntryValue()` Get the value of the column filter for this column or `null` if the column filter entry field is not displayed.
`int`	`getLabelAreaWidth()` Get width of the column header, starting from the left column header border (inclusive) and ending with the right column header border (exclusive).
`FontDetails`	`getLabelFont()` Obtain the current `FontDetails` of this label.
`java.lang.String[]`	`getLabelLines()` Get the array of labels for this column.
`NativePoint`	`getLabelTextClipPoint()` Get clipping point for a text inside a label.
`NativeRectangle`	`getLabelTextClipRectangle(NativePoint clipPoint)` Get clipping rectangle for a text inside a label.
`int`	`getLabelTextTopOffset()` Get top offset for positioning text inside a label.
`java.lang.String`	`getMousePointerImpl()` Get the MOUSE-POINTER attribute
`private int`	`getResetToUnknownButtonSize()` Get the size (width or height) of the "reset to unknown" button linked to the column filter entry field, in pixels.
`private int`	`getResetToUnknownButtonX(FillInConfig filterFillInConfig)` Get the horizontal offset of the "reset to unknown" button linked to the column filter entry field, in pixels.
`int`	`getSortAreaWidth()` Get width of the sort area (sort arrow and number), in pixels.
`int`	`getVisibleColumnIndex()` Index of the browse column in the set of visible columns.
`private void`	`handleDragTimer()` Handles tick of a timer which is started on mouse drag in order to perform row scrolling if the mouse is above or below the browse.
`private void`	`handleRowFocus(int row)` Handle the case when the mouse is dragged over a row.
`private boolean`	`hasLeftResizeArea()` Determines if this column has left resize area (see `BrowseColumnGuiImpl.ResizeArea` for more information).
`private boolean`	`hasRightResizeArea()` Determines if this column has right resize area (see `BrowseColumnGuiImpl.ResizeArea` for more information).
`(package private) void`	`hideFilteringEntry()` Hide and destroy the column filter entry field.
`void`	`init(BrowseGuiImpl browse, int leftOffset, int visibleColumnIndex)` Initialize the widget.
`(package private) void`	`initEditorConfig(BaseConfig cfg)` Initialize editor widget config.
`void`	`initMarkersColumn(BrowseGuiImpl browse)` Initialize the markers (leftmost) column.
`boolean`	`isDrawnAsPressed()` Returns `true` if the column is visually in pressed state.
`boolean`	`isFirstColumn()` Returns `true` if it is the first column (not including markers column).
`boolean`	`isHeaderArea(NativePoint point)` Returns `true` if the given point is inside the column header.
`(package private) boolean`	`isInToggleBoxArea(java.awt.event.MouseEvent e)` Determines if the mouse event happened over the toggle box image area in the current row in this column.
`boolean`	`isLabelPressed()` Returns `true` if the column label must visually be in a pressed state.
`boolean`	`isLastColumn()` Returns `true` if it is the last column (not including markers column).
`boolean`	`isLastLockedColumn()` Returns `true` if it is the last column if the set of locked columns (not including markers column).
`boolean`	`isMarkersColumn()` Test whether this is a marker column.
`boolean`	`isVisible()` Check if the column is visible via its parent view port.
`boolean`	`manageSystemActions()` Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
`protected int[]`	`mouseActions()` Sub-classes will override this to return a list of mouse actions on which the widget responds.
`void`	`mouseDragged(java.awt.event.MouseEvent e)` Notification of a mouse dragged event occurred for this widget.
`void`	`mouseEntered(java.awt.event.MouseEvent e)` Notification of a mouse entered event occurred for this widget.
`void`	`mouseMoved(java.awt.event.MouseEvent e)` Notification of a mouse moved event occurred for this widget.
`void`	`mousePressed(java.awt.event.MouseEvent e)` Notification of a mouse pressed event occurred for this widget.
`void`	`mouseReleased(java.awt.event.MouseEvent e)` Notification of a mouse released event occurred for this widget.
`void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent e)` Notification of a mouse wheel moved event occurred for this widget.
`void`	`processDirectManipulationEvent(DirectManipulationEvent event)` Process direct manipulation event.
`void`	`processSystemKey(KeyInput key)` Process the action associated with the given key in an independent drawing bracket.
`(package private) void`	`resetFilteringEntry()` Reset the value of the column filter entry field to "unknown value".
`(package private) void`	`resolveFonts()` Resolve browse column fonts.
`(package private) void`	`saveFilterBackupValue()` Run `BrowseFilterEntryField.saveBackupValue()` for the linked filter entry field.
`void`	`setMousePointerName(java.lang.String name)` Set the MOUSE-POINTER attribute
`void`	`setWidth(double width)` Set column width and update WIDTH attribute accordingly.
`(package private) void`	`showFilteringEntry()` Create and show the column filter entry field.
`Menu`	`showPopupMenu(java.awt.event.MouseEvent e, java.lang.Runnable dismissHandler)` The method shows the popup menu for this widget.
`private void`	`startSearch()` Raise START-SEARCH event for the case of normal processing or process enhanced sorting if it is enabled.
`boolean`	`supportsCustomMousePointer()` Check if the widget supports LOAD-MOUSE-POINTER() method
`(package private) void`	`updateFilterWidth()` Update the width of the column filter entry field and poistion of the linked "reset to unknown" button.
`(package private) void`	`updateImplicitColumnWidth()` If the column has an implicit width, recalculate it according to the new column font.
`(package private) void`	`updateLabel()` Update the label (it should be parsed to the consisting lines).
`Window`	`window()` Get ancestor Window for this widget.

Methods inherited from class com.goldencode.p2j.ui.client.BrowseColumn
acceptTrigger, completeTrigger, config, getText, getValue, height, hidden, initialize, isFocusable, isModified, minimumSize, onFocusGained, onFocusLost, processEvent, setBrowse, setValue, setValue, startTrigger, width

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer
add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, currentFocus, cycleFocus, defaultFocus, deregisterSelectedWidget, destroy, detach, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusTraversable, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, insets, lastFocus, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, processKeyEvent, reflectAncestorChange, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, repaint, replace, requestFocus, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setSize, setTabItemList, 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, 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, hide, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, location, mouseClicked, mouseExited, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, 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, setVisible, setWindow, show, sync, topLevelWindow, toString, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized

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.DataContainer
getChangedValue

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

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget
acceptsEscAsAnyKey, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, defaultMousePtr, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hide, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, location, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue

Methods inherited from interface java.awt.event.MouseListener
mouseClicked, mouseExited

- Field Detail
  - LABEL_PRESSED_OFFSET
```
public static final int LABEL_PRESSED_OFFSET
```
    Offset of the label text if the column is in pressed state.
    
    See Also:
    
    Constant Field Values
  - LABEL_SHADOW_THICKNESS
```
public static final int LABEL_SHADOW_THICKNESS
```
    Thickness of the shadow inside the column header.
    
    See Also:
    
    Constant Field Values
  - SORT_ARROW_MAX_LEFT_OFFSET
```
public static final int SORT_ARROW_MAX_LEFT_OFFSET
```
    Maximum offset between sort arrow and label text.
    
    See Also:
    
    Constant Field Values
  - SORT_AREA_LEFT_CLIP
```
public static final int SORT_AREA_LEFT_CLIP
```
    Left clipping for sort area (sort arrow and number).
    
    See Also:
    
    Constant Field Values
  - SORT_AREA_RIGHT_CLIP
```
public static final int SORT_AREA_RIGHT_CLIP
```
    Right clipping for sort area (sort arrow and number).
    
    See Also:
    
    Constant Field Values
  - GAP_BETWEEN_SORT_ARROW_AND_NUMBER
```
public static final int GAP_BETWEEN_SORT_ARROW_AND_NUMBER
```
    Gap between sort arrow and sort number.
    
    See Also:
    
    Constant Field Values
  - PADDING
```
private static final int PADDING
```
    Difference between data width and actual column width (in pixels).
    
    See Also:
    
    Constant Field Values
  - RESET_TO_UNK_BUTTON_PADDING
```
static final int RESET_TO_UNK_BUTTON_PADDING
```
    Padding for the "reset to unknown" button for column filter entries.
    
    See Also:
    
    Constant Field Values
  - FILTER_ENTRY_PADDING_BOTTOM
```
static final int FILTER_ENTRY_PADDING_BOTTOM
```
    Bottom padding for column filter entry fields.
    
    See Also:
    
    Constant Field Values
  - FILTER_ENTRY_PADDING_SIDE
```
private static final int FILTER_ENTRY_PADDING_SIDE
```
    Side padding for column filter entry fields.
    
    See Also:
    
    Constant Field Values
  - LOG
```
private static final CentralLogger LOG
```
    Logger.
  - gd
```
private GuiDriver gd
```
    GUI driver.
  - browse
```
private BrowseGuiImpl browse
```
    Parent browse.
  - labelFont
```
private FontDetails labelFont
```
    Label font.
  - cellsFont
```
private FontDetails cellsFont
```
    Column font.
  - cc
```
private CoordinatesConversion cc
```
    Coordinates conversion.
  - width
```
private double width
```
    Column width, in chars.
  - visibleColumnIndex
```
private int visibleColumnIndex
```
    0-based index of the column among the visible columns.
  - markersColumn
```
private final boolean markersColumn
```
    If it is the markers (leftmost) column.
  - labelLines
```
private java.lang.String[] labelLines
```
    The lines of which the label consist.
  - isDragged
```
private boolean isDragged
```
    true if the column is being dragged.
  - isResized
```
private boolean isResized
```
    true if the column is being resized.
  - startedPress
```
private boolean startedPress
```
    true if user pressed down mouse button on a column label if ALLOW-COLUMN-SEARCHING is true.
  - isPressed
```
private boolean isPressed
```
    If column is pressed (column label is pressed if ALLOW-COLUMN-SEARCHING is true).
  - isRowFocusing
```
private boolean isRowFocusing
```
    Flag to indicate if a row was pressed and is currently dragged.
  - currentResizeArea
```
private BrowseColumnGuiImpl.ResizeArea currentResizeArea
```
    Indicates the resize area over which the mouse pointer is hovering now. See BrowseColumnGuiImpl.ResizeArea for more information. null if the mouse pointer is not hovering over a resize area.
  - labelPressed
```
private boolean labelPressed
```
    If column label is pressed this becoming true when owning window has 3-d falg on.
  - implicitWidth
```
private java.lang.Boolean implicitWidth
```
    true if the column has implicit width. false if the column has explicitly specified width.
  - filterEntry
```
private BrowseFilterEntryField filterEntry
```
    The column filter entry field for this column.
  - comboItemsCache
```
private java.util.Map<java.lang.String,java.lang.String> comboItemsCache
```
    For combo-box columns: cache of "item value" -> "item description" elements, used in column rendering.
  - columnFilterDataType
```
private java.lang.String columnFilterDataType
```
    For enhanced filtering: data type used in column filter. May not match column data type if DB-FILTER-FIELD-MAPPING is set for this column. In this case it corresponds data type of the mapped field.
  - lastMousePosition
```
private NativePoint lastMousePosition
```
    Last mouse position reported during mouse drag.
  - initialDragRow
```
private int initialDragRow
```
    Initial row selected during mouse drag.
  - lastDragRow
```
private int lastDragRow
```
    Last row selected during mouse drag.
- Constructor Detail
  - BrowseColumnGuiImpl
```
public BrowseColumnGuiImpl(boolean markersColumn)
```
    Constructor.
    
    Parameters:
    
    markersColumn - true if it is a markers (leftmost) column.
  - BrowseColumnGuiImpl
```
public BrowseColumnGuiImpl(WidgetId id,
                           BrowseColumnConfig cfg)
```
    Constructor.
    Call BrowseColumn.initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.BrowseColumnConfig) to finish the widget initialization.
    
    Parameters:
    
    id - The widget's ID.
    
    cfg - Configuration data.
  - BrowseColumnGuiImpl
```
public BrowseColumnGuiImpl(WidgetId id,
                           BrowseColumnConfig cfg,
                           boolean markersColumn)
```
    Constructor.
    Call BrowseColumn.initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.BrowseColumnConfig) to finish the widget initialization.
    
    Parameters:
    
    id - The widget's ID.
    
    cfg - Configuration data.
    
    markersColumn - true if it is a markers (leftmost) column.
- Method Detail
  - setWidth
```
public void setWidth(double width)
```
    Set column width and update WIDTH attribute accordingly.
    
    Specified by:
    
    setWidth in interface Container
    
    Overrides:
    
    setWidth in class AbstractContainer
    
    Parameters:
    
    width - Column width in characters.
  - initMarkersColumn
```
public void initMarkersColumn(BrowseGuiImpl browse)
```
    Initialize the markers (leftmost) column.
    
    Parameters:
    
    browse - Parent browse.
  - isMarkersColumn
```
public boolean isMarkersColumn()
```
    Test whether this is a marker column.
    
    Returns:
    
    true if this a marker column.
  - isVisible
```
public boolean isVisible()
```
    Check if the column is visible via its parent view port.
    
    Specified by:
    
    isVisible in interface Widget
    
    Overrides:
    
    isVisible in class BrowseColumn
    
    Returns:
    
    True if this column is via its parent view port, otherwise false.
  - getActualBounds
```
public NativeRectangle getActualBounds()
```
    Get the column actual bounds.
    
    Specified by:
    
    getActualBounds in interface Widget
    
    Overrides:
    
    getActualBounds in class AbstractWidget
    
    Returns:
    
    The column actual bounds. null if the column is outside of the browse viewport.
  - init
```
public void init(BrowseGuiImpl browse,
                 int leftOffset,
                 int visibleColumnIndex)
```
    Initialize the widget.
    
    Parameters:
    
    browse - Parent browse.
    
    leftOffset - Column offset in pixels (i.e. width of preceding columns).
    
    visibleColumnIndex - 0-based index of the column among the visible columns.
  - getBrowse
```
public BrowseGuiImpl getBrowse()
```
    Obtain the BrowseGuiImpl this column is part of.
    
    Overrides:
    
    getBrowse in class BrowseColumn
    
    Returns:
    
    the parent BrowseGuiImpl widget.
  - calcColumnWidth
```
public int calcColumnWidth()
```
    Calculate column width.
    
    Returns:
    
    column width.
  - calcColumnWidth
```
public int calcColumnWidth(boolean ignoreSaved)
```
    Calculate column width.
    
    Parameters:
    
    ignoreSaved - true to ignore the saved width for this column.
    
    Returns:
    
    column width.
  - getColumnPadding
```
public int getColumnPadding()
```
    Get column padding, i.e. difference between data width and actual column width.
    
    Returns:
    
    column padding in native units.
  - afterConfigUpdate
```
public void afterConfigUpdate(BrowseColumnConfig beforeUpdate)
```
    The method is called after the configuration associated with the implementor changes. The parameter points to a reference representing the original configuration state. This reference can be used to detect what configuration fields changed and so optimize any processing related to the configuration change.
    
    Overrides:
    
    afterConfigUpdate in class BrowseColumn
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - dimension
```
public Dimension dimension()
```
    Get widget dimension.
    
    Specified by:
    
    dimension in interface Widget
    
    Overrides:
    
    dimension in class BrowseColumn
    
    Returns:
    
    widget dimension.
  - draw
```
public void draw()
```
    Draw the widget.
    
    Specified by:
    
    draw in interface Widget
    
    Overrides:
    
    draw in class BrowseColumn
  - getLabelFont
```
public FontDetails getLabelFont()
```
    Obtain the current FontDetails of this label.
    
    Returns:
    
    the current FontDetails of the label.
  - getCellsFont
```
public FontDetails getCellsFont()
```
    Obtain the current FontDetails for this column.
    
    Returns:
    
    the current FontDetails.
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Notification of a mouse pressed event occurred for this widget.
    
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
    
    Overrides:
    
    mousePressed in class AbstractWidget
    
    Parameters:
    
    e - The mouse event.
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    Notification of a mouse released event occurred for this widget.
    
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
    
    Overrides:
    
    mouseReleased in class AbstractWidget
    
    Parameters:
    
    e - The mouse event.
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent e)
```
    Notification of a mouse dragged event occurred for this widget.
    
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
    
    Overrides:
    
    mouseDragged in class AbstractWidget
    
    Parameters:
    
    e - The mouse event.
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent e)
```
    Notification of a mouse moved event occurred for this widget.
    
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
    
    Overrides:
    
    mouseMoved in class AbstractWidget
    
    Parameters:
    
    e - The mouse event.
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e)
```
    Notification of a mouse entered event occurred for this widget.
    
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
    
    Overrides:
    
    mouseEntered in class AbstractWidget
    
    Parameters:
    
    e - The mouse event.
  - processDirectManipulationEvent
```
public void processDirectManipulationEvent(DirectManipulationEvent event)
```
    Process direct manipulation event.
    
    Specified by:
    
    processDirectManipulationEvent in interface Widget
    
    Overrides:
    
    processDirectManipulationEvent in class AbstractWidget
    
    Parameters:
    
    event - Event to process.
  - mouseWheelMoved
```
public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)
```
    Notification of a mouse wheel moved event occurred for this widget. No-op by default.
    
    Specified by:
    
    mouseWheelMoved in interface java.awt.event.MouseWheelListener
    
    Overrides:
    
    mouseWheelMoved in class AbstractWidget
    
    Parameters:
    
    e - The mouse event.
  - window
```
public Window window()
```
    Get ancestor Window for this widget.
    
    Specified by:
    
    window in interface Widget
    
    Overrides:
    
    window in class AbstractWidget
    
    Returns:
    
    ancestor Window or null if the widget is not yet attached to a Window.
  - manageSystemActions
```
public boolean manageSystemActions()
```
    Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
    
    Overrides:
    
    manageSystemActions in class AbstractWidget
    
    Returns:
    
    true if the widget has its own event management. false by default.
  - processSystemKey
```
public void processSystemKey(KeyInput key)
```
    Process the action associated with the given key in an independent drawing bracket.
    This must be called only in the context of widget-level event processing.
    
    Overrides:
    
    processSystemKey in class AbstractWidget
    
    Parameters:
    
    key - The key to be processed.
  - isHeaderArea
```
public boolean isHeaderArea(NativePoint point)
```
    Returns true if the given point is inside the column header.
    
    Parameters:
    
    point - Point to check.
    
    Returns:
    
    See above.
  - getComboBoxCellText
```
java.lang.String getComboBoxCellText(java.lang.String cellText)
```
    Get text of the cell for this combo-box column.
    
    Parameters:
    
    cellText - Original text of the cell as if this column is not a combo-box column.
    
    Returns:
    
    if this column is not a combo-box column, then the original cellText is returned. If this column is a combo-box column, then combo-box item values are replaced with item descriptions and returned. If there is no matching value, the original cellText is returned
  - updateLabel
```
void updateLabel()
```
    Update the label (it should be parsed to the consisting lines).
  - getLabelLines
```
public java.lang.String[] getLabelLines()
```
    Get the array of labels for this column. You may need to call updateLabel() first to have then initialized.
    
    Returns:
    
    the lines of which the label consist.
  - initEditorConfig
```
void initEditorConfig(BaseConfig cfg)
```
    Initialize editor widget config.
    
    Parameters:
    
    cfg - Editor widget config.
  - supportsCustomMousePointer
```
public boolean supportsCustomMousePointer()
```
    Check if the widget supports LOAD-MOUSE-POINTER() method
    
    Specified by:
    
    supportsCustomMousePointer in interface Widget
    
    Overrides:
    
    supportsCustomMousePointer in class AbstractWidget
    
    Returns:
    
    true if the widget supports LOAD-MOUSE-POINTER() method
  - setMousePointerName
```
public void setMousePointerName(java.lang.String name)
```
    Set the MOUSE-POINTER attribute
    
    Specified by:
    
    setMousePointerName in interface Hoverable
    
    Parameters:
    
    name - the attribute value
  - getMousePointerImpl
```
public java.lang.String getMousePointerImpl()
```
    Get the MOUSE-POINTER attribute
    
    Specified by:
    
    getMousePointerImpl in interface Hoverable
    
    Returns:
    
    the attribute value
  - getVisibleColumnIndex
```
public int getVisibleColumnIndex()
```
    Index of the browse column in the set of visible columns.
    
    Returns:
    
    0-based index of the browse column in the set of visible columns (also except the markers column).
  - mouseActions
```
protected int[] mouseActions()
```
    Sub-classes will override this to return a list of mouse actions on which the widget responds. This is compatible with the AWT MouseEvent codes and P2J specific MouseEvt actions.
    
    Overrides:
    
    mouseActions in class AbstractWidget
    
    Returns:
    
    See above.
  - getColumnLabelTextWidth
```
public int getColumnLabelTextWidth()
```
    Get width of the label text, in pixels.
    
    Returns:
    
    see above.
  - getSortAreaWidth
```
public int getSortAreaWidth()
```
    Get width of the sort area (sort arrow and number), in pixels.
    
    Returns:
    
    see above.
  - isDrawnAsPressed
```
public boolean isDrawnAsPressed()
```
    Returns true if the column is visually in pressed state.
    
    Returns:
    
    see above.
  - isLabelPressed
```
public boolean isLabelPressed()
```
    Returns true if the column label must visually be in a pressed state.
    
    Returns:
    
    see above.
  - getLabelTextClipPoint
```
public NativePoint getLabelTextClipPoint()
```
    Get clipping point for a text inside a label.
    
    Returns:
    
    see above.
  - getLabelTextClipRectangle
```
public NativeRectangle getLabelTextClipRectangle(NativePoint clipPoint)
```
    Get clipping rectangle for a text inside a label.
    
    Parameters:
    
    clipPoint - Clipping point.
    
    Returns:
    
    see above.
  - getLabelAreaWidth
```
public int getLabelAreaWidth()
```
    Get width of the column header, starting from the left column header border (inclusive) and ending with the right column header border (exclusive).
    
    Returns:
    
    see above.
  - getLabelTextTopOffset
```
public int getLabelTextTopOffset()
```
    Get top offset for positioning text inside a label.
    
    Returns:
    
    see above.
  - getCellTextTopOffset
```
public int getCellTextTopOffset()
```
    Get top offset for positioning text inside a cell.
    
    Returns:
    
    see above.
  - getCellTextClipPoint
```
public NativePoint getCellTextClipPoint(int viewportIndex)
```
    Get clipping point for a text inside a cell relatively to the column top.
    
    Parameters:
    
    viewportIndex - 0-based viewport index of the row the cell belongs to.
    
    Returns:
    
    see above.
  - getCellTextClipRectangle
```
public NativeRectangle getCellTextClipRectangle(NativePoint point)
```
    Get clipping rectangle for a text inside a cell.
    
    Parameters:
    
    point - Clipping point.
    
    Returns:
    
    see above.
  - updateImplicitColumnWidth
```
void updateImplicitColumnWidth()
```
    If the column has an implicit width, recalculate it according to the new column font.
  - getFilteringEntryValue
```
BaseDataType getFilteringEntryValue()
```
    Get the value of the column filter for this column or null if the column filter entry field is not displayed.
    
    Returns:
    
    see above.
  - showFilteringEntry
```
void showFilteringEntry()
```
    Create and show the column filter entry field.
  - hideFilteringEntry
```
void hideFilteringEntry()
```
    Hide and destroy the column filter entry field.
  - resetFilteringEntry
```
void resetFilteringEntry()
```
    Reset the value of the column filter entry field to "unknown value".
  - saveFilterBackupValue
```
void saveFilterBackupValue()
```
    Run BrowseFilterEntryField.saveBackupValue() for the linked filter entry field.
  - calcDataWidth
```
int calcDataWidth(boolean ignoreSaved)
```
    Calculate width of the data part of the column.
    
    Parameters:
    
    ignoreSaved - true to ignore the saved width for this column.
    
    Returns:
    
    width of the data part of the column.
  - resolveFonts
```
void resolveFonts()
```
    Resolve browse column fonts.
  - isFirstColumn
```
public boolean isFirstColumn()
```
    Returns true if it is the first column (not including markers column).
    
    Returns:
    
    see above.
  - isLastColumn
```
public boolean isLastColumn()
```
    Returns true if it is the last column (not including markers column).
    
    Returns:
    
    see above.
  - drawnAsNonSortable
```
public boolean drawnAsNonSortable()
```
    Returns true if this column should be drawn as non-sortable (the label area is marked with red).
    
    Returns:
    
    see above.
  - handleDragTimer
```
private void handleDragTimer()
```
    Handles tick of a timer which is started on mouse drag in order to perform row scrolling if the mouse is above or below the browse. This functions performs scrolling if conditions are met, and schedules a new call of this function after speciifc time interval.
  - handleRowFocus
```
private void handleRowFocus(int row)
```
    Handle the case when the mouse is dragged over a row.
    
    Parameters:
    
    row - Viewport index of the row under the mouse pointer.
  - startSearch
```
private void startSearch()
```
    Raise START-SEARCH event for the case of normal processing or process enhanced sorting if it is enabled.
  - hasLeftResizeArea
```
private boolean hasLeftResizeArea()
```
    Determines if this column has left resize area (see BrowseColumnGuiImpl.ResizeArea for more information).
    
    Returns:
    
    true if this column has left resize area.
  - hasRightResizeArea
```
private boolean hasRightResizeArea()
```
    Determines if this column has right resize area (see BrowseColumnGuiImpl.ResizeArea for more information).
    
    Returns:
    
    true if this column has right resize area.
  - getFilterFillInHeight
```
private int getFilterFillInHeight()
```
    Get the height of the column filter entry field, in pixels.
    
    Returns:
    
    see above.
  - getFilterFillInWidth
```
private int getFilterFillInWidth()
```
    Get the width of the column filter entry field, in pixels.
    
    Returns:
    
    see above.
  - getResetToUnknownButtonSize
```
private int getResetToUnknownButtonSize()
```
    Get the size (width or height) of the "reset to unknown" button linked to the column filter entry field, in pixels.
    
    Returns:
    
    see above.
  - getResetToUnknownButtonX
```
private int getResetToUnknownButtonX(FillInConfig filterFillInConfig)
```
    Get the horizontal offset of the "reset to unknown" button linked to the column filter entry field, in pixels.
    
    Parameters:
    
    filterFillInConfig - Config of the column filter entry field.
    
    Returns:
    
    horizontal offset of the "reset to unknown" button linked to the column filter entry field, in pixels
  - getColumnFilterDataType
```
private java.lang.String getColumnFilterDataType()
```
    For enhanced filtering: returns data type used in column filter. May not match column data type if DB-FILTER-FIELD-MAPPING is set for this column. In this case it corresponds data type of the mapped field.
    
    Returns:
    
    see above.
  - updateFilterWidth
```
void updateFilterWidth()
```
    Update the width of the column filter entry field and poistion of the linked "reset to unknown" button.
  - isLastLockedColumn
```
public boolean isLastLockedColumn()
```
    Returns true if it is the last column if the set of locked columns (not including markers column).
    
    Returns:
    
    see above.
  - isInToggleBoxArea
```
boolean isInToggleBoxArea(java.awt.event.MouseEvent e)
```
    Determines if the mouse event happened over the toggle box image area in the current row in this column.
    
    Parameters:
    
    e - Mouse event.
    
    Returns:
    
    true if the mouse event happened over the toggle box image area in the current row in this column.
  - showPopupMenu
```
public Menu showPopupMenu(java.awt.event.MouseEvent e,
                          java.lang.Runnable dismissHandler)
```
    The method shows the popup menu for this widget. The menu is resolved with the help of AbstractWidget.resolvePopupMenuId().
    
    Overrides:
    
    showPopupMenu in class AbstractWidget
    
    Parameters:
    
    e - The related mouse event that caused a popup to be shown.
    
    dismissHandler - When not null, the runnable instance is executed when the popup menu is dismissed, regardless whether an item is chosen or not.
    
    Returns:
    
    Returns the popup menu shown or null if no popup is resolved for this widget.

Class BrowseColumnGuiImpl

Nested Class Summary

Field Summary

Fields inherited from class com.goldencode.p2j.ui.client.BrowseColumn

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.awt.event.MouseListener

Field Detail

LABEL_PRESSED_OFFSET

LABEL_SHADOW_THICKNESS

SORT_ARROW_MAX_LEFT_OFFSET

SORT_AREA_LEFT_CLIP

SORT_AREA_RIGHT_CLIP

GAP_BETWEEN_SORT_ARROW_AND_NUMBER

PADDING

RESET_TO_UNK_BUTTON_PADDING

FILTER_ENTRY_PADDING_BOTTOM

FILTER_ENTRY_PADDING_SIDE

LOG

gd

browse

labelFont

cellsFont

cc

width

visibleColumnIndex

markersColumn

labelLines

isDragged

isResized

startedPress

isPressed

isRowFocusing

currentResizeArea

labelPressed

implicitWidth

filterEntry

comboItemsCache

columnFilterDataType

lastMousePosition

initialDragRow

lastDragRow

Constructor Detail

BrowseColumnGuiImpl

BrowseColumnGuiImpl

BrowseColumnGuiImpl

Method Detail

setWidth

initMarkersColumn

isMarkersColumn

isVisible

getActualBounds

init

getBrowse

calcColumnWidth

calcColumnWidth

getColumnPadding

afterConfigUpdate

dimension

draw

getLabelFont

getCellsFont

mousePressed

mouseReleased

mouseDragged

mouseMoved

mouseEntered

processDirectManipulationEvent

mouseWheelMoved

window

manageSystemActions

processSystemKey