Listblock (g9 Swing 2.9.0 API)

```
public interface Listblock
```
Methods available to all listblocks.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List`	`allLines()` Returns a list of ListblockLine containing all lines in the listblock.
`boolean`	`callHooksBeforeInsert(ListblockLine line)` Forwards call to the hook method before insert.
`boolean`	`checkForeignNodes()` Returns the boolean value of the checkForeignNodes property.
`void`	`clearEditFields()` Recursivly clears the edit fields of this table.
`void`	`clearSelectedLines()` Unselects any selected line from the listblock.
`ListblockLine`	`findInList(Object domainObject)` Returns the line that keeps an instance of the specified domain object, or `null` if no such line is found.
`void`	`forceClean()` Marks all lines as not deleted, changed or new, without copying of old data
`List`	`getAsHTMLTable(int maxRows, boolean incHidden, Set excludedColumns, Map tagOptions)` Returns a list of strings with the data in the listblock as html tables.
`List`	`getChangedLines()` Returns a list of ListblockLine containing the changed lines in the listblock.
`int`	`getLastRowLine()` Returns the last row in the listblock
`ListblockLine`	`getLine(int rowIndex)` Returns the listblock line with the specified row number, or `null` if no such row exists.
`ListblockLine`	`getNewListblockLine()` Returns a new list block line object.
`Set`	`getRoleNamesInUse()` Returns the set of role names displayed by the listblock.
`int`	`getSelectedLine()` Returns the position of the selected line in the list.
`int[]`	`getSelectedLines()` Returns a list of indexes of all selected lines in the list.
`List`	`getSelectedLinesObject()` Returns a list containig the selected lines.
`G9Table`	`getTable()` Returns the G9Table responsible for displaying this table
`boolean`	`hasFocus()` Returns true if the component is focused.
`void`	`hideColumn(List attributeNames)` Hides the specified colunms.
`void`	`hideColumn(String attributeName)` Hides the specified column.
`void`	`insertNewListblockLine(ListblockLine listBlockLine)` Inserts a listblock line at the end of the list block.
`void`	`makeRowVisible(int row)` Scrolls the listblock to make sure that a given row is shown to the user.
`List`	`obtainChangedLines()` Gets the obtained version of all changed lines.
`void`	`purgeAllLines()` Purges all lines from the list block.
`void`	`requestFocus()` Request focus to this component.
`void`	`setCheckForeignNodes(Boolean doCheck)` Set the checkForeginNode property.
`void`	`setColumnHeaderValue(String attributeName, String value)` Sets the header value of the specified column.
`void`	`setListblockEditing(boolean f)` Set or enables listblock editing within the listblock (has hidden edit fields).
`void`	`setPopupMenu(String menuName)` Sets which popup menu to be used for this listblock.
`void`	`setSelectedLine(int line)` Selects a line in the list.
`void`	`setSelectedLine(ListblockLine line)` Selects a line in the list.
`void`	`setSelectedLines(int[] lines)` Selects a set of lines in the list.
`void`	`setUpdateWhenManipulated(boolean f)` Setting update when manipulated to false will not make the GUI update itself when the data in the listblock is modified using insert/update/delete calls.
`void`	`showColumn(List attributeNames)` Shows the specified columns.
`void`	`showColumn(String attributeName)` Shows the specified column.
`int`	`size()` Returns number of lines in the listblock, regardless of the listblocklines status.

- Method Detail
  - getAsHTMLTable
```
List getAsHTMLTable(int maxRows,
                    boolean incHidden,
                    Set excludedColumns,
                    Map tagOptions)
```
    Returns a list of strings with the data in the listblock as html tables.
    
    Parameters:
    
    maxRows - The number of rows in the listblock for a split.
    
    incHidden - If true, the table will Include hidden fields in output.
    
    excludedColumns - String set of columns to be excloded. They must be on the form "objselection.attribute"
    
    tagOptions - A map containing the following keys: TH - Added to each TH. TD - Added to each TD. TABLE - added to table tag. TR - added to each TR.
    
    Returns:
    
    Complete html.
  - setUpdateWhenManipulated
```
void setUpdateWhenManipulated(boolean f)
```
    Setting update when manipulated to false will not make the GUI update itself when the data in the listblock is modified using insert/update/delete calls. When data is beeing bulk loaded into the datastructure, it might be preferably to call setUpdateWhenManipulated(false) prior to inserting data and call setUpdateWhenManipulated(true) afterwards. A normal use of would be:
```
    listblockMethodsObj.setUpdateWhenManipulated(false);
    ...do all inserts
    listblockMethodsObj.setUpdateWhenManipulated(true);
    listblockMethodsObj.forceClean();
 
```
    Parameters:
    
    f - Default setting is true.
  - size
```
int size()
```
    Returns number of lines in the listblock, regardless of the listblocklines status.
    
    Returns:
    
    Number of elements.
  - setPopupMenu
```
void setPopupMenu(String menuName)
```
    Sets which popup menu to be used for this listblock. It is required that the dialog had a popup menu to start with. If argument sent in is the empty string, the the popup menu will be disabled. (Same effect will occure if the menuName is not a valid popup name.)
    
    Parameters:
    
    menuName - The menu name to use.
  - hasFocus
```
boolean hasFocus()
```
    Returns true if the component is focused.
    
    Returns:
    
    True if component has focus, false if not.
  - requestFocus
```
void requestFocus()
```
    Request focus to this component. It is not granted that this component will be granted the focus after this call.
  - getLastRowLine
```
int getLastRowLine()
```
    Returns the last row in the listblock
    
    Returns:
    
    The row number, Index starting at 0.
  - setListblockEditing
```
void setListblockEditing(boolean f)
```
    Set or enables listblock editing within the listblock (has hidden edit fields). Only valid if it was editable in the first place).
    
    Parameters:
    
    f - If true, the listblock may be edited in, if false, editing is disabled.
  - makeRowVisible
```
void makeRowVisible(int row)
```
    Scrolls the listblock to make sure that a given row is shown to the user.
    
    Parameters:
    
    row - The row number, starting with Index 0.
  - getRoleNamesInUse
```
Set getRoleNamesInUse()
```
    Returns the set of role names displayed by the listblock.
    
    Returns:
    
    a Set containing role names displayable by the listblock.
  - insertNewListblockLine
```
void insertNewListblockLine(ListblockLine listBlockLine)
```
    Inserts a listblock line at the end of the list block.
    
    Parameters:
    
    listBlockLine - the line to insert.
  - getNewListblockLine
```
ListblockLine getNewListblockLine()
```
    Returns a new list block line object. The returned object is initially empty.
    
    Returns:
    
    an empty list block line.
  - callHooksBeforeInsert
```
boolean callHooksBeforeInsert(ListblockLine line)
```
    Forwards call to the hook method before insert.
    
    Parameters:
    
    line - - listblock line to insert
    
    Returns:
    
    true if the line should be inserted.
  - getChangedLines
```
List getChangedLines()
```
    Returns a list of ListblockLine containing the changed lines in the listblock.
    
    Returns:
    
    a List of changed list block lines
  - obtainChangedLines
```
List obtainChangedLines()
```
    Gets the obtained version of all changed lines.
    
    Returns:
    
    a List of changed lines with updated values.
  - allLines
```
List allLines()
```
    Returns a list of ListblockLine containing all lines in the listblock.
    
    Returns:
    
    a List with all list block lines
  - forceClean
```
void forceClean()
```
    Marks all lines as not deleted, changed or new, without copying of old data
  - purgeAllLines
```
void purgeAllLines()
```
    Purges all lines from the list block.
  - clearSelectedLines
```
void clearSelectedLines()
```
    Unselects any selected line from the listblock.
  - getSelectedLine
```
int getSelectedLine()
```
    Returns the position of the selected line in the list.
    
    Returns:
    
    The row number of the selected line, or -1 if no lines are selected.
  - getSelectedLinesObject
```
List getSelectedLinesObject()
```
    Returns a list containig the selected lines.
    
    Returns:
    
    a List of selected ListblockLines.
  - getSelectedLines
```
int[] getSelectedLines()
```
    Returns a list of indexes of all selected lines in the list.
    
    Returns:
    
    An array of integers containing the indices of all selected lines, or an empty array if no lines are selected.
  - setSelectedLine
```
void setSelectedLine(int line)
```
    Selects a line in the list. The previous selection is cleared.
    
    Parameters:
    
    line - The row to select.
  - setSelectedLine
```
void setSelectedLine(ListblockLine line)
```
    Selects a line in the list. The previous selection is cleared.
    
    Parameters:
    
    line - The row to select.
  - setSelectedLines
```
void setSelectedLines(int[] lines)
```
    Selects a set of lines in the list. The previous selection is cleared.
    
    Parameters:
    
    lines - An array of integers containing the indices of all lines to select.
  - getTable
```
G9Table getTable()
```
    Returns the G9Table responsible for displaying this table
    
    Returns:
    
    the G9Table displaying this table's data.
  - hideColumn
```
void hideColumn(String attributeName)
```
    Hides the specified column. If the column is already hidden, nothing happens.
    
    Parameters:
    
    attributeName - a String denoting the fully qualified attribute name, e.g. "roleName.attr"
    
    Throws:
    
    G9ClientException - if the specified column does not exist.
  - hideColumn
```
void hideColumn(List attributeNames)
```
    Hides the specified colunms.
    
    Parameters:
    
    attributeNames - a List of attribute names of columns to hide.
    
    Throws:
    
    G9ClientException - if the specified column does not exist.
    
    See Also:
    
    hideColumn(String)
  - showColumn
```
void showColumn(String attributeName)
```
    Shows the specified column. If the column is already visible, nothing happens.
    
    Parameters:
    
    attributeName - a String denoting the fully qualified attribute name, e.g. "roleName.attr"
    
    Throws:
    
    G9ClientException - if the specified column does not exist.
  - showColumn
```
void showColumn(List attributeNames)
```
    Shows the specified columns.
    
    Parameters:
    
    attributeNames - a List of attribute names of columns to hide.
    
    Throws:
    
    G9ClientException - if the specified column does not exist.
    
    See Also:
    
    showColumn(String)
  - setColumnHeaderValue
```
void setColumnHeaderValue(String attributeName,
                          String value)
```
    Sets the header value of the specified column. The header value is the object use to display the header (typically a String).
    
    Parameters:
    
    attributeName - a String denoting the fully qualified attribute name, e.g. "roleName.attr"
    
    value - the header value.
    
    Throws:
    
    G9ClientException - if the specified column does not exist.
  - clearEditFields
```
void clearEditFields()
```
    Recursivly clears the edit fields of this table.
  - findInList
```
ListblockLine findInList(Object domainObject)
```
    Returns the line that keeps an instance of the specified domain object, or null if no such line is found. The search is performed from the top of the listblock, and returns immediately if a match is found.
    
    Parameters:
    
    domainObject - the domain object to search for
    
    Returns:
    
    the line holding the domain object or null if no such line is found.
  - setCheckForeignNodes
```
void setCheckForeignNodes(Boolean doCheck)
```
    Set the checkForeginNode property. If the doCheck parameter differs from null the global checkForeingNode property is overridden for this Listblock instance, and the overridden value will be used when checkRowSelect method on the listblock role's node determines which nodes to check. In order to use the application's checkForegingNode property, pass a null-reference to this method.
    
    Parameters:
    
    doCheck - the value of the checkForeginNodes property.
    
    See Also:
    
    checkForeignNodes(), ApplicationMethods.setCheckForeignNodes(boolean), ApplicationMethods.checkForeignNodes()
  - checkForeignNodes
```
boolean checkForeignNodes()
```
    Returns the boolean value of the checkForeignNodes property. If the property is not set, the application's value is returned.
    
    Returns:
    
    the value of the checkForeignNodes property.
    
    See Also:
    
    setCheckForeignNodes(Boolean), ApplicationMethods.setCheckForeignNodes(boolean), ApplicationMethods.checkForeignNodes()
  - getLine
```
ListblockLine getLine(int rowIndex)
```
    Returns the listblock line with the specified row number, or null if no such row exists.
    
    Parameters:
    
    rowIndex - the row index
    
    Returns:
    
    the listblock line with the specified index.

Interface Listblock

Method Summary

Method Detail

getAsHTMLTable

setUpdateWhenManipulated

size

setPopupMenu

hasFocus

requestFocus

getLastRowLine

setListblockEditing

makeRowVisible

getRoleNamesInUse

insertNewListblockLine

getNewListblockLine

callHooksBeforeInsert

getChangedLines

obtainChangedLines

allLines

forceClean

purgeAllLines

clearSelectedLines

getSelectedLine

getSelectedLinesObject

getSelectedLines

setSelectedLine

setSelectedLine

setSelectedLines

getTable

hideColumn

hideColumn

showColumn

showColumn

setColumnHeaderValue

clearEditFields

findInList

setCheckForeignNodes

checkForeignNodes

getLine