Class UIHeaderRow

public class UIHeaderRow extends UIRow
{
  // Constructors
  public UIHeaderRow();
  public UIHeaderRow(Object columns[]);

  // Methods
  public IUIComponent getFloater();
  public boolean isKeyable();
  public void layout();
  public boolean mouseDown(Event e, int x, int y);
  public boolean mouseDrag(Event e, int x, int y);
  public boolean mouseUp(Event e, int x, int y);
  public IUIComponent navigate(IUIComponent comp, int dir,
        boolean keyable);
  public void paint(FxGraphics g);
  public void paintComponent(FxGraphics g, IUIComponent comp);
  public void setSelected(boolean flag);
}

This class implements a header row.

UIComponent
  |
  +--UIContainer
    |
    +--UIStateContainer
      |
      +--UIPanel
        |
        +--UIRow
          |
          +--UIHeaderRow

Constructors

UIHeaderRow

public UIHeaderRow();

Creates a header row.

UIHeaderRow

public UIHeaderRow(Object columns[]);

Creates a header row using an array of columns.

Parameter	Description
columns	The array of columns.

Methods

getFloater

public IUIComponent getFloater();

Returns the floating component in this container, if there is one. The floating component is the component that is superceding the standard z-order of the container's children by being first in the z-order. This is most commonly used when a component is being dragged, such as a column header or a scroll thumb.

Return Value:

Returns the current floating component, or null if there is none.

isKeyable

public boolean isKeyable();

Determines whether the header row can receive keyboard input.

Return Value:

Returns false, indicating the header row cannot receive keyboard input.

layout

public void layout();

Lays out the row header.

Return Value:

No return value.

mouseDown

public boolean mouseDown(Event e, int x, int y);

Responds to the mouse button being pressed over the header row.

Return Value:

Returns true if the event was handled; otherwise, returns false.

Parameter	Description
e	The event posted to the control.
x	The x coordinate of the event.
y	The y coordinate of the event.

mouseDrag

public boolean mouseDrag(Event e, int x, int y);

Responds to the mouse button being dragged over the header row.

Return Value:

Returns true if event was handled; otherwise, returns false.

Parameter	Description
e	The event posted to the control.
x	The x coordinate of the event.
y	The y coordinate of the event.

mouseUp

public boolean mouseUp(Event e, int x, int y);

Responds to the mouse button being released over the header row.

Return Value:

Returns true if event was handled; otherwise, returns false.

Parameter	Description
e	The event posted to the control.
x	The x coordinate of the event.
y	The y coordinate of the event.

navigate

public IUIComponent navigate(IUIComponent comp, int dir, boolean keyable);

Navigates to another component from the specified component in the specified direction.

Return Value:

Returns the component navigated to (if a component in the specified direction exists); otherwise, returns null.

Parameter	Description
comp	The component to navigate from.
dir	The navigation direction. Specify one of the NAVDIR values in the IUIAccessible interface.
keyable	If true, only components that are able to receive keyboard input can be navigated to; otherwise, all components can be navigated to.

paint

public void paint(FxGraphics g);

Draws the header row.

Return Value:

No return value.

Parameter	Description
g	The graphics context.

paintComponent

public void paintComponent(FxGraphics g, IUIComponent comp);

Draws the specified component.

Return Value:

No return value.

Parameter	Description
g	The graphics context.
comp	The component to paint.

setSelected

public void setSelected(boolean flag);

Sets or clears the selected state of the header row.

Return Value:

No return value.

Parameter	Description
flag	If true, the header row is selected; otherwise, it is deselected.

Remarks:

By default, this method ignores the flag parameter and simply returns true.

Overrides:

setSelected(boolean) in UIRow.