Package ro.sync.ecss.extensions.dita.topic.table

Class ECDITATableCustomizerDialog

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

org.eclipse.jface.dialogs.TrayDialog

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

ro.sync.ecss.extensions.dita.topic.table.ECDITATableCustomizerDialog

All Implemented Interfaces:

org.eclipse.jface.window.IShellProvider, TableCustomizerConstants

@API(type=INTERNAL,
     src=PUBLIC)
public class ECDITATableCustomizerDialog
extends ECTableCustomizerDialog

Dialog used to customize DITA table creation. It is used for 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	Description
static final String[]	ALIGN_VALUES	Array with common possible values for alignment.

Fields inherited from class ro.sync.ecss.extensions.commons.table.operations.ECTableCustomizerDialog

authorResourceBundle, selectedColWidthsType

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, resizeHasOccurred

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

CALS_WIDTHS_SPECIFICATIONS, CENTER, CHAR, 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_VOID, FRAME_VSIDES, HTML_WIDTHS_SPECIFICATIONS, JUSTIFY, LEFT, REL_COL_WIDTH_DEFAULT_VALUE, RIGHT, SIMPLE_WIDTHS_SPECIFICATIONS, UNSPECIFIED

Constructor Summary

Constructors

Constructor	Description
ECDITATableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount, boolean insertChoiceTable)	Constructor.
ECDITATableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount, boolean insertChoiceTable, boolean isPropertiesTableAccepted, int defaultTableModel)	Constructor.
ECDITATableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount, boolean insertChoiceTable, int defaultTableModel)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected org.eclipse.swt.widgets.Button	createTitleCheckbox(org.eclipse.swt.widgets.Composite parent)	Create a checkbox with an implementation specific title.
protected String[]	getAlignValues(int tableModelType)	Compute the possible values for 'align' attribute.
protected String[]	getColsepValues(int tableModelType)	Compute the possible values for 'colsep' attribute.
protected List<TableCustomizerConstants.ColumnWidthsType>	getColumnWidthsSpecifications(int tableModelType)	Compute the possible values for the column widths specifications.
protected String	getDefaultAlignValue(int tableModelType)	Get the default align value.
protected String	getDefaultColsepValue(int tableModelType)	Get the default column separator value.
protected String	getDefaultFrameValue(int tableModelType)	Get the default frame value.
protected String	getDefaultRowsepValue(int tableModelType)	Get the default row separator value.
protected String[]	getFrameValues(int tableModelType)	Compute the possible values for 'frame' attribute.
String	getHelpPageID()	Get the ID of the help page which will be called by the end user.
protected String[]	getRowsepValues(int tableModelType)	Compute the possible values for 'rowsep' attribute.

Methods inherited from class ro.sync.ecss.extensions.commons.table.operations.ECTableCustomizerDialog

configureShell, createButtonsForButtonBar, createDialogArea, showDialog

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

closeTray, createButtonBar, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

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

applyDialogFont, buttonPressed, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, 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, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, 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 Details

ALIGN_VALUES

public static final String[] ALIGN_VALUES

Array with common possible values for alignment.

Constructor Details

ECDITATableCustomizerDialog

public ECDITATableCustomizerDialog(AuthorAccess authorAccess,
 org.eclipse.swt.widgets.Shell parentShell,
 AuthorResourceBundle authorResourceBundle,
 int predefinedRowsCount,
 int predefinedColumnsCount,
 boolean insertChoiceTable)

Constructor.

Parameters:

authorAccess - The Author access.

parentShell - The parent Shell.

authorResourceBundle - The author resource bundle.

predefinedRowsCount - The predefined number of rows.

predefinedColumnsCount - The predefined number of columns.

insertChoiceTable - true if should insert a DITA choice table.

ECDITATableCustomizerDialog

public ECDITATableCustomizerDialog(AuthorAccess authorAccess,
 org.eclipse.swt.widgets.Shell parentShell,
 AuthorResourceBundle authorResourceBundle,
 int predefinedRowsCount,
 int predefinedColumnsCount,
 boolean insertChoiceTable,
 int defaultTableModel)

Constructor.

Parameters:

authorAccess - The Author access.

parentShell - The parent Shell.

authorResourceBundle - The author resource bundle.

predefinedRowsCount - The predefined number of rows.

predefinedColumnsCount - The predefined number of columns.

insertChoiceTable - true if should insert a DITA choice table.

defaultTableModel - The default model of the table that will be inserted.

ECDITATableCustomizerDialog

public ECDITATableCustomizerDialog(AuthorAccess authorAccess,
 org.eclipse.swt.widgets.Shell parentShell,
 AuthorResourceBundle authorResourceBundle,
 int predefinedRowsCount,
 int predefinedColumnsCount,
 boolean insertChoiceTable,
 boolean isPropertiesTableAccepted,
 int defaultTableModel)

Constructor.

Parameters:

authorAccess - The Author access.

parentShell - The parent Shell.

authorResourceBundle - The author resource bundle.

predefinedRowsCount - The predefined number of rows.

predefinedColumnsCount - The predefined number of columns.

insertChoiceTable - true if should insert a DITA choice table.

isPropertiesTableAccepted - true if a properties table is accepted by the schema (i.e. if it is a global element).

defaultTableModel - The default model of the table that will be inserted.

Method Details

getColumnWidthsSpecifications

protected List<TableCustomizerConstants.ColumnWidthsType> getColumnWidthsSpecifications(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Compute the possible values for the column widths specifications.

Specified by:

getColumnWidthsSpecifications in class ECTableCustomizerDialog

Parameters:

tableModelType - The table model type. 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.

See Also:

• ECTableCustomizerDialog.getColumnWidthsSpecifications(int)

getFrameValues

protected String[] getFrameValues(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Compute the possible values for 'frame' attribute.

Specified by:

getFrameValues in class ECTableCustomizerDialog

Parameters:

tableModelType - The table model type. 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.

See Also:

• ECTableCustomizerDialog.getFrameValues(int)

createTitleCheckbox

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

Description copied from class: ECTableCustomizerDialog

Create a checkbox with an implementation specific title.

Specified by:

createTitleCheckbox in class ECTableCustomizerDialog

Parameters:

parent - The parent Composite.

Returns:

The title checkbox customized according to implementation.

See Also:

• ECTableCustomizerDialog.createTitleCheckbox(org.eclipse.swt.widgets.Composite)

getDefaultFrameValue

protected String getDefaultFrameValue(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Get the default frame value.

Specified by:

getDefaultFrameValue in class ECTableCustomizerDialog

Parameters:

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

Returns:

The default frame value

See Also:

• ECTableCustomizerDialog.getDefaultFrameValue(int)

getRowsepValues

protected String[] getRowsepValues(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Compute the possible values for 'rowsep' attribute.

Specified by:

getRowsepValues in class ECTableCustomizerDialog

Parameters:

tableModelType - The table model type. 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 'rowsep' attribute.

See Also:

• ECTableCustomizerDialog.getRowsepValues(int)

getColsepValues

protected String[] getColsepValues(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Compute the possible values for 'colsep' attribute.

Specified by:

getColsepValues in class ECTableCustomizerDialog

Parameters:

tableModelType - 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 'colsep' attribute.

See Also:

• ECTableCustomizerDialog.getColsepValues(int)

getDefaultRowsepValue

protected String getDefaultRowsepValue(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Get the default row separator value.

Specified by:

getDefaultRowsepValue in class ECTableCustomizerDialog

Parameters:

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

Returns:

The default row separator value

See Also:

• ECTableCustomizerDialog.getDefaultRowsepValue(int)

getDefaultColsepValue

protected String getDefaultColsepValue(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Get the default column separator value.

Specified by:

getDefaultColsepValue in class ECTableCustomizerDialog

Parameters:

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

Returns:

The default column separator value

See Also:

• ECTableCustomizerDialog.getDefaultColsepValue(int)

getAlignValues

protected String[] getAlignValues(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Compute the possible values for 'align' attribute.

Specified by:

getAlignValues in class ECTableCustomizerDialog

Parameters:

tableModelType - The table model type. 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 'align' attribute.

See Also:

• ECTableCustomizerDialog.getAlignValues(int)

getDefaultAlignValue

protected String getDefaultAlignValue(int tableModelType)

Description copied from class: ECTableCustomizerDialog

Get the default align value.

Specified by:

getDefaultAlignValue in class ECTableCustomizerDialog

Parameters:

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

Returns:

The default align value

See Also:

• ECTableCustomizerDialog.getDefaultAlignValue(int)

getHelpPageID

public String getHelpPageID()

Description copied from class: ECTableCustomizerDialog

Get the ID of the help page which will be called by the end user.

Overrides:

getHelpPageID in class ECTableCustomizerDialog

Returns:

the ID of the help page which will be called by the end user or null.

See Also:

• ECTableCustomizerDialog.getHelpPageID()