Package com.mxgraph.swing.view
Class mxCellEditor
- java.lang.Object
-
- com.mxgraph.swing.view.mxCellEditor
-
- All Implemented Interfaces:
mxICellEditor
public class mxCellEditor extends java.lang.Object implements mxICellEditor
To control this editor, use mxGraph.invokesStopCellEditing, mxGraph. enterStopsCellEditing and mxGraph.escapeEnabled.
-
-
Field Summary
Fields Modifier and Type Field Description protected javax.swing.AbstractActioncancelEditingActionstatic intDEFAULT_MIN_HEIGHTstatic intDEFAULT_MIN_WIDTHstatic doubleDEFAULT_MINIMUM_EDITOR_SCALEprotected java.lang.ObjecteditingCellprotected javax.swing.JEditorPaneeditorPaneHolds the editor for HTML editing.protected booleanextractHtmlBodySpecifies if the text content of the HTML body should be extracted before and after editing for HTML markup.protected mxGraphComponentgraphComponentprotected doubleminimumEditorScaleDefines the minimum scale to be used for the editor.protected intminimumHeightprotected intminimumWidthprotected booleanreplaceLinefeedsSpecifies if linefeeds should be replaced with BREAKS before editing, and BREAKS should be replaced with linefeeds after editing.protected javax.swing.JScrollPanescrollPaneprotected booleanshiftEnterSubmitsTextSpecifies if shift ENTER should submit text if enterStopsCellEditing is true.protected javax.swing.JTextAreatextAreaHolds the editor for plain text editing.protected javax.swing.AbstractActiontextSubmitActionprotected java.util.EventObjecttrigger
-
Constructor Summary
Constructors Constructor Description mxCellEditor(mxGraphComponent graphComponent)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidconfigureActionMaps()Installs the keyListener in the textArea and editorPane for handling the enter keystroke and updating the modified state.java.lang.StringgetCurrentValue()Returns the current editing value.java.lang.ObjectgetEditingCell()Returns the cell that is currently being edited.java.awt.ComponentgetEditor()Returns the current editor or null if no editing is in progress.java.awt.RectanglegetEditorBounds(mxCellState state, double scale)Returns the bounds to be used for the editor.protected java.lang.StringgetInitialValue(mxCellState state, java.util.EventObject trigger)Gets the initial editing value for the given cell.doublegetMinimumEditorScale()intgetMinimumHeight()intgetMinimumWidth()booleanisExtractHtmlBody()Returns replaceHtmlLinefeedsprotected booleanisHideLabel(mxCellState state)booleanisReplaceHtmlLinefeeds()Returns replaceHtmlLinefeedsbooleanisShiftEnterSubmitsText()Returns shiftEnterSubmitsTextvoidsetExtractHtmlBody(boolean value)Sets extractHtmlBodyvoidsetMinimumEditorScale(double minimumEditorScale)voidsetMinimumHeight(int minimumHeight)voidsetMinimumWidth(int minimumWidth)voidsetReplaceHtmlLinefeeds(boolean value)Sets replaceHtmlLinefeedsvoidsetShiftEnterSubmitsText(boolean value)Sets shiftEnterSubmitsTextvoidstartEditing(java.lang.Object cell, java.util.EventObject evt)Starts editing the given cell.voidstopEditing(boolean cancel)Stops the current editing.protected booleanuseLabelBounds(mxCellState state)Returns true if the label bounds of the state should be used for the editor.
-
-
-
Field Detail
-
DEFAULT_MIN_WIDTH
public static int DEFAULT_MIN_WIDTH
-
DEFAULT_MIN_HEIGHT
public static int DEFAULT_MIN_HEIGHT
-
DEFAULT_MINIMUM_EDITOR_SCALE
public static double DEFAULT_MINIMUM_EDITOR_SCALE
-
graphComponent
protected mxGraphComponent graphComponent
-
minimumEditorScale
protected double minimumEditorScale
Defines the minimum scale to be used for the editor. Set this to 0 if the font size in the editor
-
minimumWidth
protected int minimumWidth
-
minimumHeight
protected int minimumHeight
-
editingCell
protected transient java.lang.Object editingCell
-
trigger
protected transient java.util.EventObject trigger
-
scrollPane
protected transient javax.swing.JScrollPane scrollPane
-
textArea
protected transient javax.swing.JTextArea textArea
Holds the editor for plain text editing.
-
editorPane
protected transient javax.swing.JEditorPane editorPane
Holds the editor for HTML editing.
-
extractHtmlBody
protected boolean extractHtmlBody
Specifies if the text content of the HTML body should be extracted before and after editing for HTML markup. Default is true.
-
replaceLinefeeds
protected boolean replaceLinefeeds
Specifies if linefeeds should be replaced with BREAKS before editing, and BREAKS should be replaced with linefeeds after editing. This value is ignored if extractHtmlBody is false. Default is true.
-
shiftEnterSubmitsText
protected boolean shiftEnterSubmitsText
Specifies if shift ENTER should submit text if enterStopsCellEditing is true. Default is false.
-
cancelEditingAction
protected javax.swing.AbstractAction cancelEditingAction
-
textSubmitAction
protected javax.swing.AbstractAction textSubmitAction
-
-
Constructor Detail
-
mxCellEditor
public mxCellEditor(mxGraphComponent graphComponent)
-
-
Method Detail
-
isExtractHtmlBody
public boolean isExtractHtmlBody()
Returns replaceHtmlLinefeeds
-
setExtractHtmlBody
public void setExtractHtmlBody(boolean value)
Sets extractHtmlBody
-
isReplaceHtmlLinefeeds
public boolean isReplaceHtmlLinefeeds()
Returns replaceHtmlLinefeeds
-
setReplaceHtmlLinefeeds
public void setReplaceHtmlLinefeeds(boolean value)
Sets replaceHtmlLinefeeds
-
isShiftEnterSubmitsText
public boolean isShiftEnterSubmitsText()
Returns shiftEnterSubmitsText
-
setShiftEnterSubmitsText
public void setShiftEnterSubmitsText(boolean value)
Sets shiftEnterSubmitsText
-
configureActionMaps
protected void configureActionMaps()
Installs the keyListener in the textArea and editorPane for handling the enter keystroke and updating the modified state.
-
getEditor
public java.awt.Component getEditor()
Returns the current editor or null if no editing is in progress.
-
useLabelBounds
protected boolean useLabelBounds(mxCellState state)
Returns true if the label bounds of the state should be used for the editor.
-
getEditorBounds
public java.awt.Rectangle getEditorBounds(mxCellState state, double scale)
Returns the bounds to be used for the editor.
-
startEditing
public void startEditing(java.lang.Object cell, java.util.EventObject evt)Description copied from interface:mxICellEditorStarts editing the given cell.- Specified by:
startEditingin interfacemxICellEditor
-
isHideLabel
protected boolean isHideLabel(mxCellState state)
-
stopEditing
public void stopEditing(boolean cancel)
Description copied from interface:mxICellEditorStops the current editing.- Specified by:
stopEditingin interfacemxICellEditor
-
getInitialValue
protected java.lang.String getInitialValue(mxCellState state, java.util.EventObject trigger)
Gets the initial editing value for the given cell.
-
getCurrentValue
public java.lang.String getCurrentValue()
Returns the current editing value.
-
getEditingCell
public java.lang.Object getEditingCell()
Description copied from interface:mxICellEditorReturns the cell that is currently being edited.- Specified by:
getEditingCellin interfacemxICellEditor
-
getMinimumEditorScale
public double getMinimumEditorScale()
- Returns:
- the minimumEditorScale
-
setMinimumEditorScale
public void setMinimumEditorScale(double minimumEditorScale)
- Parameters:
minimumEditorScale- the minimumEditorScale to set
-
getMinimumWidth
public int getMinimumWidth()
- Returns:
- the minimumWidth
-
setMinimumWidth
public void setMinimumWidth(int minimumWidth)
- Parameters:
minimumWidth- the minimumWidth to set
-
getMinimumHeight
public int getMinimumHeight()
- Returns:
- the minimumHeight
-
setMinimumHeight
public void setMinimumHeight(int minimumHeight)
- Parameters:
minimumHeight- the minimumHeight to set
-
-