Class ECTableCustomizerDialog
- 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
-
- 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.TrayDialog 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 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 interface ro.sync.ecss.extensions.commons.table.operations.TableCustomizerConstants
CALS_WIDTHS_SPECIFICATIONS, CENTER, CHAR, COLS_DYNAMIC, COLS_FIXED, COLS_PROPORTIONAL, DITA_CONREF, 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 ECTableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModelRadio, boolean showChoiceTableDialog, boolean isCalsTable, boolean isSimpleOrHtmlTable, boolean innerCalsTable, boolean isPropertiesTableAccepted, boolean isPropertiesTableModel, boolean hasRowsep, boolean hasColsep, boolean hasAlign, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor.ECTableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModelRadio, boolean showChoiceTableDialog, boolean isCalsTable, boolean innerCalsTable, boolean hasRowsep, boolean hasColsep, boolean hasAlign, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor.ECTableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModelRadio, boolean showChoiceTableDialog, boolean innerCalsTable, boolean hasRowsep, boolean hasColsep, boolean hasAlign, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor for TrangDialog.ECTableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModelRadio, boolean innerCalsTable, boolean hasRowsep, boolean hasColsep, boolean hasAlign, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor.ECTableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
configureShell(org.eclipse.swt.widgets.Shell newShell)
Configure Shell.protected void
createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)
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.lang.String[]
getAlignValues(int tableModelType)
Compute the possible values for'align'
attribute.protected abstract java.lang.String[]
getColsepValues(int tableModelType)
Compute the possible values for'colsep'
attribute.protected abstract java.util.List<TableCustomizerConstants.ColumnWidthsType>
getColumnWidthsSpecifications(int tableModelType)
Compute the possible values for the column widths specifications.protected abstract java.lang.String
getDefaultAlignValue(int tableModelType)
Get the default align value.protected abstract java.lang.String
getDefaultColsepValue(int tableModelType)
Get the default column separator value.protected abstract java.lang.String
getDefaultFrameValue(int tableModelType)
Get the default frame value.protected abstract java.lang.String
getDefaultRowsepValue(int tableModelType)
Get the default row separator value.protected abstract java.lang.String[]
getFrameValues(int tableModelType)
Compute the possible values for'frame'
attribute.protected java.lang.String
getHelpPageID()
Get the ID of the help page which will be called by the end user.protected abstract java.lang.String[]
getRowsepValues(int tableModelType)
Compute the possible values for'rowsep'
attribute.TableInfo
showDialog(TableInfo tableInfo)
Show the dialog to customize the table attributes.-
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
-
-
-
-
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(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor.- Parameters:
authorAccess
- The Author access.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(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModelRadio, boolean innerCalsTable, boolean hasRowsep, boolean hasColsep, boolean hasAlign, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor.- Parameters:
authorAccess
- The Author access.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.showSimpleModelRadio
-true
to show the simple model radio in the model chooser.innerCalsTable
-true
if this is an inner calls table.hasRowsep
-true
if the table has rowsep attribute. Flag used to add a corresponding combo box in the dialog.hasColsep
-true
if the table has colsep attribute. Flag used to add a corresponding combo box in the dialog.hasAlign
-true
if the table has align attribute. Flag used to add a corresponding combo box in the dialog.authorResourceBundle
- The author resource bundle.predefinedRowsCount
- The predefined number of rows.predefinedColumnsCount
- The predefined number of columns.
-
ECTableCustomizerDialog
public ECTableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModelRadio, boolean showChoiceTableDialog, boolean innerCalsTable, boolean hasRowsep, boolean hasColsep, boolean hasAlign, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor for TrangDialog.- Parameters:
authorAccess
- The Author access.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.showSimpleModelRadio
-true
to show the simple model radio in the model chooser.showChoiceTableDialog
-true
to show the dialog for choice table.innerCalsTable
-true
if this is an inner calls table.hasRowsep
-true
if the table has rowsep attribute. Flag used to add a corresponding combo box in the dialog.hasColsep
-true
if the table has colsep attribute. Flag used to add a corresponding combo box in the dialog.hasAlign
-true
if the table has align attribute. Flag used to add a corresponding combo box in the dialog.authorResourceBundle
- The author resource bundle.predefinedRowsCount
- The predefined number of rows.predefinedColumnsCount
- The predefined number of columns.
-
ECTableCustomizerDialog
public ECTableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModelRadio, boolean showChoiceTableDialog, boolean isCalsTable, boolean innerCalsTable, boolean hasRowsep, boolean hasColsep, boolean hasAlign, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor.- Parameters:
authorAccess
- The Author access.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.showSimpleModelRadio
-true
to show the simple model radio in the model chooser.showChoiceTableDialog
-true
to show the dialog for choice table.isCalsTable
-true
if the table model is CALS.innerCalsTable
-true
if this is an inner calls table.hasRowsep
-true
if the table has rowsep attribute. Flag used to add a corresponding combo box in the dialog.hasColsep
-true
if the table has colsep attribute. Flag used to add a corresponding combo box in the dialog.hasAlign
-true
if the table has align attribute. Flag used to add a corresponding combo box in the dialog.authorResourceBundle
- The author resource bundle.predefinedRowsCount
- The predefined number of rows.predefinedColumnsCount
- The predefined number of columns.
-
ECTableCustomizerDialog
public ECTableCustomizerDialog(AuthorAccess authorAccess, org.eclipse.swt.widgets.Shell parentShell, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean showSimpleModelRadio, boolean showChoiceTableDialog, boolean isCalsTable, boolean isSimpleOrHtmlTable, boolean innerCalsTable, boolean isPropertiesTableAccepted, boolean isPropertiesTableModel, boolean hasRowsep, boolean hasColsep, boolean hasAlign, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
Constructor.- Parameters:
authorAccess
- The Author access.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.showSimpleModelRadio
-true
to show the simple model radio in the model chooser.showChoiceTableDialog
-true
to show the dialog for choice table.isCalsTable
-true
if the table model is CALS.isSimpleOrHtmlTable
-true
if the table model is simple or HTML.innerCalsTable
-true
if this is an inner calls table.isPropertiesTableAccepted
-true
of a properties table is accepted.isPropertiesTableModel
-true
if the current table has a properties table model.hasRowsep
-true
if the table has rowsep attribute. Flag used to add a corresponding combo box in the dialog.hasColsep
-true
if the table has colsep attribute. Flag used to add a corresponding combo box in the dialog.hasAlign
-true
if the table has align attribute. Flag used to add a corresponding combo box in the dialog.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 classorg.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 classorg.eclipse.jface.dialogs.Dialog
- Parameters:
parent
- The parent composite.- Returns:
- The dialog control.
-
getFrameValues
protected abstract java.lang.String[] getFrameValues(int tableModelType)
Compute the possible values for'frame'
attribute.- 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.
-
getRowsepValues
protected abstract java.lang.String[] getRowsepValues(int tableModelType)
Compute the possible values for'rowsep'
attribute.- 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.
-
getColsepValues
protected abstract java.lang.String[] getColsepValues(int tableModelType)
Compute the possible values for'colsep'
attribute.- 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.
-
getAlignValues
protected abstract java.lang.String[] getAlignValues(int tableModelType)
Compute the possible values for'align'
attribute.- 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.
-
getDefaultFrameValue
protected abstract java.lang.String getDefaultFrameValue(int tableModelType)
Get the default frame value.- 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
-
getDefaultRowsepValue
protected abstract java.lang.String getDefaultRowsepValue(int tableModelType)
Get the default row separator value.- 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
-
getDefaultColsepValue
protected abstract java.lang.String getDefaultColsepValue(int tableModelType)
Get the default column separator value.- 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
-
getDefaultAlignValue
protected abstract java.lang.String getDefaultAlignValue(int tableModelType)
Get the default align value.- 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
-
getColumnWidthsSpecifications
protected abstract java.util.List<TableCustomizerConstants.ColumnWidthsType> getColumnWidthsSpecifications(int tableModelType)
Compute the possible values for the column widths specifications.- 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.
-
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 parentComposite
.- 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.
-
createButtonsForButtonBar
protected void createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)
- Overrides:
createButtonsForButtonBar
in classorg.eclipse.jface.dialogs.Dialog
- See Also:
Dialog.createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)
-
getHelpPageID
protected java.lang.String getHelpPageID()
Get the ID of the help page which will be called by the end user.- Returns:
- the ID of the help page which will be called by the end user or
null
.
-
-