ro.sync.ecss.extensions.commons.table.operations

Class ECTableCustomizerDialog

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

ro.sync.ecss.extensions.commons.table.operations.ECTableCustomizerDialog

All Implemented Interfaces:

org.eclipse.jface.window.IShellProvider, TableCustomizerConstants

Direct Known Subclasses:

ECDITARelTableCustomizerDialog, ECDITATableCustomizerDialog, ECDocbookTableCustomizerDialog, ECTEITableCustomizerDialog, ECXHTMLTableCustomizerDialog

@API(type=INTERNAL,
     src=PUBLIC)
public abstract class ECTableCustomizerDialog
extends org.eclipse.jface.dialogs.Dialog
implements TableCustomizerConstants

Dialog used to customize the insertion of a generic table (number of rows, columns, table caption). It is used on Eclipse platform implementation.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

org.eclipse.jface.window.Window.IExceptionHandler

Nested classes/interfaces inherited from interface ro.sync.ecss.extensions.commons.table.operations.TableCustomizerConstants

TableCustomizerConstants.ColumnWidthsType

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorResourceBundle	authorResourceBundle Author resource bundle.
protected TableCustomizerConstants.ColumnWidthsType	selectedColWidthsType The selected column widths type

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.TableCustomizerConstants

CALS_WIDTHS_SPECIFICATIONS, COLS_DYNAMIC, COLS_FIXED, COLS_PROPORTIONAL, FIXED_COL_WIDTH_DEFAULT_VALUE, FRAME_ABOVE, FRAME_ALL, FRAME_BELLOW, FRAME_BORDER, FRAME_BOTTOM, FRAME_BOX, FRAME_HSIDES, FRAME_LHS, FRAME_NONE, FRAME_RHS, FRAME_SIDES, FRAME_TOP, FRAME_TOPBOT, FRAME_UNSPECIFIED, FRAME_VOID, FRAME_VSIDES, HTML_WIDTHS_SPECIFICATIONS, REL_COL_WIDTH_DEFAULT_VALUE, SIMPLE_WIDTHS_SPECIFICATIONS

Constructor Summary

Constructors

Constructor and Description
ECTableCustomizerDialog(org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount) Constructor for TrangDialog.
ECTableCustomizerDialog(org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModel, boolean innerCalsTable, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount) Constructor for TrangDialog.
ECTableCustomizerDialog(org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModel, boolean showChoiceTable, boolean innerCalsTable, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount) Constructor for TrangDialog.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureShell(org.eclipse.swt.widgets.Shell newShell) Configure Shell.
protected org.eclipse.swt.widgets.Control	createDialogArea(org.eclipse.swt.widgets.Composite parent) Create Dialog area.
protected abstract org.eclipse.swt.widgets.Button	createTitleCheckbox(org.eclipse.swt.widgets.Composite parent) Create a checkbox with an implementation specific title.
protected abstract java.util.List<TableCustomizerConstants.ColumnWidthsType>	getColumnWidthsSpecifications(int tableModel) Compute the possible values for the column widths specifications.
protected abstract java.lang.String	getDefaultFrameValue(int tableModel) Get the default frame value.
protected abstract java.lang.String[]	getFrameValues(int tableModel) Compute the possible values for 'frame' attribute.
TableInfo	showDialog(TableInfo tableInfo) Show the dialog to customize the table attributes.

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, buttonPressed, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonBar, createButtonsForButtonBar, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

selectedColWidthsType

protected TableCustomizerConstants.ColumnWidthsType selectedColWidthsType

The selected column widths type

authorResourceBundle

protected final AuthorResourceBundle authorResourceBundle

Author resource bundle.

Constructor Detail

ECTableCustomizerDialog

public ECTableCustomizerDialog(org.eclipse.swt.widgets.Shell parentShell,
                       boolean hasFooter,
                       boolean hasFrameAttribute,
                       boolean showModelChooser,
                       AuthorResourceBundle authorResourceBundle,
                       int predefinedRowsCount,
                       int predefinedColumnsCount)

Constructor for TrangDialog.

Parameters:

parentShell - The parent shell for the dialog.

hasFooter - true if this table supports a footer.

hasFrameAttribute - true if the table has a frame attribute.

showModelChooser - true to show the dialog panel for choosing the table model, one of CALS or HTML.

authorResourceBundle - The author resource bundle.

predefinedRowsCount - The predefined number of rows.

predefinedColumnsCount - The predefined number of columns.

ECTableCustomizerDialog

public ECTableCustomizerDialog(org.eclipse.swt.widgets.Shell parentShell,
                       boolean hasFooter,
                       boolean hasFrameAttribute,
                       boolean showModelChooser,
                       boolean showSimpleModel,
                       boolean innerCalsTable,
                       AuthorResourceBundle authorResourceBundle,
                       int predefinedRowsCount,
                       int predefinedColumnsCount)

Constructor for TrangDialog.

Parameters:

parentShell - The parent shell for the dialog.

hasFooter - true if this table supports a footer.

hasFrameAttribute - true if the table has a frame attribute.

showModelChooser - true to show the dialog panel for choosing the table model, one of CALS or HTML.

showSimpleModel - true to show the simple model radio in the model chooser.

innerCalsTable - true if this is an inner calls table.

authorResourceBundle - The author resource bundle.

predefinedRowsCount - The predefined number of rows.

predefinedColumnsCount - The predefined number of columns.

ECTableCustomizerDialog

public ECTableCustomizerDialog(org.eclipse.swt.widgets.Shell parentShell,
                       boolean hasFooter,
                       boolean hasFrameAttribute,
                       boolean showModelChooser,
                       boolean showSimpleModel,
                       boolean showChoiceTable,
                       boolean innerCalsTable,
                       AuthorResourceBundle authorResourceBundle,
                       int predefinedRowsCount,
                       int predefinedColumnsCount)

Constructor for TrangDialog.

Parameters:

parentShell - The parent shell for the dialog.

hasFooter - true if this table supports a footer.

hasFrameAttribute - true if the table has a frame attribute.

showModelChooser - true to show the dialog panel for choosing the table model, one of CALS or HTML.

showSimpleModel - true to show the simple model radio in the model chooser.

showChoiceTable - true to show the dialog for choice table.

innerCalsTable - true if this is an inner calls table.

authorResourceBundle - The author resource bundle.

predefinedRowsCount - The predefined number of rows.

predefinedColumnsCount - The predefined number of columns.

Method Detail

configureShell

protected void configureShell(org.eclipse.swt.widgets.Shell newShell)

Configure Shell. Set a title to it.

Overrides:

configureShell in class org.eclipse.jface.window.Window

Parameters:

newShell - The new shell.

See Also:

Window.configureShell(org.eclipse.swt.widgets.Shell)

createDialogArea

protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)

Create Dialog area.

Overrides:

createDialogArea in class org.eclipse.jface.dialogs.Dialog

Parameters:

parent - The parent composite.

Returns:

The dialog control.

getFrameValues

protected abstract java.lang.String[] getFrameValues(int tableModel)

Compute the possible values for 'frame' attribute.

Parameters:

tableModel - The table model. One of the constants: TableInfo.TABLE_MODEL_CALS, TableInfo.TABLE_MODEL_CUSTOM, TableInfo.TABLE_MODEL_DITA_SIMPLE, TableInfo.TABLE_MODEL_HTML.

Returns:

Returns the possible values for 'frame' attribute.

getDefaultFrameValue

protected abstract java.lang.String getDefaultFrameValue(int tableModel)

Get the default frame value.

Parameters:

tableModel - The table model.

Returns:

The default frame value

getColumnWidthsSpecifications

protected abstract java.util.List<TableCustomizerConstants.ColumnWidthsType> getColumnWidthsSpecifications(int tableModel)

Compute the possible values for the column widths specifications.

Parameters:

tableModel - The table model. One of the constants: TableInfo.TABLE_MODEL_CALS, TableInfo.TABLE_MODEL_CUSTOM, TableInfo.TABLE_MODEL_DITA_SIMPLE, TableInfo.TABLE_MODEL_HTML.

Returns:

Returns the possible values for the column widths modifications.

createTitleCheckbox

protected abstract org.eclipse.swt.widgets.Button createTitleCheckbox(org.eclipse.swt.widgets.Composite parent)

Create a checkbox with an implementation specific title.

Parameters:

parent - The parent Composite.

Returns:

The title checkbox customized according to implementation.

showDialog

public TableInfo showDialog(TableInfo tableInfo)

Show the dialog to customize the table attributes.

Parameters:

tableInfo -

Returns:

The information about the table to be inserted, or null if the user canceled the table insertion.