Oxygen XML Editor 14.2 Author API

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

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by ro.sync.exml.workspace.api.standalone.ui.OKCancelDialog
                          extended by ro.sync.ecss.extensions.commons.ui.OKCancelDialog
                              extended by ro.sync.ecss.extensions.commons.table.operations.SATableCustomizerDialog
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, TableCustomizerConstants
Direct Known Subclasses:
SADITARelTableCustomizerDialog, SADITATableCustomizerDialog, SADocbookTableCustomizerDialog, SATEITableCustomizerDialog, SAXHTMLTableCustomizerDialog

@API(type=INTERNAL,
     src=PUBLIC)
public abstract class SATableCustomizerDialog
extends OKCancelDialog
implements TableCustomizerConstants

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

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Nested classes/interfaces inherited from interface ro.sync.ecss.extensions.commons.table.operations.TableCustomizerConstants
TableCustomizerConstants.ColumnWidthsType
 
Field Summary
protected  AuthorResourceBundle authorResourceBundle
          Author resource bundle.
 
Fields inherited from class ro.sync.exml.workspace.api.standalone.ui.OKCancelDialog
messages, RESULT_CANCEL, RESULT_OK
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Dialog
DEFAULT_MODALITY_TYPE
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
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
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
SATableCustomizerDialog(java.awt.Frame parentFrame, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
          Constructor.
SATableCustomizerDialog(java.awt.Frame parentFrame, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean simpleTableModel, boolean innerCallsTable, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
          Constructor.
SATableCustomizerDialog(java.awt.Frame parentFrame, boolean hasFooter, boolean hasFrameAttribute, boolean showModelChooser, boolean simpleTableModel, boolean choiceTableModel, boolean innerCallsTable, AuthorResourceBundle authorResourceBundle, int predefinedRowsCount, int predefinedColumnsCount)
          Constructor.
 
Method Summary
protected abstract  javax.swing.JCheckBox createTitleCheckbox()
          Creates the title checkbox with an implementation specific name.
protected abstract  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 the frame attribute.
protected  int getTableModel()
           
 TableInfo showDialog(TableInfo previousTableInfo)
          Show the dialog to customize the table attributes.
protected  void updateColumnsWidthsCombo(TableCustomizerConstants.ColumnWidthsType[] columnsWidthsSpecifications)
           
 
Methods inherited from class ro.sync.exml.workspace.api.standalone.ui.OKCancelDialog
doCancel, doOK, enterKeyPressed, getCancelButton, getContentPane, getOkButton, getResult, main, setCancelButtonText, setOkButtonText, setVisible
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

authorResourceBundle

protected final AuthorResourceBundle authorResourceBundle
Author resource bundle.

Constructor Detail

SATableCustomizerDialog

public SATableCustomizerDialog(java.awt.Frame parentFrame,
                               boolean hasFooter,
                               boolean hasFrameAttribute,
                               boolean showModelChooser,
                               AuthorResourceBundle authorResourceBundle,
                               int predefinedRowsCount,
                               int predefinedColumnsCount)
Constructor.

Parameters:
parentFrame - The parent JFrame of the dialog.
hasFooter - true if this table has a footer.
hasFrameAttribute - true if this table has a frame attribute.
showModelChooser - true to show the dialog panel for choosing the table model, one of CALS or HTML.
authorResourceBundle - Author resource bundle.
predefinedRowsCount - The predefined number of rows.
predefinedColumnsCount - The predefined number of columns.

SATableCustomizerDialog

public SATableCustomizerDialog(java.awt.Frame parentFrame,
                               boolean hasFooter,
                               boolean hasFrameAttribute,
                               boolean showModelChooser,
                               boolean simpleTableModel,
                               boolean innerCallsTable,
                               AuthorResourceBundle authorResourceBundle,
                               int predefinedRowsCount,
                               int predefinedColumnsCount)
Constructor.

Parameters:
parentFrame - The parent JFrame of the dialog.
hasFooter - true if this table has 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.
simpleTableModel - true to use the simple table model instead of the HTML model.
innerCallsTable - true if this is an inner CALLS table.
authorResourceBundle - Author resource bundle.
predefinedRowsCount - The predefined number of rows.
predefinedColumnsCount - The predefined number of columns.

SATableCustomizerDialog

public SATableCustomizerDialog(java.awt.Frame parentFrame,
                               boolean hasFooter,
                               boolean hasFrameAttribute,
                               boolean showModelChooser,
                               boolean simpleTableModel,
                               boolean choiceTableModel,
                               boolean innerCallsTable,
                               AuthorResourceBundle authorResourceBundle,
                               int predefinedRowsCount,
                               int predefinedColumnsCount)
Constructor.

Parameters:
parentFrame - The parent JFrame of the dialog.
hasFooter - true if this table has 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.
simpleTableModel - true to use the simple table model instead of the HTML model.
choiceTableModel -
innerCallsTable - true if this is an inner CALLS table.
authorResourceBundle - Author resource bundle.
predefinedRowsCount - The predefined number of rows.
predefinedColumnsCount - The predefined number of columns.
Method Detail

updateColumnsWidthsCombo

protected void updateColumnsWidthsCombo(TableCustomizerConstants.ColumnWidthsType[] columnsWidthsSpecifications)
Parameters:
columnsWidthsSpecifications - The column widths specifications.

getFrameValues

protected abstract java.lang.String[] getFrameValues(int tableModel)
Compute the possible values for the 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 the frame attribute.

getDefaultFrameValue

protected abstract java.lang.String getDefaultFrameValue(int tableModel)
Get the default frame value.

Parameters:
tableModel - The table model.
Returns:
The table model.

getColumnWidthsSpecifications

protected abstract 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 javax.swing.JCheckBox createTitleCheckbox()
Creates the title checkbox with an implementation specific name.

Returns:
The title checkbox customized according to implementation.

showDialog

public TableInfo showDialog(TableInfo previousTableInfo)
Show the dialog to customize the table attributes.

Parameters:
previousTableInfo - Table info to be used for initializing the controls.
Returns:
The TableInfo object with informations about the table to be inserted. If null then the user canceled the table insertion.

getTableModel

protected int getTableModel()
Returns:
The table model.

Oxygen XML Editor 14.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.