public class WorkbookView
extends javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponentlistenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW| Constructor and Description |
|---|
WorkbookView()
Initializes a new instance of the
WorkbookView class. |
| Modifier and Type | Method and Description |
|---|---|
void |
addViewListener(WorkbookViewListener listener) |
void |
beginEdit(IInplaceEditable item)
Initiates in-place edit of the specified in-place editable object.
|
boolean |
bringIntoView(Cell cell)
Scrolls the view to make the specified cell visible.
|
boolean |
bringIntoView(Cell cell,
HorizontalAlignment halign,
VerticalAlignment valign)
Scrolls the view to make the specified cell visible.
|
void |
cancelDrag()
Cancels any drag or select interactions currently performed by user.
|
void |
copy()
Copies the data from the currently selected cells to the clipboard.
|
void |
copy(boolean copyFormulas) |
void |
cut()
Cuts the data from the currently selected cells to the clipboard.
|
void |
cut(boolean copyFormulas) |
boolean |
endEdit(boolean acceptChanges)
Completes the in-place editing operation, previously started by
a call to
beginEdit(com.mindfusion.spreadsheet.IInplaceEditable), and accepts or cancel the change. |
void |
freezePanes()
Freezes the rows above and columns to the left of current cell.
|
void |
freezePanes(int firstVisibleColumn,
int frozenColumns,
int firstVisibleRow,
int frozenRows)
Freezes specified number of rows and columns.
|
Pen |
getActiveBorderPen()
Gets the Pen used to draw borders of current active cell.
|
Cell |
getActiveCell()
Gets the currently active cell.
|
Worksheet |
getActiveWorksheet()
Gets the currently active worksheet.
|
boolean |
getAllowAutoFill()
Gets a value indicating whether to display the auto-fill handle at the bottom-right side of the selection.
|
boolean |
getAllowMoveCells()
Gets a value indicating whether the user can interactively move cells around the worksheet,
by pressing near the edge of the currently selected cells with the mouse and dragging.
|
boolean |
getAllowMoveHeaders()
Gets a value indicating whether the user can interactively move
the worksheet headers, by selecting the entire column or row and dragging.
|
boolean |
getAllowResizeHeaders()
Gets a value indicating whether the user can interactively resize the worksheet headers.
|
boolean |
getAllowTabEdit()
Gets a value indicating whether tabs can be in-place edited.
|
boolean |
getAllowTabReorder()
Gets a value indicating whether tabs can be rearranged interactively.
|
ArrowActions |
getArrowActions()
Gets what action should be performed by left/right arrow buttons in tab strip.
|
java.awt.Cursor |
getAutoFillCursor()
Gets the mouse cursor shown to the user if the mouse is over the auto fill handle or
the user is currently performing an auto fill operation.
|
boolean |
getAutoFillSkipMerged()
Gets whether auto-fill should skip cells spanned by a merged cell.
|
java.awt.Color |
getBackColor()
Gets the background color of the view.
|
Cell |
getCellAt(int x,
int y)
Gets the cell at the specified coordinates, expressed relatively to the top/left of the control.
|
Cell |
getCellAt(Measure x,
Measure y)
Gets the cell at the specified coordinates, expressed relatively to the top/left of the worksheet.
|
Measure |
getColumnHeaderHeight()
Gets the height of the column header.
|
java.awt.Cursor |
getCounterDiagonalResizeCursor()
Gets the mouse cursor shown to the user if dragging would resize an object both vertically and horizontally.
|
java.awt.Cursor |
getDiagonalResizeCursor()
Gets the mouse cursor shown to the user if dragging would resize an object both vertically and horizontally.
|
java.awt.Cursor |
getDisallowCursor()
Gets the mouse cursor shown to the user when an object cannot be created at a given location.
|
boolean |
getDrawFilledCellBorders()
Gets a value indicating whether to draw the default grid lines for cells with set background.
|
int |
getFirstVisibleFrozenColumn()
Gets the leftmost visible frozen column.
|
int |
getFirstVisibleFrozenRow()
Gets the topmost visible frozen row.
|
boolean |
getFormulasInClipboard() |
int |
getFrozenColumnCount()
Gets the number of frozen columns in the view.
|
int |
getFrozenRowCount()
Gets the number of frozen rows in the view.
|
java.awt.Cursor |
getHorizontalResizeCursor()
Gets the mouse cursor shown to the user if dragging would resize an object horizontally.
|
java.awt.Cursor |
getHorizontalSplitCursor()
Gets the mouse cursor shown to the user if dragging would resize rows.
|
java.lang.String |
getHScrollToolTipFormat()
Gets the format of the tooltip that is displayed when the view is scrolled horizontally.
|
java.awt.Cursor |
getHyperlinkCursor()
Gets the mouse cursor shown to the user if the mouse is over a cell containing a hyperlink.
|
java.lang.String |
getLicenseKey()
Gets the license key of the control.
|
int |
getMaxTabSize()
Gets the maximum size of tabs representing worksheets in the tab strip.
|
java.awt.Cursor |
getMoveCursor()
Gets the mouse cursor shown to the user if the pointed object can be modified.
|
PasteToMerged |
getPasteToMerged()
Gets how to handle pasting data into merged cells.
|
java.awt.Cursor |
getPointerCursor()
Gets the mouse cursor shown to the user when no modification is performed.
|
java.lang.String |
getResizeColumnToolTipFormat()
Gets the format of the tooltip that is displayed when a column is resized interactively.
|
java.lang.String |
getResizeRowToolTipFormat()
Gets the format of the tooltip that is displayed when a row is resized interactively.
|
Measure |
getRowHeaderWidth()
Gets the width of the row header.
|
int |
getScrollX()
Gets the value of the horizontal scrollbar.
|
int |
getScrollY()
Gets the value of the vertical scrollbar.
|
Selection |
getSelection()
Gets an object that can be used to manipulate the selection in the view.
|
SelectionType |
getSelectionType()
Gets the selection type
|
boolean |
getShowActiveCell()
Gets a value indicating whether to display the active cell.
|
boolean |
getShowAutoFilterRange()
Gets a value indicating whether to display the range affected by the autofilter.
|
boolean |
getShowCreateNewTab()
Gets a value indicating whether to display the 'Create New Tab' button.
|
boolean |
getShowFormulaBar()
Gets a value indicating whether to display the formula bar.
|
boolean |
getShowGridLines()
Gets a value indicating whether to display the grid lines.
|
boolean |
getShowHeaders()
Gets a value indicating whether to display the row and column headers.
|
boolean |
getShowHiddenHeaderIndicators()
Gets a value indicating whether to display indicators for hidden row and column headers.
|
boolean |
getShowHorizontalScrollBar()
Gets a value indicating whether to display the horizontal scroll bar.
|
boolean |
getShowResizeHeaderToolTips()
Gets a value indicating whether to display tooltips when the user resizes row or column headers.
|
boolean |
getShowScrollToolTips()
Gets a value indicating whether to display tooltips when scrolling with the thumb.
|
boolean |
getShowSelection()
Gets a value indicating whether to display the cell selection.
|
boolean |
getShowTabCloseButtons()
Gets a value indicating whether to display a close button for each tab.
|
boolean |
getShowTabNavigationButtons()
Gets a value indicating whether the tab navigation buttons.
|
boolean |
getShowTabs()
Gets a value indicating whether the tabs are visible.
|
boolean |
getShowVerticalScrollBar()
Gets a value indicating whether to display the vertical scroll bar.
|
TabAlignment |
getTabAlignment()
Gets the tabs alignment.
|
boolean |
getValidateOnPaste()
Gets a value indicating whether to validate pasted data
|
java.awt.Cursor |
getVerticalResizeCursor()
Gets the mouse cursor shown to the user if dragging would resize an object vertically.
|
java.awt.Cursor |
getVerticalSplitCursor()
Gets the mouse cursor shown to the user if dragging would resize columns.
|
java.lang.String |
getVScrollToolTipFormat()
Gets the format of the tooltip that is displayed when the view is scrolled vertically.
|
Workbook |
getWorkbook()
Gets the
Workbook displayed in the view. |
boolean |
isEditing()
Gets a value indicating whether there is currently an in-place editing operation in progress within the view.
|
boolean |
isFocusOnCell()
Gets if keyboard focus is currently on a cell.
|
protected void |
onActivatingCell(ActivationEvent e)
Raises the activatingCell event.
|
protected void |
onActiveCellChanged(java.util.EventObject e)
Raises the ActiveCellChanged event.
|
protected void |
onActiveWorksheetChanged(java.util.EventObject e)
Raises the ActiveWorksheetChanged event.
|
protected void |
onCellClicked(CellMouseEvent e)
Raises the CellClicked event.
|
protected void |
onColumnClicked(ColumnMouseEvent e)
Raises the ColumnClicked event.
|
protected void |
onColumnGroupCollapsed(ColumnEvent e)
Raises the ColumnGroupCollapsed event.
|
protected void |
onColumnGroupExpanded(ColumnEvent e)
Raises the ColumnGroupExpanded event.
|
protected void |
onColumnOutlineLevelToggled(OutlineEvent e)
Raises the ColumnOutlineLevelToggled event.
|
protected void |
onColumnsMoved(ColumnRangeEvent e)
Raises the ColumnsMoved event.
|
protected void |
onColumnsResized(ColumnRangeEvent e)
Raises the ColumnsResized event.
|
protected void |
onDrawCell(DrawCellEvent e)
Raises the drawCell event.
|
protected void |
onDrawColumn(DrawColumnEvent e)
Raises the drawColumn event.
|
protected void |
onDrawRow(DrawRowEvent e)
Raises the drawRow event.
|
protected void |
onDropDownValueSelected(DropDownSelectionEventObject e)
Raises the
ViewListener.dropDownValueSelected(DropDownSelectionEventObject) event. |
protected void |
onHyperlinkClicked(CellEvent e)
Raises the HyperlinkClicked event.
|
protected void |
onInplaceEditEnded(InplaceEditEvent e)
Raises the InplaceEditEnded event.
|
protected void |
onInplaceEditEnding(InplaceEditValidationEvent e)
Raises the InplaceEditEnding event.
|
protected void |
onInplaceEditStarted(InplaceEditEvent e)
Raises the InplaceEditStarted event.
|
protected void |
onInplaceEditStarting(InplaceEditValidationEvent e)
Raises the InplaceEditStarting event.
|
protected void |
onObjectClicked(ObjectMouseEvent e)
Raises the ObjectClicked event.
|
protected void |
onObjectDeleted(ObjectEvent e)
Raises the ObjectDeleted event.
|
protected void |
onObjectDeleting(ObjectValidationEvent e)
Raises the ObjectDeleting event.
|
protected void |
onObjectDeselected(ObjectEvent e)
Raises the ObjectDeselected event.
|
protected void |
onObjectModified(ObjectInteractionEvent e)
Raises the ObjectModified event.
|
protected void |
onObjectModifyCancelled(ObjectInteractionEvent e)
Raises the ObjectModifyCancelled event.
|
protected void |
onObjectModifying(ObjectInteractionValidationEvent e)
Raises the ObjectModifying event.
|
protected void |
onObjectSelected(ObjectEvent e)
Raises the ObjectSelected event.
|
protected void |
onObjectSelecting(ObjectInteractionValidationEvent e)
Raises the ObjectSelecting event.
|
protected void |
onObjectStartModifying(ObjectInteractionValidationEvent e)
Raises the ObjectStartModifying event.
|
protected void |
onPropertyChanged(java.beans.PropertyChangeEvent e)
Raises the PropertyChanged event.
|
protected void |
onQueryDropDownList(DropDownEventObject e)
Raises the
ViewListener.queryDropDownList(DropDownEventObject) event. |
protected void |
onRowClicked(RowMouseEvent e)
Raises the RowClicked event.
|
protected void |
onRowGroupCollapsed(RowEvent e)
Raises the RowGroupCollapsed event.
|
protected void |
onRowGroupExpanded(RowEvent e)
Raises the RowGroupExpanded event.
|
protected void |
onRowOutlineLevelToggled(OutlineEvent e)
Raises the RowOutlineLevelToggled event.
|
protected void |
onRowsMoved(RowRangeEvent e)
Raises the RowsMoved event.
|
protected void |
onRowsResized(RowRangeEvent e)
Raises the RowsResized event.
|
protected void |
onSelectionChanged(java.util.EventObject e)
Raises the SelectionChanged event.
|
protected void |
onValidationDropdownClosing(InplaceEditValidationEvent e)
Raises the ValidationDropdownClosing event.
|
protected void |
onValidationDropdownOpening(InplaceEditValidationEvent e)
Raises the ValidationDropdownOpening event.
|
protected void |
onWorksheetAdded(WorksheetEvent e)
Raises the WorksheetAdded event.
|
protected void |
onWorksheetRemoved(WorksheetEvent e)
Raises the WorksheetRemoved event.
|
protected void |
onWorksheetRemoving(WorksheetValidationEvent e)
Raises the WorksheetRemoving event.
|
protected void |
onWorksheetRenamed(WorksheetEvent e)
Raises the WorksheetRenamed event.
|
protected void |
onWorksheetRenameFailed(WorksheetEvent e)
Raises the WorksheetRenameFailed event.
|
protected void |
onWorksheetTabClicked(WorksheetMouseEvent e)
Raises the WorksheetTabClicked event.
|
void |
openValidationDropdown()
Opens the validation dropdown for the active cell, if its validation
rules support an in-cell dropdown (List or Dropdown type with
showDropdownList).
|
void |
paste()
Pastes the data from the clipboard inside the currently selected cells.
|
void |
removeViewListener(WorkbookViewListener listener) |
void |
requestFocus() |
void |
resizeColumnsToFit(int startIndex,
int endIndex)
Resizes view columns to fit their contents.
|
void |
resizeColumnToFit(int index)
Resizes a view column to fit its contents.
|
void |
resizeRowsToFit(int startIndex,
int endIndex)
Resizes view rows to fit their contents.
|
void |
resizeRowsToFit(int startIndex,
int endIndex,
double defaultHeight)
Resizes view rows to fit their contents.
|
void |
resizeRowToFit(int index)
Resizes a view row to fit its contents.
|
void |
setActiveBorderPen(Pen value)
Sets the Pen used to draw borders of current active cell.
|
void |
setActiveCell(Cell value)
Sets the currently active cell.
|
void |
setActiveWorksheet(Worksheet value)
Sets the currently active worksheet.
|
void |
setAllowAutoFill(boolean value)
Sets a value indicating whether to display the auto-fill handle at the bottom-right side of the selection.
|
void |
setAllowMoveCells(boolean value)
Sets a value indicating whether the user can interactively move cells around the worksheet,
by pressing near the edge of the currently selected cells with the mouse and dragging.
|
void |
setAllowMoveHeaders(boolean value)
Sets a value indicating whether the user can interactively move
the worksheet headers, by selecting the entire column or row and dragging.
|
void |
setAllowResizeHeaders(boolean value)
Sets a value indicating whether the user can interactively resize the worksheet headers.
|
void |
setAllowTabEdit(boolean value)
Sets a value indicating whether tabs can be in-place edited.
|
void |
setAllowTabReorder(boolean value)
Sets a value indicating whether tabs can be rearranged interactively.
|
void |
setArrowActions(ArrowActions arrowActions)
Sets what action should be performed by left/right arrow buttons in tab strip.
|
void |
setAutoFillCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user if the mouse is over the auto fill handle or
the user is currently performing an auto fill operation.
|
void |
setAutoFillSkipMerged(boolean value)
Sets whether auto-fill should skip cells spanned by a merged cell.
|
void |
setBackColor(java.awt.Color value)
Sets the background color of the view.
|
void |
setColumnHeaderHeight(Measure value)
Sets the height of the column header, or null, to automatically size the column headers.
|
void |
setCounterDiagonalResizeCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user if dragging would resize an object both vertically and horizontally.
|
void |
setDiagonalResizeCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user if dragging would resize an object both vertically and horizontally.
|
void |
setDisallowCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user when an object cannot be created at a given location.
|
void |
setDrawFilledCellBorders(boolean value)
Sets a value indicating whether to draw the default grid lines for cells with set background.
|
void |
setFirstVisibleFrozenColumn(int value)
Sets the leftmost visible frozen column.
|
void |
setFirstVisibleFrozenRow(int value)
Sets the topmost visible frozen row.
|
void |
setFocusOnCell(boolean focusOnCell)
Sets if keyboard focus is currently on a cell.
|
void |
setFormulasInClipboard(boolean value) |
void |
setFrozenColumnCount(int value)
Sets the number of frozen columns in the view.
|
void |
setFrozenRowCount(int value)
Sets the number of frozen rows in the view.
|
void |
setHorizontalResizeCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user if dragging would resize an object horizontally.
|
void |
setHorizontalSplitCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user if dragging would resize rows.
|
void |
setHScrollToolTipFormat(java.lang.String value)
Sets the format of the tooltip that is displayed when the view is scrolled horizontally.
|
void |
setHyperlinkCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user if the mouse is over a cell containing a hyperlink.
|
void |
setLicenseKey(java.lang.String value)
Sets the license key of the control.
|
void |
setMaxTabSize(int maxTabSize)
Sets the maximum size of tabs representing worksheets in the tab strip.
|
void |
setMoveCursor(java.awt.Cursor value)
Gets the mouse cursor shown to the user if the pointed object can be modified.
|
void |
setPasteToMerged(PasteToMerged value)
Sets how to handle pasting data into merged cells.
|
void |
setPointerCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user when no modification is performed.
|
void |
setResizeColumnToolTipFormat(java.lang.String value)
Sets the format of the tooltip that is displayed when a column is resized interactively.
|
void |
setResizeRowToolTipFormat(java.lang.String value)
Sets the format of the tooltip that is displayed when a row is resized interactively.
|
void |
setRowHeaderWidth(Measure value)
Sets the width of the row header, or null, to automatically size the row headers.
|
void |
setScrollX(int value)
Sets the value of the horizontal scrollbar.
|
void |
setScrollY(int value)
Sets the value of the vertical scrollbar.
|
void |
setSelectionType(SelectionType selectionType)
Sets the selection type
|
void |
setShowActiveCell(boolean value)
Sets a value indicating whether to display the active cell.
|
void |
setShowAutoFilterRange(boolean value)
Sets a value indicating whether to display the range affected by the autofilter.
|
void |
setShowCreateNewTab(boolean value)
Gets a value indicating whether to display the 'Create New Tab' button.
|
void |
setShowFormulaBar(boolean value)
Sets a value indicating whether to display the formula bar.
|
void |
setShowGridLines(boolean value)
Sets a value indicating whether to display the grid lines.
|
void |
setShowHeaders(boolean value)
Sets a value indicating whether to display the row and column headers.
|
void |
setShowHiddenHeaderIndicators(boolean value)
Sets a value indicating whether to display indicators for hidden row and column headers.
|
void |
setShowHorizontalScrollBar(boolean value)
Sets a value indicating whether to display the horizontal scroll bar.
|
void |
setShowResizeHeaderToolTips(boolean value)
Sets a value indicating whether to display tooltips when the user resizes row or column headers.
|
void |
setShowScrollToolTips(boolean value)
Sets a value indicating whether to display tooltips when scrolling with the thumb.
|
void |
setShowSelection(boolean value)
Sets a value indicating whether to display the cell selection.
|
void |
setShowTabCloseButtons(boolean value)
Sets a value indicating whether to display a close button for each tab.
|
void |
setShowTabNavigationButtons(boolean value)
Sets a value indicating whether the tab navigation buttons.
|
void |
setShowTabs(boolean value)
Sets a value indicating whether the tabs are visible.
|
void |
setShowVerticalScrollBar(boolean value)
Sets a value indicating whether to display the vertical scroll bar.
|
void |
setTabAlignment(TabAlignment value)
Sets the tabs alignment.
|
void |
setValidateOnPaste(boolean value)
Sets a value indicating whether to validate pasted data
|
void |
setVerticalResizeCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user if dragging would resize an object vertically.
|
void |
setVerticalSplitCursor(java.awt.Cursor value)
Sets the mouse cursor shown to the user if dragging would resize columns.
|
void |
setVScrollToolTipFormat(java.lang.String value)
Sets the format of the tooltip that is displayed when the view is scrolled vertically.
|
void |
setWorkbook(Workbook value)
Sets the
Workbook displayed in the view. |
Measure |
toGlobalX(Measure x,
int column,
int row)
Converts the specified measure, relative to the left side of the specified cell,
to a measure, relative to the left side of the entire worksheet.
|
Measure |
toGlobalY(Measure y,
int column,
int row)
Converts the specified measure, relative to the top side of the specified cell,
to a measure, relative to the top side of the entire worksheet.
|
Measure |
toLocalX(Measure x,
int column,
int row)
Converts the specified measure, relative to the left side of the worksheet,
to a measure, relative to the left side of the specified cell.
|
Measure |
toLocalY(Measure y,
int column,
int row)
Converts the specified measure, relative to the top side of the worksheet,
to a measure, relative to the top side of the specified cell.
|
void |
unfreezePanes()
Unfreezes any frozen columns or rows.
|
void |
updateUI() |
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, updateadd, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTreeaction, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCyclepublic WorkbookView()
WorkbookView class.public void beginEdit(IInplaceEditable item)
item - The object to edit.public void openValidationDropdown()
public boolean endEdit(boolean acceptChanges)
beginEdit(com.mindfusion.spreadsheet.IInplaceEditable), and accepts or cancel the change.acceptChanges - true to accept in-place changes; otherwise, false.public void cancelDrag()
public void cut()
public void cut(boolean copyFormulas)
public void copy()
public void copy(boolean copyFormulas)
public void paste()
public boolean getFormulasInClipboard()
public void setFormulasInClipboard(boolean value)
public void resizeColumnToFit(int index)
index - The index of the column to resize.public void resizeColumnsToFit(int startIndex,
int endIndex)
startIndex - The index of the first column to resize.endIndex - The index of the last column to resize.public void resizeRowToFit(int index)
index - The index of the row to resize.public void resizeRowsToFit(int startIndex,
int endIndex)
startIndex - The index of the first row to resize.endIndex - The index of the last row to resize.public void resizeRowsToFit(int startIndex,
int endIndex,
double defaultHeight)
startIndex - The index of the first row to resize.endIndex - The index of the last row to resize.defaultHeight - The default height of row if measured height equals zeropublic boolean bringIntoView(Cell cell)
cell - The cell to scroll to.true if the operation was successful; false if the specified cell could not be scrolled to.public boolean bringIntoView(Cell cell, HorizontalAlignment halign, VerticalAlignment valign)
cell - The cell to scroll to.halign - Cell's horizontal alignment relative to current viewport.valign - Cell's vertical alignment relative to current viewport.true if the operation was successful; false if the specified cell could not be scrolled to.public Measure toGlobalX(Measure x, int column, int row)
x - The coordinate to convert.column - The 0-based index of the column of the relative cell.row - The 0-based index of the row of the relative cell.Measure object representing the specified measure, relative to the worksheet.public Measure toGlobalY(Measure y, int column, int row)
y - The coordinate to convert.column - The 0-based index of the column of the relative cell.row - The 0-based index of the row of the relative cell.Measure object representing the specified measure, relative to the worksheet.public Measure toLocalX(Measure x, int column, int row)
x - The coordinate to convert.column - The 0-based index of the column of the relative cell.row - The 0-based index of the row of the relative cell.Measure object representing the specified measure, relative to the cell.public Measure toLocalY(Measure y, int column, int row)
y - The coordinate to convert.column - The 0-based index of the column of the relative cell.row - The 0-based index of the row of the relative cell.Measure object representing the specified measure, relative to the cell.public Cell getCellAt(Measure x, Measure y)
x - The x-coordinate of the cell to get.y - The y-coordinate of the cell to get.Cell object representing the cell at the specified location.public Cell getCellAt(int x, int y)
x - The x-coordinates of the cell to get.y - The y-coordinates of the cell to get.Cell object representing the cell at the specified location.protected void onActivatingCell(ActivationEvent e)
e - An object providing the event data.protected void onWorksheetAdded(WorksheetEvent e)
e - An object providing the event data.protected void onWorksheetRemoving(WorksheetValidationEvent e)
e - An object providing the event data.protected void onWorksheetRemoved(WorksheetEvent e)
e - An object providing the event data.protected void onActiveWorksheetChanged(java.util.EventObject e)
e - An object providing the event data.protected void onActiveCellChanged(java.util.EventObject e)
e - An object providing the event data.protected void onSelectionChanged(java.util.EventObject e)
e - An object providing the event data.protected void onWorksheetTabClicked(WorksheetMouseEvent e)
e - An object providing the event data.protected void onWorksheetRenameFailed(WorksheetEvent e)
e - An object providing the event data.protected void onWorksheetRenamed(WorksheetEvent e)
e - An object providing the event data.protected void onCellClicked(CellMouseEvent e)
e - An object providing the event data.protected void onObjectClicked(ObjectMouseEvent e)
e - An object providing the event data.protected void onColumnClicked(ColumnMouseEvent e)
e - An object providing the event data.protected void onRowClicked(RowMouseEvent e)
e - An object providing the event data.protected void onInplaceEditStarting(InplaceEditValidationEvent e)
e - An object providing the event data.protected void onInplaceEditStarted(InplaceEditEvent e)
e - An object providing the event data.protected void onQueryDropDownList(DropDownEventObject e)
ViewListener.queryDropDownList(DropDownEventObject) event.e - An object providing the List of dataprotected void onDropDownValueSelected(DropDownSelectionEventObject e)
ViewListener.dropDownValueSelected(DropDownSelectionEventObject) event.e - An object providing the selected dataprotected void onInplaceEditEnding(InplaceEditValidationEvent e)
e - An object providing the event data.protected void onInplaceEditEnded(InplaceEditEvent e)
e - An object providing the event data.protected void onValidationDropdownOpening(InplaceEditValidationEvent e)
e - An object providing the event data.protected void onValidationDropdownClosing(InplaceEditValidationEvent e)
e - An object providing the event data.protected void onObjectStartModifying(ObjectInteractionValidationEvent e)
e - An object providing the event data.protected void onObjectModifying(ObjectInteractionValidationEvent e)
e - An object providing the event data.protected void onObjectModified(ObjectInteractionEvent e)
e - An object providing the event data.protected void onObjectModifyCancelled(ObjectInteractionEvent e)
e - An object providing the event data.protected void onObjectSelecting(ObjectInteractionValidationEvent e)
e - An object providing the event data.protected void onObjectSelected(ObjectEvent e)
e - An object providing the event data.protected void onObjectDeselected(ObjectEvent e)
e - An object providing the event data.protected void onObjectDeleting(ObjectValidationEvent e)
e - An object providing the event data.protected void onObjectDeleted(ObjectEvent e)
e - An object providing the event data.protected void onHyperlinkClicked(CellEvent e)
e - An object providing the event data.protected void onColumnOutlineLevelToggled(OutlineEvent e)
e - An object providing the event data.protected void onRowOutlineLevelToggled(OutlineEvent e)
e - An object providing the event data.protected void onColumnGroupExpanded(ColumnEvent e)
e - An object providing the event data.protected void onColumnGroupCollapsed(ColumnEvent e)
e - An object providing the event data.protected void onRowGroupCollapsed(RowEvent e)
e - An object providing the event data.protected void onRowGroupExpanded(RowEvent e)
e - An object providing the event data.protected void onDrawColumn(DrawColumnEvent e)
e - An object providing the event data.protected void onDrawRow(DrawRowEvent e)
e - An object providing the event data.protected void onDrawCell(DrawCellEvent e)
e - An object providing the event data.protected void onColumnsResized(ColumnRangeEvent e)
e - An object providing the event data.protected void onRowsResized(RowRangeEvent e)
e - An object providing the event data.protected void onColumnsMoved(ColumnRangeEvent e)
e - An object providing the event data.protected void onRowsMoved(RowRangeEvent e)
e - An object providing the event data.protected void onPropertyChanged(java.beans.PropertyChangeEvent e)
e - An object providing the event data.public java.awt.Color getBackColor()
public void setBackColor(java.awt.Color value)
public Worksheet getActiveWorksheet()
public void setActiveWorksheet(Worksheet value)
public Selection getSelection()
public boolean getShowSelection()
public void setShowSelection(boolean value)
public int getFrozenColumnCount()
public void setFrozenColumnCount(int value)
value - An integer value specifying number of frozen columns.public int getFrozenRowCount()
public void setFrozenRowCount(int value)
value - An integer value specifying number of frozen rows.public int getFirstVisibleFrozenColumn()
public void setFirstVisibleFrozenColumn(int value)
value - Index of the first visible frozen column.public int getFirstVisibleFrozenRow()
public void setFirstVisibleFrozenRow(int value)
value - Index of the first visible frozen row.public void freezePanes()
public void freezePanes(int firstVisibleColumn,
int frozenColumns,
int firstVisibleRow,
int frozenRows)
firstVisibleColumn - The leftmost column to keep visible.frozenColumns - Total number of frozen columns.firstVisibleRow - The topmost row to keep visible.frozenRows - Total number of frozen rows.public void unfreezePanes()
public Cell getActiveCell()
public void setActiveCell(Cell value)
value - An instance of the Cell class.public void setActiveBorderPen(Pen value)
value - A Pen object containing Color, Width and DashStyle.public Pen getActiveBorderPen()
public boolean getShowActiveCell()
public void setShowActiveCell(boolean value)
public boolean getValidateOnPaste()
public void setValidateOnPaste(boolean value)
public boolean getShowAutoFilterRange()
public void setShowAutoFilterRange(boolean value)
public int getScrollX()
public void setScrollX(int value)
public int getScrollY()
public void setScrollY(int value)
public boolean getShowTabs()
public void setShowTabs(boolean value)
public TabAlignment getTabAlignment()
public void setTabAlignment(TabAlignment value)
public boolean getShowTabCloseButtons()
public void setShowTabCloseButtons(boolean value)
public boolean getShowTabNavigationButtons()
public void setShowTabNavigationButtons(boolean value)
public boolean getShowCreateNewTab()
public void setShowCreateNewTab(boolean value)
public boolean getAllowTabReorder()
public void setAllowTabReorder(boolean value)
public boolean getAllowTabEdit()
public void setAllowTabEdit(boolean value)
public boolean getShowGridLines()
public void setShowGridLines(boolean value)
public boolean getDrawFilledCellBorders()
public void setDrawFilledCellBorders(boolean value)
public boolean getAllowAutoFill()
public void setAllowAutoFill(boolean value)
public PasteToMerged getPasteToMerged()
public void setPasteToMerged(PasteToMerged value)
value - A member of the PasteToMerged enumeration.public boolean getAutoFillSkipMerged()
public void setAutoFillSkipMerged(boolean value)
public boolean getAllowMoveHeaders()
public void setAllowMoveHeaders(boolean value)
public boolean getAllowResizeHeaders()
public void setAllowResizeHeaders(boolean value)
public boolean getAllowMoveCells()
public void setAllowMoveCells(boolean value)
public boolean getShowScrollToolTips()
public void setShowScrollToolTips(boolean value)
public java.lang.String getHScrollToolTipFormat()
public void setHScrollToolTipFormat(java.lang.String value)
public java.lang.String getVScrollToolTipFormat()
public void setVScrollToolTipFormat(java.lang.String value)
public boolean getShowResizeHeaderToolTips()
public void setShowResizeHeaderToolTips(boolean value)
public java.lang.String getResizeColumnToolTipFormat()
public void setResizeColumnToolTipFormat(java.lang.String value)
public java.lang.String getResizeRowToolTipFormat()
public void setResizeRowToolTipFormat(java.lang.String value)
public boolean getShowHeaders()
public void setShowHeaders(boolean value)
public boolean getShowHiddenHeaderIndicators()
public void setShowHiddenHeaderIndicators(boolean value)
public Measure getRowHeaderWidth()
public void setRowHeaderWidth(Measure value)
public Measure getColumnHeaderHeight()
public void setColumnHeaderHeight(Measure value)
public boolean getShowHorizontalScrollBar()
public void setShowHorizontalScrollBar(boolean value)
public boolean getShowVerticalScrollBar()
public void setShowVerticalScrollBar(boolean value)
public boolean getShowFormulaBar()
public void setShowFormulaBar(boolean value)
public boolean isEditing()
public java.awt.Cursor getPointerCursor()
public void setPointerCursor(java.awt.Cursor value)
public java.awt.Cursor getDisallowCursor()
public void setDisallowCursor(java.awt.Cursor value)
public java.awt.Cursor getMoveCursor()
public void setMoveCursor(java.awt.Cursor value)
public java.awt.Cursor getHorizontalResizeCursor()
public void setHorizontalResizeCursor(java.awt.Cursor value)
public java.awt.Cursor getVerticalResizeCursor()
public void setVerticalResizeCursor(java.awt.Cursor value)
public java.awt.Cursor getHorizontalSplitCursor()
public void setHorizontalSplitCursor(java.awt.Cursor value)
public java.awt.Cursor getVerticalSplitCursor()
public void setVerticalSplitCursor(java.awt.Cursor value)
public java.awt.Cursor getDiagonalResizeCursor()
public void setDiagonalResizeCursor(java.awt.Cursor value)
public java.awt.Cursor getCounterDiagonalResizeCursor()
public void setCounterDiagonalResizeCursor(java.awt.Cursor value)
public java.awt.Cursor getAutoFillCursor()
public void setAutoFillCursor(java.awt.Cursor value)
public java.awt.Cursor getHyperlinkCursor()
public void setHyperlinkCursor(java.awt.Cursor value)
public java.lang.String getLicenseKey()
public void setLicenseKey(java.lang.String value)
public void setSelectionType(SelectionType selectionType)
selectionType - The enum that represents the selection typepublic SelectionType getSelectionType()
public ArrowActions getArrowActions()
public void setArrowActions(ArrowActions arrowActions)
arrowActions - A member of the ArrowActions enumeration.public boolean isFocusOnCell()
public void setFocusOnCell(boolean focusOnCell)
focusOnCell - true if any cell has the keyboard focus, or false otherwise.public void updateUI()
updateUI in class javax.swing.JComponentpublic void setMaxTabSize(int maxTabSize)
java.lang.IllegalArgumentException - if tab size is negativepublic int getMaxTabSize()
public void requestFocus()
requestFocus in class javax.swing.JComponentpublic void addViewListener(WorkbookViewListener listener)
public void removeViewListener(WorkbookViewListener listener)