| 
 | JGraph X 1.4.1.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
com.mxgraph.swing.handler.mxCellMarker
public class mxCellMarker
Implements a mouse tracker that marks cells under the mouse.
 
 This class fires the following event:
 
 mxEvent.MARK fires in mark and unmark to notify the listener of a new cell
 under the mouse. The state property contains the mxCellState
 of the respective cell or null if no cell is under the mouse.
| Nested Class Summary | 
|---|
| Nested classes/interfaces inherited from class javax.swing.JComponent | 
|---|
| JComponent.AccessibleJComponent | 
| Nested classes/interfaces inherited from class java.awt.Container | 
|---|
| Container.AccessibleAWTContainer | 
| Nested classes/interfaces inherited from class java.awt.Component | 
|---|
| Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy | 
| Field Summary | |
|---|---|
| protected  Color | currentColorHolds the current marker color. | 
| static Stroke | DEFAULT_STROKESpecifies the default stroke for the marker. | 
| protected  boolean | enabledSpecifies if the marker is enabled. | 
| protected  mxEventSource | eventSourceHolds the event source. | 
| protected  mxGraphComponent | graphComponentHolds the enclosing graph component. | 
| protected  double | hotspotSpecifies the portion of the width and height that should trigger a highlight. | 
| protected  boolean | hotspotEnabledSpecifies if the hotspot is enabled. | 
| protected  Color | invalidColorSpecifies the valid- and invalidColor for the marker. | 
| static boolean | KEEP_ON_TOPSpecifies if the highlights should appear on top of everything else in the overlay pane. | 
| protected  mxCellState | markedStateHolds the marked state. | 
| protected  boolean | swimlaneContentEnabledSpecifies if the the content area of swimlane should be non-transparent to mouse events. | 
| protected  Color | validColorSpecifies the valid- and invalidColor for the marker. | 
| protected  mxCellState | validStateHolds the marked state if it is valid. | 
| Fields inherited from class javax.swing.JComponent | 
|---|
| accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW | 
| Fields inherited from class java.awt.Component | 
|---|
| BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT | 
| Fields inherited from interface java.awt.image.ImageObserver | 
|---|
| ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH | 
| Constructor Summary | |
|---|---|
| mxCellMarker(mxGraphComponent graphComponent)Constructs a new marker for the given graph component. | |
| mxCellMarker(mxGraphComponent graphComponent,
             Color validColor)Constructs a new marker for the given graph component. | |
| mxCellMarker(mxGraphComponent graphComponent,
             Color validColor,
             Color invalidColor)Constructs a new marker for the given graph component. | |
| mxCellMarker(mxGraphComponent graphComponent,
             Color validColor,
             Color invalidColor,
             double hotspot)Constructs a new marker for the given graph component. | |
| Method Summary | |
|---|---|
|  void | addListener(String eventName,
            mxEventSource.mxIEventListener listener)Adds the given event listener. | 
| protected  Object | getCell(MouseEvent e)Returns the state at the given location. | 
|  Color | getCurrentColor()Returns the current color. | 
|  double | getHotspot()Returns the hotspot. | 
|  Color | getInvalidColor()Returns the color used for invalid highlights. | 
|  mxCellState | getMarkedState()Returns the marked state. | 
| protected  Color | getMarkerColor(MouseEvent e,
               mxCellState state,
               boolean isValid)Returns the valid- or invalidColor depending on the value of isValid. | 
| protected  mxCellState | getState(MouseEvent e)Uses getCell, getMarkedState and intersects to return the state for the given event. | 
| protected  mxCellState | getStateToMark(mxCellState state)Returns the state to be marked for the given state under the mouse. | 
|  Color | getValidColor()Returns the color used for valid highlights. | 
|  mxCellState | getValidState()Returns the valid state. | 
|  boolean | hasValidState()Returns true if validState is not null. | 
| protected  boolean | intersects(mxCellState state,
           MouseEvent e)Returns true if the given mouse event intersects the given state. | 
|  boolean | isEnabled()Returns true if the marker is enabled, that is, if it processes events in process. | 
|  boolean | isHotspotEnabled()Returns true if hotspot is used in intersects. | 
|  boolean | isSwimlaneContentEnabled()Returns true if the content area of swimlanes is non-transparent to events. | 
| protected  boolean | isValidState(mxCellState state)Returns true if the given state is a valid state. | 
|  void | mark()Marks the markedState and fires a mxEvent.MARK event. | 
|  void | paint(Graphics g)Paints the outline of the markedState with the currentColor. | 
|  mxCellState | process(MouseEvent e)Processes the given event and marks the state returned by getStateAt with the color returned by getMarkerColor. | 
|  void | removeListener(mxEventSource.mxIEventListener listener)Removes the given event listener. | 
|  void | removeListener(mxEventSource.mxIEventListener listener,
               String eventName)Removes the given event listener for the specified event name. | 
|  void | reset()Resets the state of the cell marker. | 
|  void | setCurrentColor(Color value)Sets the current color. | 
|  void | setEnabled(boolean enabled)Sets the enabled state of the marker. | 
|  void | setHotspot(double hotspot)Sets the hotspot. | 
|  void | setHotspotEnabled(boolean enabled)Specifies whether the hotspot should be used in intersects. | 
|  void | setInvalidColor(Color value)Sets the color used for invalid highlights. | 
|  void | setMarkedState(mxCellState value)Sets the marked state. | 
|  void | setSwimlaneContentEnabled(boolean swimlaneContentEnabled)Sets if the content area of swimlanes should not be transparent to events. | 
|  void | setValidColor(Color value)Sets the color used for valid highlights. | 
|  void | unmark()Hides the marker and fires a mxEvent.MARK event. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
|---|
public static boolean KEEP_ON_TOP
public static Stroke DEFAULT_STROKE
protected mxEventSource eventSource
protected mxGraphComponent graphComponent
protected boolean enabled
protected double hotspot
protected boolean hotspotEnabled
protected boolean swimlaneContentEnabled
protected Color validColor
protected Color invalidColor
protected transient Color currentColor
protected transient mxCellState validState
protected transient mxCellState markedState
| Constructor Detail | 
|---|
public mxCellMarker(mxGraphComponent graphComponent)
graphComponent - 
public mxCellMarker(mxGraphComponent graphComponent,
                    Color validColor)
public mxCellMarker(mxGraphComponent graphComponent,
                    Color validColor,
                    Color invalidColor)
public mxCellMarker(mxGraphComponent graphComponent,
                    Color validColor,
                    Color invalidColor,
                    double hotspot)
| Method Detail | 
|---|
public void setEnabled(boolean enabled)
setEnabled in class JComponentpublic boolean isEnabled()
isEnabled in class Componentpublic void setHotspot(double hotspot)
public double getHotspot()
public void setHotspotEnabled(boolean enabled)
public boolean isHotspotEnabled()
public void setSwimlaneContentEnabled(boolean swimlaneContentEnabled)
public boolean isSwimlaneContentEnabled()
public void setValidColor(Color value)
public Color getValidColor()
public void setInvalidColor(Color value)
public Color getInvalidColor()
public boolean hasValidState()
public mxCellState getValidState()
public void setCurrentColor(Color value)
public Color getCurrentColor()
public void setMarkedState(mxCellState value)
public mxCellState getMarkedState()
public void reset()
public mxCellState process(MouseEvent e)
public void mark()
public void unmark()
protected boolean isValidState(mxCellState state)
protected Color getMarkerColor(MouseEvent e,
                               mxCellState state,
                               boolean isValid)
protected mxCellState getState(MouseEvent e)
protected Object getCell(MouseEvent e)
protected mxCellState getStateToMark(mxCellState state)
protected boolean intersects(mxCellState state,
                             MouseEvent e)
public void addListener(String eventName,
                        mxEventSource.mxIEventListener listener)
public void removeListener(mxEventSource.mxIEventListener listener)
public void removeListener(mxEventSource.mxIEventListener listener,
                           String eventName)
public void paint(Graphics g)
paint in class JComponent| 
 | JGraph X 1.4.1.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||