gov.virginia.dcjs.gui
Interface ApplicationLayout

All Known Implementing Classes:

ApplicationLayoutAdapter, GuiClient

public interface ApplicationLayout

Implementors of this interface enable ApplicationGUIs * to custom build themselves to suit the implementor's purpose.

Field Summary

static int	DATAENTRY Pertaining to an editable parent/child view of data
static int	GRID Pertaining to a Read Only grid of data
static int	READONLY Pertaining to a Read Only dialog box of Record data
static int	RESIZABLE Specifies that a column has a resizable width
static int	ROW Pertaining to an editable dialog box of Record data

Method Summary

java.lang.String[]	getButtonCaptions() Obtain the button captions for the main button panel.
java.lang.String[]	getButtonCaptions(int dialog) Obtain the button captions for the specified dialog button panel.
int	getButtonsTall() Obtain the quantity of buttons to appear in a single column of * the main button panel.
int	getButtonsTall(int dialog) Obtain the quantity of buttons to appear in a single column of * the specified dialog button panel.
java.lang.String	getButtonTitle() Obtain the title for the main button panel.
java.lang.String	getButtonTitle(int dialog) Obtain the title for the specified dialog button panel.
java.lang.String[]	getGridCaptions() Obtain the grid captions for the main panel.
java.lang.String[]	getGridCaptions(int dialog) Obtain the grid captions for the specified dialog.
java.lang.String[]	getGridColumns() Obtain fields to display by Relation field * names within the main grid.
java.lang.String[]	getGridColumns(int dialog) Obtain fields to display by Relation field * names within the dialog's grid.
int[]	getGridColumnWidths() Obtain column widths for each column within the main grid.
int[]	getGridColumnWidths(int dialog) Obtain column widths for each column within the dialog grid.
GridRowMetaData	getGridRowMetaData() Obtain the meta data for each field in a complete record to be * displayed in the main panel.
GridRowMetaData	getGridRowMetaData(int dialog) Obtain the meta data for each field of a data entry row to be * displayed in the specified dialog box.
java.lang.String	getGridTitle() Obtain the title for the main grid panel.
java.lang.String	getGridTitle(int dialog) Obtain the title for the specified dialog grid panel.
int	getKeyIndex() Obtain the 1-based grid index of the main grid data column * containing the data key.
int	getKeyIndex(int dialog) Obtain the 1-based grid index of the dialog grid data column * containing the data key.
java.lang.String	getRowTitle() Obtain the title for the main panel's grid row.
java.lang.String	getRowTitle(int dialog) Obtain the title for the specified dialog's grid row.
int	getSortIndex() Obtain the index of the 1-based main grid data column * to sort on.
int	getSortIndex(int dialog) Obtain the index of the specified dialog grid data column * to sort on.
java.lang.String	getTitle() Obtain the title for the main panel.
java.lang.String	getTitle(int dialog) Obtain the title for the specified dialog panel.

Field Detail

READONLY

public static final int READONLY

Pertaining to a Read Only dialog box of Record data

See Also:

Constant Field Values

ROW

public static final int ROW

Pertaining to an editable dialog box of Record data

See Also:

Constant Field Values

GRID

public static final int GRID

Pertaining to a Read Only grid of data

See Also:

Constant Field Values

DATAENTRY

public static final int DATAENTRY

Pertaining to an editable parent/child view of data

See Also:

Constant Field Values

RESIZABLE

public static final int RESIZABLE

Specifies that a column has a resizable width

See Also:

Constant Field Values

Method Detail

getTitle

public java.lang.String getTitle()

Obtain the title for the main panel. * @return Title for the main panel.

getTitle

public java.lang.String getTitle(int dialog)

Obtain the title for the specified dialog panel. * @param dialog Dialog specific identifier. One of this class' constants. * @return Title for the specified dialog panel.

getGridTitle

public java.lang.String getGridTitle()

Obtain the title for the main grid panel. * @return Title for the main grid panel.

getGridTitle

public java.lang.String getGridTitle(int dialog)

Obtain the title for the specified dialog grid panel. * @param dialog Dialog specific identifier. One of this class' constants. * @return Title for the dialog grid panel.

getRowTitle

public java.lang.String getRowTitle()

Obtain the title for the main panel's grid row. * @return Title for the grid row panel.

getRowTitle

public java.lang.String getRowTitle(int dialog)

Obtain the title for the specified dialog's grid row. * @param dialog Dialog specific identifier. One of this class' constants. * @return Title for the dialog grid row panel.

getButtonTitle

public java.lang.String getButtonTitle()

Obtain the title for the main button panel. * @return Title for the main button panel.

getButtonTitle

public java.lang.String getButtonTitle(int dialog)

Obtain the title for the specified dialog button panel. * @param dialog Dialog specific identifier. One of this class' constants. * @return Title for the dialog button panel.

getButtonCaptions

public java.lang.String[] getButtonCaptions()

Obtain the button captions for the main button panel. * @return Button captions for the main button panel.

getButtonCaptions

public java.lang.String[] getButtonCaptions(int dialog)

Obtain the button captions for the specified dialog button panel. * @param dialog Dialog specific identifier. One of this class' constants. * @return Button captions for the dialog button panel.

getButtonsTall

public int getButtonsTall()

Obtain the quantity of buttons to appear in a single column of * the main button panel. * @return Quantity of buttons to appear in a single column of * buttons on the main button panel.

getButtonsTall

public int getButtonsTall(int dialog)

Obtain the quantity of buttons to appear in a single column of * the specified dialog button panel. * @param dialog Dialog specific identifier. One of this class' constants. * @return Quantity of buttons to appear in a single column of * buttons on the dialog button panel.

getGridCaptions

public java.lang.String[] getGridCaptions()

Obtain the grid captions for the main panel. * @return Grid captions for the main panel.

getGridCaptions

public java.lang.String[] getGridCaptions(int dialog)

Obtain the grid captions for the specified dialog. * @param dialog Dialog specific identifier. One of this class' constants. * @return Grid captions for the dialog.

getGridColumns

public java.lang.String[] getGridColumns()

Obtain fields to display by Relation field * names within the main grid. * @return Field names to be displayed in main grid.

getGridColumns

public java.lang.String[] getGridColumns(int dialog)

Obtain fields to display by Relation field * names within the dialog's grid. * @param dialog Dialog specific identifier. One of this class' constants. * @return Field names to be displayed in dialog grid.

getGridColumnWidths

public int[] getGridColumnWidths()

Obtain column widths for each column within the main grid. * @return Column widths for each column in the main grid.

getGridColumnWidths

public int[] getGridColumnWidths(int dialog)

Obtain column widths for each column within the dialog grid. * @param dialog Dialog specific identifier. One of this class' constants. * @return Column widths for each column in the dialog grid.

getGridRowMetaData

public GridRowMetaData getGridRowMetaData()

Obtain the meta data for each field in a complete record to be * displayed in the main panel. * @return Meta data object controlling record fields display.

getGridRowMetaData

public GridRowMetaData getGridRowMetaData(int dialog)

Obtain the meta data for each field of a data entry row to be * displayed in the specified dialog box. * @param dialog Dialog specific identifier. One of this class' constants. * @return Meta data object controlling record fields display within * a dialog box.

getSortIndex

public int getSortIndex()

Obtain the index of the 1-based main grid data column * to sort on. * @return Field grid column index to sort by.

getSortIndex

public int getSortIndex(int dialog)

Obtain the index of the specified dialog grid data column * to sort on. * @param dialog Dialog specific identifier. One of this class' constants. * @return Field grid column index to sort by.

getKeyIndex

public int getKeyIndex()

Obtain the 1-based grid index of the main grid data column * containing the data key. * @return Field grid column index containing the row key.

getKeyIndex

public int getKeyIndex(int dialog)

Obtain the 1-based grid index of the dialog grid data column * containing the data key. * @param dialog Dialog specific identifier. One of this class' constants. * @return Field grid column index containing the row key.