Package docking.widgets.fieldpanel.field
Class EmptyTextField
- java.lang.Object
-
- docking.widgets.fieldpanel.field.EmptyTextField
-
-
Field Summary
Fields Modifier and Type Field Description protected int
height
protected int
heightAbove
protected boolean
isPrimary
protected int
startX
protected int
width
-
Constructor Summary
Constructors Constructor Description EmptyTextField(int heightAbove, int heightBelow, int startX, int width)
Constructs a new EmptyTextField
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
contains(int x, int y)
Returns true if the given point is in this field.int
getCol(int row, int x)
Returns the cursor column position for the given x coordinate on the given row.java.awt.Rectangle
getCursorBounds(int row, int col)
Returns a bounding rectangle for the cursor at the given position.java.awt.Color
getForeground()
Get the foreground color.int
getHeight()
Returns the height of this field when populated with the given data.int
getHeightAbove()
Returns the height above the baseLine.int
getHeightBelow()
Returns the height below the baseLine.int
getNumCols(int row)
Returns the number of columns in the given row.int
getNumRows()
Returns the number of rows in this fieldint
getPreferredWidth()
The minimum required width to paint the contents of this fieldint
getRow(int y)
Returns the row containing the given y coordinate.int
getScrollableUnitIncrement(int topOfScreen, int direction, int max)
Returns the amount to scroll to the next or previous lineint
getStartX()
Returns the horizontal position of this field.java.lang.String
getText()
Returns a string containing all the text in the field.java.lang.String
getTextWithLineSeparators()
Returns a string containing all the text in the field with extra linefeedsint
getWidth()
Returns the current width of this field.int
getX(int row, int col)
Returns the x coordinate for the given cursor position.int
getY(int row)
Returns the y coordinate for the given row.boolean
isAllowCursorAtEnd()
Returns true if the cursor is allowed past the last character.boolean
isPrimary()
Returns true if this field is "primary" (the most important) field; used to determine the "primary" line in the layout.boolean
isValid(int row, int col)
Returns true if the given row and column represent a valid location for this field with the given data;void
paint(javax.swing.JComponent c, java.awt.Graphics g, PaintContext context, java.awt.Rectangle clip, FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight)
Paints this field.void
rowHeightChanged(int newHeightAbove, int newHeightBelow)
notifies field that the rowHeight changedint
screenLocationToTextOffset(int row, int col)
Returns the text offset in the overall field text string for the given row and column.void
setForeground(java.awt.Color color)
Sets the foreground color which isn't used by objects of this classvoid
setPrimary(boolean state)
Sets the primary state for this fieldRowColLocation
textOffsetToScreenLocation(int textOffset)
Returns the row, column position for an offset into the string returned by getText().
-
-
-
Constructor Detail
-
EmptyTextField
public EmptyTextField(int heightAbove, int heightBelow, int startX, int width)
Constructs a new EmptyTextField- Parameters:
heightAbove
- the height above the baseline of the text field.heightBelow
- the height below the baseline of the text field.startX
- the starting x coordinate.width
- the width of the field. the end of the text.
-
-
Method Detail
-
isAllowCursorAtEnd
public boolean isAllowCursorAtEnd()
Returns true if the cursor is allowed past the last character. This field always returns false since there is no text.
-
getWidth
public int getWidth()
Description copied from interface:Field
Returns the current width of this field.
-
getPreferredWidth
public int getPreferredWidth()
Description copied from interface:Field
The minimum required width to paint the contents of this field- Specified by:
getPreferredWidth
in interfaceField
- Returns:
- the minimum required width to paint the contents of this field
-
getHeight
public int getHeight()
Description copied from interface:Field
Returns the height of this field when populated with the given data.
-
getStartX
public int getStartX()
Description copied from interface:Field
Returns the horizontal position of this field.
-
getNumRows
public int getNumRows()
Description copied from interface:Field
Returns the number of rows in this field- Specified by:
getNumRows
in interfaceField
-
getNumCols
public int getNumCols(int row)
Description copied from interface:Field
Returns the number of columns in the given row.- Specified by:
getNumCols
in interfaceField
- Parameters:
row
- the row from which to get the number of columns.
-
getRow
public int getRow(int y)
Description copied from interface:Field
Returns the row containing the given y coordinate.
-
getCol
public int getCol(int row, int x)
Description copied from interface:Field
Returns the cursor column position for the given x coordinate on the given row.
-
getY
public int getY(int row)
Description copied from interface:Field
Returns the y coordinate for the given row.
-
getX
public int getX(int row, int col)
Description copied from interface:Field
Returns the x coordinate for the given cursor position.
-
isValid
public boolean isValid(int row, int col)
Description copied from interface:Field
Returns true if the given row and column represent a valid location for this field with the given data;
-
paint
public void paint(javax.swing.JComponent c, java.awt.Graphics g, PaintContext context, java.awt.Rectangle clip, FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight)
Description copied from interface:Field
Paints this field.- Specified by:
paint
in interfaceField
- Parameters:
c
- the component to paint ontog
- the graphics context.context
- common paint parametersclip
- the clipping region to paint intomap
- contains background color information for the field.cursorLoc
- the row,column cursor location within the field or null if the field does not contain the cursorrowHeight
- the number of pixels in each row of text in the field.
-
getCursorBounds
public java.awt.Rectangle getCursorBounds(int row, int col)
Description copied from interface:Field
Returns a bounding rectangle for the cursor at the given position.- Specified by:
getCursorBounds
in interfaceField
- Parameters:
row
- the text row.col
- the character postion.
-
contains
public boolean contains(int x, int y)
Description copied from interface:Field
Returns true if the given point is in this field.
-
setForeground
public void setForeground(java.awt.Color color)
Sets the foreground color which isn't used by objects of this class- Parameters:
color
- the new foreground color.
-
getForeground
public java.awt.Color getForeground()
Get the foreground color.- Returns:
- Color could return null if the setForeground() method was not called, and if this method is called before the paint() method was called.
-
getScrollableUnitIncrement
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max)
Description copied from interface:Field
Returns the amount to scroll to the next or previous line- Specified by:
getScrollableUnitIncrement
in interfaceField
- Parameters:
topOfScreen
- - the current y pos of the top of the screen.direction
- - the direction of the scroll (1 down, -1 up)max
- - the maximum amount to scroll for the entire row - will be positive for down, and negative for up)
-
isPrimary
public boolean isPrimary()
Description copied from interface:Field
Returns true if this field is "primary" (the most important) field; used to determine the "primary" line in the layout.
-
setPrimary
public void setPrimary(boolean state)
Sets the primary state for this field- Parameters:
state
- the state to set the primary property.
-
getHeightAbove
public int getHeightAbove()
Description copied from interface:Field
Returns the height above the baseLine.- Specified by:
getHeightAbove
in interfaceField
-
getHeightBelow
public int getHeightBelow()
Description copied from interface:Field
Returns the height below the baseLine.- Specified by:
getHeightBelow
in interfaceField
-
rowHeightChanged
public void rowHeightChanged(int newHeightAbove, int newHeightBelow)
Description copied from interface:Field
notifies field that the rowHeight changed- Specified by:
rowHeightChanged
in interfaceField
- Parameters:
newHeightAbove
- the height above the baselinenewHeightBelow
- the height below the baseline.
-
getText
public java.lang.String getText()
Description copied from interface:Field
Returns a string containing all the text in the field.
-
getTextWithLineSeparators
public java.lang.String getTextWithLineSeparators()
Description copied from interface:Field
Returns a string containing all the text in the field with extra linefeeds- Specified by:
getTextWithLineSeparators
in interfaceField
- Returns:
-
textOffsetToScreenLocation
public RowColLocation textOffsetToScreenLocation(int textOffset)
Description copied from interface:Field
Returns the row, column position for an offset into the string returned by getText().- Specified by:
textOffsetToScreenLocation
in interfaceField
- Parameters:
textOffset
- the offset into the entire text string for this field.- Returns:
- a RowColLocation that contains the row,column location in the field for a position in the overall field text.
-
screenLocationToTextOffset
public int screenLocationToTextOffset(int row, int col)
Description copied from interface:Field
Returns the text offset in the overall field text string for the given row and column.- Specified by:
screenLocationToTextOffset
in interfaceField
- Parameters:
row
- the row.col
- the column.
-
-