codeblockutil
Class LabelWidget

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by codeblockutil.LabelWidget
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public abstract class LabelWidget
extends javax.swing.JComponent

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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
 
Field Summary
static int DROP_DOWN_MENU_WIDTH
           
 
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
LabelWidget(java.lang.String initLabelText, java.awt.Color fieldColor, java.awt.Color tooltipBackground)
          BlockLabel Constructor that takes in BlockID as well.
 
Method Summary
 void addKeyListenerToTextField(java.awt.event.KeyListener l)
           
 void addMouseListenerToLabel(java.awt.event.MouseListener l)
           
 void addMouseMotionListenerToLabel(java.awt.event.MouseMotionListener l)
           
 void assignToolTipToLabel(java.lang.String text)
          sets the tool tip of the label
 boolean canProcessNegativeSign()
          returns true if this block should can accept a negative sign
 boolean editingText()
          editingText returns if BlockLable is being edited
protected abstract  void fireDimensionsChanged(java.awt.Dimension value)
           
protected abstract  void fireGenusChanged(java.lang.String value)
           
protected abstract  void fireTextChanged(java.lang.String value)
           
 java.lang.String getText()
          getText
 boolean hasSiblings()
           
 void highlightText()
          high lights the text of the editing text field from 0 to the end of textfield
 boolean isEditable()
          isEditable returns if BlockLable is editable
 boolean isNumeric()
          isEditable returns if BlockLable is editable
protected abstract  boolean isTextValid(java.lang.String text)
           
 void setEditable(boolean isEditable)
          setEditable state of BlockLabel
 void setEditingState(boolean editing)
          setEditingState sets the current editing state of the BlockLabel.
 void setFont(java.awt.Font font)
          set up fonts
 void setNumeric(boolean isNumber)
           
 void setSiblings(boolean hasSiblings, java.lang.String[][] siblings)
           
 void setText(boolean bool)
          setText to a boolean
 void setText(double value)
          setText to a NumberFormatted double
 void setText(java.lang.String string)
          setText to a String (trimmed to remove excess spaces)
 void setZoomLevel(double newZoom)
           
 void showMenuIcon(boolean show)
           
protected  void suggestEditable(boolean suggest)
          Toggles the visual suggestion that this label may be editable depending on the specified suggest flag and properties of the block and label.
 java.lang.String toString()
           
 void updateLabelText(java.lang.String text)
          updateLabelText updates labelText and sychronizes textField and textLabel to it
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, 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, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, hide, 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, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DROP_DOWN_MENU_WIDTH

public static final int DROP_DOWN_MENU_WIDTH
See Also:
Constant Field Values
Constructor Detail

LabelWidget

public LabelWidget(java.lang.String initLabelText,
                   java.awt.Color fieldColor,
                   java.awt.Color tooltipBackground)
BlockLabel Constructor that takes in BlockID as well. Unfortunately BlockID is needed, so the label can redirect mouse actions.

Parameters:
zoom -
Method Detail

fireTextChanged

protected abstract void fireTextChanged(java.lang.String value)

fireGenusChanged

protected abstract void fireGenusChanged(java.lang.String value)

fireDimensionsChanged

protected abstract void fireDimensionsChanged(java.awt.Dimension value)

isTextValid

protected abstract boolean isTextValid(java.lang.String text)

addKeyListenerToTextField

public void addKeyListenerToTextField(java.awt.event.KeyListener l)

addMouseListenerToLabel

public void addMouseListenerToLabel(java.awt.event.MouseListener l)

addMouseMotionListenerToLabel

public void addMouseMotionListenerToLabel(java.awt.event.MouseMotionListener l)

showMenuIcon

public void showMenuIcon(boolean show)

setEditingState

public void setEditingState(boolean editing)
setEditingState sets the current editing state of the BlockLabel. Repaints BlockLabel to reflect the change.


editingText

public boolean editingText()
editingText returns if BlockLable is being edited

Returns:
editingText

setEditable

public void setEditable(boolean isEditable)
setEditable state of BlockLabel

Parameters:
isEditable - specifying editable state of BlockLabel

isEditable

public boolean isEditable()
isEditable returns if BlockLable is editable

Returns:
isEditable

setNumeric

public void setNumeric(boolean isNumber)

isNumeric

public boolean isNumeric()
isEditable returns if BlockLable is editable

Returns:
isEditable

setSiblings

public void setSiblings(boolean hasSiblings,
                        java.lang.String[][] siblings)

hasSiblings

public boolean hasSiblings()

setFont

public void setFont(java.awt.Font font)
set up fonts

Overrides:
setFont in class javax.swing.JComponent
Parameters:
font -

assignToolTipToLabel

public void assignToolTipToLabel(java.lang.String text)
sets the tool tip of the label


getText

public java.lang.String getText()
getText

Returns:
String of the current BlockLabel

setText

public void setText(double value)
setText to a NumberFormatted double

Parameters:
value -

setText

public void setText(java.lang.String string)
setText to a String (trimmed to remove excess spaces)

Parameters:
string -

setText

public void setText(boolean bool)
setText to a boolean

Parameters:
bool -

updateLabelText

public void updateLabelText(java.lang.String text)
updateLabelText updates labelText and sychronizes textField and textLabel to it

Parameters:
text -

highlightText

public void highlightText()
high lights the text of the editing text field from 0 to the end of textfield


suggestEditable

protected void suggestEditable(boolean suggest)
Toggles the visual suggestion that this label may be editable depending on the specified suggest flag and properties of the block and label. If suggest is true, the visual suggestion will display. Otherwise, nothing is shown. For now, the visual suggestion is a simple white line boder. Other requirements for indicator to show: - label type must be NAME - label must be editable - block can not be a factory block

Parameters:
suggest -

setZoomLevel

public void setZoomLevel(double newZoom)

toString

public java.lang.String toString()
Overrides:
toString in class java.awt.Component

canProcessNegativeSign

public boolean canProcessNegativeSign()
returns true if this block should can accept a negative sign