Class MultiRowLayout
java.lang.Object
docking.widgets.fieldpanel.support.MultiRowLayout
- All Implemented Interfaces:
Layout
Handles layouts with muliple rows.
-
Constructor Summary
ConstructorDescriptionMultiRowLayout
(RowLayout[] layouts, int indexSize) MultiRowLayout
(RowLayout layout, int indexSize) Constructs a new MultiRowLayout with a single layout row. -
Method Summary
Modifier and TypeMethodDescriptionvoid
align
(int[] rowHeights) Aligns the heights in this MultiRowLayout to match those in the give row heights array.boolean
contains
(int yPos) Returns true if the the given yPos lies within this layout.int
cursorBeginning
(FieldLocation cursorLoc) Sets the given FieldLocation as far to the left as possible.boolean
cursorDown
(FieldLocation cursorLoc, int lastX) Moves the cursor up down row from its current position.int
cursorEnd
(FieldLocation cursorLoc) Sets the given FieldLocation as far to the right as possible.int
cursorLeft
(FieldLocation cursorLoc) Sets the given FieldLocation one position to the left.int
cursorRight
(FieldLocation cursorLoc) Sets the given FieldLocation one position to the right.boolean
cursorUp
(FieldLocation cursorLoc, int lastX) Moves the cursor up one row from its current position.boolean
enterLayout
(FieldLocation cursorLoc, int lastX, boolean fromTop) Tries to move the cursor into this layout.void
fillHeights
(int[] rowHeights) Fills in the given array with the heights of all the layouts in the MultiRowLayoutint
getBeginRowFieldNum
(int fieldIndex) int
Returns the smallest possible width of this layout that can display its full contentsgetCursorRect
(int fieldNum, int row, int col) Returns a rectangle which bounds the given cursor position.int
getEndRowFieldNum
(int fieldIndex) getField
(int index) Returns the i'th Field in this Layout.getFieldBounds
(int index) Returns the bounds of the given field (in coordinates relative to the layout)int
getFieldIndex
(int x, int y) Returns the index of the field at the given coordinates (relative to the layout)int
int
Returns the total height of this layout.int
Returns the number of indexes consumed by this layout.int
Returns the number of Fields in this Layout.int
Returns the vertical offset (in pixels) of the start of the primary field in the layout.int
getScrollableUnitIncrement
(int topOfScreen, int direction) Returns the amount to scroll to reveal the line of text.void
insertSpaceAbove
(int size) Inserts empty space above the layoutvoid
insertSpaceBelow
(int size) Inserts empty space below the layoutvoid
paint
(JComponent c, Graphics g, PaintContext context, Rectangle rect, LayoutBackgroundColorManager colorManager, FieldLocation cursorLocation) Paints this layout on the screen.int
setCursor
(FieldLocation cursorLoc, int x, int y) Sets the cursor to the given point location.
-
Constructor Details
-
MultiRowLayout
Constructs a new MultiRowLayout with a single layout row.- Parameters:
layout
- the single layout to add to this MultiRowLayout.
-
MultiRowLayout
-
-
Method Details
-
getHeight
public int getHeight()Description copied from interface:Layout
Returns the total height of this layout. -
getCompressableWidth
public int getCompressableWidth()Description copied from interface:Layout
Returns the smallest possible width of this layout that can display its full contents- Specified by:
getCompressableWidth
in interfaceLayout
- Returns:
- the smallest possible width of this layout that can display its full contents
-
getNumFields
public int getNumFields()Description copied from interface:Layout
Returns the number of Fields in this Layout.- Specified by:
getNumFields
in interfaceLayout
-
getField
Description copied from interface:Layout
Returns the i'th Field in this Layout. -
paint
public void paint(JComponent c, Graphics g, PaintContext context, Rectangle rect, LayoutBackgroundColorManager colorManager, FieldLocation cursorLocation) Description copied from interface:Layout
Paints this layout on the screen.- Specified by:
paint
in interfaceLayout
- Parameters:
g
- The graphics context with which to paint.context
- contains various information needed to do the paintrect
- the screen area that needs to be painted.colorManager
- indicates where the selection existscursorLocation
- the location of the cursor or null if the cursor is not in this layout
-
setCursor
Description copied from interface:Layout
Sets the cursor to the given point location. The cursor will be positioned to the row column position that is closest to the given point.- Specified by:
setCursor
in interfaceLayout
- Parameters:
cursorLoc
- the location that is to be filled in.x
- the x coordinate of the point to be translated into a cursor location.y
- the y coordinate of the point to be translated into a cursor location.- Returns:
- the x coordinated of the computed cursor location.
-
getFieldIndex
public int getFieldIndex(int x, int y) Description copied from interface:Layout
Returns the index of the field at the given coordinates (relative to the layout)- Specified by:
getFieldIndex
in interfaceLayout
- Parameters:
x
- the x coordinatey
- the y coordinate- Returns:
- the index of the field at the given coordinates (relative to the layout)
-
getCursorRect
Description copied from interface:Layout
Returns a rectangle which bounds the given cursor position.- Specified by:
getCursorRect
in interfaceLayout
- Parameters:
fieldNum
- the index of the field containing the cursor position.row
- the the text row in the field containing the cursor position.col
- the character position in the row containing the cursor position.
-
cursorUp
Description copied from interface:Layout
Moves the cursor up one row from its current position. -
cursorDown
Description copied from interface:Layout
Moves the cursor up down row from its current position.- Specified by:
cursorDown
in interfaceLayout
- Parameters:
cursorLoc
- the cursor location object to be modifiedlastX
- the x coordinate of the cursor before the move.- Returns:
- true if the cursor was successfully moved down without leaving the layout.
-
cursorBeginning
Description copied from interface:Layout
Sets the given FieldLocation as far to the left as possible.- Specified by:
cursorBeginning
in interfaceLayout
- Parameters:
cursorLoc
- the cursor location object to be modified.- Returns:
- the x coordinate of the cursor after the operation.
-
cursorEnd
Description copied from interface:Layout
Sets the given FieldLocation as far to the right as possible. -
cursorLeft
Description copied from interface:Layout
Sets the given FieldLocation one position to the left. If already at the left most position, it tries to move to the end of the previous row.- Specified by:
cursorLeft
in interfaceLayout
- Parameters:
cursorLoc
- the cursor location object to be modified.- Returns:
- the x coordinate of the cursor after the operation. Returns -1 if it was already at the top, left most position.
-
cursorRight
Description copied from interface:Layout
Sets the given FieldLocation one position to the right. If already at the right most position, it tries to move to the beginning of the next row.- Specified by:
cursorRight
in interfaceLayout
- Parameters:
cursorLoc
- the cursor location object to be modified.- Returns:
- the x coordinate of the cursor after the operation. Returns -1 if it was already at the bottom, right most position.
-
enterLayout
Description copied from interface:Layout
Tries to move the cursor into this layout.- Specified by:
enterLayout
in interfaceLayout
- Parameters:
cursorLoc
- the field location to hold new location.lastX
- the last valid x coordinate.fromTop
- true if entering from the above this layout- Returns:
- true if the cursor successfully moves into this layout.
-
getScrollableUnitIncrement
public int getScrollableUnitIncrement(int topOfScreen, int direction) Description copied from interface:Layout
Returns the amount to scroll to reveal the line of text.- Specified by:
getScrollableUnitIncrement
in interfaceLayout
- Parameters:
topOfScreen
- the y coordinate that represents the top or bottom of the screendirection
- the direction to scroll
-
contains
public boolean contains(int yPos) Description copied from interface:Layout
Returns true if the the given yPos lies within this layout. -
getPrimaryOffset
public int getPrimaryOffset()Description copied from interface:Layout
Returns the vertical offset (in pixels) of the start of the primary field in the layout.- Specified by:
getPrimaryOffset
in interfaceLayout
- Returns:
- -1 if layout does not have a primary field.
-
getFieldBounds
Description copied from interface:Layout
Returns the bounds of the given field (in coordinates relative to the layout)- Specified by:
getFieldBounds
in interfaceLayout
- Parameters:
index
- the field id for the field for which to get bounds
-
insertSpaceAbove
public void insertSpaceAbove(int size) Description copied from interface:Layout
Inserts empty space above the layout- Specified by:
insertSpaceAbove
in interfaceLayout
- Parameters:
size
- the amount of space to insert above the layout
-
insertSpaceBelow
public void insertSpaceBelow(int size) Description copied from interface:Layout
Inserts empty space below the layout- Specified by:
insertSpaceBelow
in interfaceLayout
- Parameters:
size
- the amount of space to insert below the layout
-
fillHeights
public void fillHeights(int[] rowHeights) Fills in the given array with the heights of all the layouts in the MultiRowLayout- Parameters:
rowHeights
- the array to be filled in with heights. Each height is stored at its layoutRow id as the index into the array.
-
align
public void align(int[] rowHeights) Aligns the heights in this MultiRowLayout to match those in the give row heights array. Extra is inserted to align the rows in this layout to match those specified in the given array.- Parameters:
rowHeights
- the aray of row height to align to.
-
getIndexSize
public int getIndexSize()Description copied from interface:Layout
Returns the number of indexes consumed by this layout.- Specified by:
getIndexSize
in interfaceLayout
-
getBeginRowFieldNum
public int getBeginRowFieldNum(int fieldIndex) - Specified by:
getBeginRowFieldNum
in interfaceLayout
-
getEndRowFieldNum
public int getEndRowFieldNum(int fieldIndex) - Specified by:
getEndRowFieldNum
in interfaceLayout
-
getFirstRowID
public int getFirstRowID()
-