no.g9.client.support

Interface ListblockLine

public interface ListblockLine

Common methods for listblock lines.

Method Summary

Modifier and Type	Method and Description
void	addDomainObject(Object domainObject) Adds a domain object to this listblock.
boolean	contains(Object domainObject) Returns true if this line contains the specified instance.
void	displayInEditField() Displays the domain objects contained in this list block line in the edit fields of the listblock.
void	editField(Object type, String fieldName) Deprecated. Use editFieldOS insted.
void	editFieldOS(Object type, String fieldName) Edits cell in the given listblock line, where the object is 'type' (the related object node) and column is 'fieldName' (named in g9).
Collection	getDomainObjects() Deprecated. (missing javadoc)
int	getLineNumber() Internal use!
Listblock	getListblock() Returns the listblock that this line is part of
Object	getObject(String roleName) Deprecated. use getObject(String, boolean)
Object	getObject(String roleName, boolean createIfNull) Returns the roleName object held by this line.
boolean	hasPreviousState() Returns true if there is a previous state stored in the dialog
void	insertObject(String roleName, Object obj) Inserts the @@RoleName@@ object into the listblock line.
boolean	isChanged() Returns true if this line is changed.
boolean	isSelected() Returns the selected state of this line.
ListblockLine	obtain() Obtains all the displayed roles.
Object	obtain(String identifier) Obtains the value specified by identifier.
void	previousState() Copies data from the old set of data (the last reset) to the new "current" set of data.
void	refresh() Updates the UI after modifying a given listblock line.
void	reset() Reset status, and copies values from the new set to the old set of data for this listblock line.
void	setDisabledField(Object owner, String field, boolean setting) Deprecated. Use setDisabledFieldOS.
void	setDisabledFieldOS(Object owner, String field, boolean setting) Disables/enables a given field in the listblock line represented by the object selection node object owner.
void	setSelected(boolean select) Selects or unselects this line, depending on the select value.

Method Detail

editFieldOS

void editFieldOS(Object type,
                 String fieldName)

Edits cell in the given listblock line, where the object is 'type' (the related object node) and column is 'fieldName' (named in g9). The type object is not modified, and onlyused to decide which field is to be edited in thelistblock.

Parameters:

type - The object selection node to use.

fieldName - The fieldname to use.

editField

@Deprecated
void editField(Object type,
                           String fieldName)

Deprecated. Use editFieldOS insted.

Edits cell in the given listblock line, where the object is 'type' and column is 'fieldName'. The type object is not modified, and only used to decide which field is to be edited in the listblock.

Parameters:

type - The object selection to use

fieldName - The field name to use.

hasPreviousState

boolean hasPreviousState()

Returns true if there is a previous state stored in the dialog

Returns:

True if previous state is stored.

previousState

void previousState()

Copies data from the old set of data (the last reset) to the new "current" set of data. Also copies old flags.

See Also:

hasPreviousState()

refresh

void refresh()

Updates the UI after modifying a given listblock line.

reset

void reset()

Reset status, and copies values from the new set to the old set of data for this listblock line.

setDisabledField

@Deprecated
void setDisabledField(Object owner,
                                  String field,
                                  boolean setting)

Deprecated. Use setDisabledFieldOS.

Disables/enables a given field in the listblock line represented by the object owner.field. Only valid if the listblock has hidden listblock lines.

Parameters:

owner - The object to disable.

field - The field to disable.

setting - True if the field should be disabled, false if not.

setDisabledFieldOS

void setDisabledFieldOS(Object owner,
                        String field,
                        boolean setting)

Disables/enables a given field in the listblock line represented by the object selection node object owner. The field name is the field name given in g9.

Parameters:

owner - The object selection to use

field - The field name

setting - True if the field should be disabled, false if not.

addDomainObject

void addDomainObject(Object domainObject)

Adds a domain object to this listblock.

Parameters:

domainObject - (missing javadoc)

getDomainObjects

@Deprecated
Collection getDomainObjects()

Deprecated. (missing javadoc)

Gets a Collection of the objects contained in this line.

Returns:

a Collection of the objects contained in this line.

displayInEditField

void displayInEditField()

Displays the domain objects contained in this list block line in the edit fields of the listblock.

getListblock

Listblock getListblock()

Returns the listblock that this line is part of

Returns:

the listblock

getLineNumber

int getLineNumber()

Internal use!

Returns:

the line number of this line.

insertObject

void insertObject(String roleName,
                  Object obj)

Inserts the @@RoleName@@ object into the listblock line.

Parameters:

roleName - the role name of the object

obj - the object to insert.

getObject

@Deprecated
Object getObject(String roleName)

Deprecated. use getObject(String, boolean)

Returns the roleName object held by this line. If the object does not exist a new object is created.

Parameters:

roleName - the role name of the object to return

Returns:

the object held by this line.

getObject

Object getObject(String roleName,
                 boolean createIfNull)

Returns the roleName object held by this line. If the second parameter is true and the line does not hold a reference to the object, a new instance is created using the default constructor.

Parameters:

roleName - the role name of the object

createIfNull - flag indicating if missing object should be created

Returns:

the object held by this line.

contains

boolean contains(Object domainObject)

Returns true if this line contains the specified instance.

Parameters:

domainObject - the domain object possibly present in this line

Returns:

true if this line contains the object.

setSelected

void setSelected(boolean select)

Selects or unselects this line, depending on the select value.

If select is true this line is selected, and displayed in the edit fields.

If select is false, the line is unselected. If no other line is selected, the edit fields are cleared, otherwise, the first selected line (starting from the top of the listblock) is displayed in the edit fields.

Note that invoking this method does not fire a selected event, nor does it issue a warning if the edit fields are changed prior to selection.

Parameters:

select - if true selects this line, otherwise unselects this line.

isSelected

boolean isSelected()

Returns the selected state of this line.

Returns:

true if the line is selected.

isChanged

boolean isChanged()

Returns true if this line is changed. Only applies to listblocks with inline editing.

Returns:

true if this line is changed.

obtain

Object obtain(String identifier)

Obtains the value specified by identifier. If it is an attribute name (e.g. "foo.bar") the displayed value from the corresponding column is returned. Otherwise, if it is a role name, the domain object (corresponding to the role) is updated with the displayed values, and then returned.

Parameters:

identifier - the name of the role or field name

Returns:

the obtained value

obtain

ListblockLine obtain()

Obtains all the displayed roles. Each domain instance is updated with the displayed values and the line is returned.

Returns:

the obtained listblock line.