com.ontimize.gui.field
Class XMLDataField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.ontimize.gui.field.DataField
                      com.ontimize.gui.field.MemoDataField
                          com.ontimize.gui.field.XMLDataField

All Implemented Interfaces:

AccessForm, javax.accessibility.Accessible, ApplicationPreferencesListener, DataComponent, java.util.EventListener, FormComponent, Freeable, HasHelpIdComponent, HasPreferenceComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, OpenDialog, SecureElement, java.io.Serializable, ValueChangeDataComponent

public class XMLDataField

extends MemoDataField

This class implements a MemoDataField extension indicated to XML syntax.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class com.ontimize.gui.field.MemoDataField

MemoDataField.InnerDocumentListener

Nested classes inherited from class com.ontimize.gui.field.DataField

DataField.AuxPanel, DataField.CopyActionListener, DataField.ELabel, DataField.FieldButton, DataField.FieldFocusListener, DataField.InfoMouseListener, DataField.ToggleButton

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String	analyzeKey The key for XML analyse.
protected javax.swing.JMenuItem	analyzeMenu An instance of analyze menu item.
static boolean	DEBUG For debugging mode.
protected javax.xml.parsers.DocumentBuilder	docB A reference to document builder.
protected javax.xml.parsers.DocumentBuilderFactory	docBFactory A reference to document factory.
protected javax.swing.text.SimpleAttributeSet	errorTextAttribute An instance for error text attribute.
protected boolean	format
protected javax.swing.JMenuItem	indentItem
static java.lang.String	indentKey
protected int	indentSize
protected javax.swing.text.SimpleAttributeSet	oKTextAttribute An instance for OK text attribute.

Fields inherited from class com.ontimize.gui.field.MemoDataField

activationScrollTip, DE, dQuery, expandVertical, innerListener, maximumTextLength, parentFrame, queryKey, rows, scroll, scrollTip, searchMenu, selectAllKey, selectAllMenu, sqlTypeText, tabTransferFocus, translateDE, undoManager, uppercase, WHITE_SPACE

Fields inherited from class com.ontimize.gui.field.DataField

advancedQueryMode, ALIGN, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, alignment, ASTERISK_REQUIRED_STYLE, ATTR, attribute, backgroundColor, BGCOLOR, bold, BOLD, BORDER, BORDER_REQUIRED_STYLE, borderText, BOTTOM, CENTER, CLIPBOARD_COPY, CLIPBOARD_COPY_es_ES, CLIPBOARD_CUT, CLIPBOARD_CUT_es_ES, CLIPBOARD_PASTE, CLIPBOARD_PASTE_es_ES, conditions, dataField, DEFAULT_BORDER, DEFAULT_BOTTOM_MARGIN, DEFAULT_FIELD_LEFT_MARGIN, DEFAULT_FIELD_RIGHT_MARGIN, DEFAULT_LABEL_LEFT_MARGIN, DEFAULT_LABEL_RIGHT_MARGIN, DEFAULT_PARENT_MARGIN, DEFAULT_PARENT_MARGIN_FOR_SCROLL, DEFAULT_TOP_MARGIN, defaultAsteriskColor, DEFAULTBORDER, defaultDisableBackgroundColor, defaultFieldButtonHigh, defaultPreferenceTextNotRetrievedFromPreferences, DEFINE_HELP_FIELD_PREFERENCE, dim, DIM, disabledbgcolor, DISABLEDBGCOLOR, empty, enabled, ENABLED, FIELD_HELP_TIP, fieldlistenerFocus, fieldSize, fireValueEvents, FOCUS_BACKGROUNDCOLOR, FONT, fontColor, FONTCOLOR, fontSize, FONTSIZE, height, HEIGHT, incrementalFont, initPreferenceHelpText, isEnabled, LABELALIGN, labelComponent, LABELFONT, LABELFONTCOLOR, labelPosition, LABELPOSITION, LABELSIZE, labelText, LABELVISIBLE, LEFT, locale, LOWERED, menuCopy, menuCut, menuDefineHelpPreference, menuHelpPreferences, menuPaste, modifiable, NO_STR, NONE, noRequiredBorder, OPAQUE, originalSize, OUTBORDER, panel, parentForm, permissionActivate, permissionVisible, popupMenu, RAISED, redimensionPanel, redimensJTextField, required, REQUIRED, requiredBorder, REQUIREDBORDER, requiredFieldBackgroundColor, resources, restricted, RIGHT, show, showLabel, SIZE, TEXT_STR, TEXTALIGN, textAlignment, textHelpPreference, TIP, tipKey, TOP, validData, VALIGN, Valignment, valueListener, valueSave, VISIBLE, VISUALIZE_HELP_FIELD_PREFERENCE, weightDataFieldH, weightPanelH, width, WIDTH, x, X, y, Y, YES_STR

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 com.ontimize.gui.field.DataComponent

COMP_FOCUS_YELLOW, GREEN_VERY_LIGHT, LIGHT_GRAY_BLUE, LIGHT_GREYISH_BLUE, VERY_LIGHT_BLUE, VERY_LIGHT_GRAY, VERY_LIGHT_PINK, VERY_LIGHT_RED, VERY_LIGHT_SKYBLUE, VERY_LIGHT_YELLOW, VERY_LIGHT_YELLOW_2

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, PROPERTIES, SOMEBITS

Constructor Summary

XMLDataField(java.util.Hashtable parameters)
The class constructor.

Method Summary

protected void	createDataField() Creates the field and overrides the JComponent.processKeyEvent(KeyEvent) method for managing focus.
protected void	createPopupMenu() Creates a pop-up menu.
java.lang.String	doFormat(java.lang.String xml) Reflow XML
int	getEndLineOffset(int line) Gets the end line offset.
protected java.lang.String	getIndentText()
int	getStartLineOffset(int line) Gets the start line offset.
java.util.Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
boolean	hasErrors() Checks the field errors.
void	init(java.util.Hashtable params) Initializes parameters.
protected void	setErrorAttributes(int offsetIni, int length) Sets the error attributes.
protected void	setOkAttributes(int offsetIni, int lenght) Sets the OK attributes.
void	setResourceBundle(java.util.ResourceBundle res) Sets the language resource bundle.
void	setValue(java.lang.Object value) Sets the value for component.
boolean	showErrors() Parses XML and shows incorrect buildings.
protected void	showPopupMenu(java.awt.Component s, int x, int y) Shows the pop-up menu.

Methods inherited from class com.ontimize.gui.field.MemoDataField

deleteData, enableInnerListener, free, getConstraints, getRowNumber, getSQLDataType, getText, getValue, hideScrollTip, installInnerListener, installScrollListener, isEmpty, registerUndoableListener, registerUndoRedoActions, setComponentLocale, setMaxLength, setParentFrame, showScrollTip, updateBackgroundColor

Methods inherited from class com.ontimize.gui.field.DataField

addFocusListener, addHelpMenuPopup, addValueChangeListener, changeButton, changeOpacity, checkDefineHelpPermission, checkEnabledPermission, checkVisiblePermission, configurePopupMenuHelp, createFocusListener, createInstanceConditionCombo, defineHelpField, finalize, fireValueChanged, getAttribute, getBorder, getDataField, getDisabledbgcolor, getFontColor, getHelpIdString, getHelpPreferenceKey, getLabelComponent, getLabelComponentText, getLabelFontColor, getLabelText, getParentForm, getPreferenceHelpText, getValueChangeListeners, hasHelpInPreferences, initPermissions, initPreferences, installFocusListener, installHelpId, installPopupMenuListener, installPreferenceHelpListener, isAdvancedQueryMode, isEnabled, isHidden, isLabelVisible, isModifiable, isModified, isRequired, isRestricted, parseBoolean, preferenceChanged, removeFocusListener, removeValueChangeListener, requestFocus, seeHelpField, setBold, setDisabledbgcolor, setEnabled, setFont, setFontColor, setFontSize, setLabelFontColor, setModifiable, setParentForm, setRequired, setRequiredFieldBackground, setVisible, updateBackgroundColor, updateFont, updateTip, updateUI, validateComponentPositions

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEBUG

public static boolean DEBUG

For debugging mode. By default, false.

docBFactory

protected javax.xml.parsers.DocumentBuilderFactory docBFactory

A reference to document factory. By default, null.

docB

protected javax.xml.parsers.DocumentBuilder docB

A reference to document builder. By default, null.

errorTextAttribute

protected javax.swing.text.SimpleAttributeSet errorTextAttribute

An instance for error text attribute.

oKTextAttribute

protected javax.swing.text.SimpleAttributeSet oKTextAttribute

An instance for OK text attribute.

analyzeKey

public static java.lang.String analyzeKey

The key for XML analyse.

analyzeMenu

protected javax.swing.JMenuItem analyzeMenu

An instance of analyze menu item.

indentItem

protected javax.swing.JMenuItem indentItem

indentKey

public static java.lang.String indentKey

format

protected boolean format

indentSize

protected int indentSize

Constructor Detail

XMLDataField

public XMLDataField(java.util.Hashtable parameters)
             throws java.lang.Exception

The class constructor. Calls to super() with parameters. This field has not additional XML parameters.

Parameters:

parameters - the Hashtable with parameters

Throws:

java.lang.Exception - when an Exception occurs

Method Detail

init

public void init(java.util.Hashtable params)

Description copied from class: MemoDataField

Initializes parameters.

Specified by:

init in interface FormComponent

Overrides:

init in class MemoDataField

Parameters:

params - the hashtable with parameters

attribute	values	default	required	meaning
sqltexttype	yes/no	no	no	no -> Varchar ; yes -> LongVarchar.
uppercase	yes/no	no	no	The uppercase condition.
rows			no	The number of rows.
maxlength			no	The maxlength for component.
expand	yes/no		no	The vertical expansion.

createPopupMenu

protected void createPopupMenu()

Description copied from class: DataField

Creates a pop-up menu.

Overrides:

createPopupMenu in class MemoDataField

showPopupMenu

protected void showPopupMenu(java.awt.Component s,
                             int x,
                             int y)

Description copied from class: DataField

Shows the pop-up menu.

Overrides:

showPopupMenu in class MemoDataField

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle res)

Description copied from interface: Internationalization

Sets the language resource bundle. When the application changes the configured language, for all the objects that implement this interface this method must be called with the new file.
The method must translate all the elements that have texts in the GUI

Specified by:

setResourceBundle in interface Internationalization

Overrides:

setResourceBundle in class MemoDataField

getTextsToTranslate

public java.util.Vector getTextsToTranslate()

Description copied from interface: Internationalization

Returns all the texts in the element suitable for being translated.

Specified by:

getTextsToTranslate in interface Internationalization

Overrides:

getTextsToTranslate in class MemoDataField

setValue

public void setValue(java.lang.Object value)

Description copied from interface: DataComponent

Sets the value for component.

Specified by:

setValue in interface DataComponent

Overrides:

setValue in class MemoDataField

hasErrors

public boolean hasErrors()

Checks the field errors.

Returns:

the error condition

showErrors

public boolean showErrors()

Parses XML and shows incorrect buildings.

Returns:

the correct or incorrect parsed condition

getStartLineOffset

public int getStartLineOffset(int line)

Gets the start line offset.

Parameters:

line - the line to get start line offset

Returns:

the line offset value

getEndLineOffset

public int getEndLineOffset(int line)

Gets the end line offset.

Parameters:

line - the line to get end line offset

Returns:

the line offset value

setErrorAttributes

protected void setErrorAttributes(int offsetIni,
                                  int length)

Sets the error attributes.

Parameters:

offsetIni - the initial offset position

length - the length

setOkAttributes

protected void setOkAttributes(int offsetIni,
                               int lenght)

Sets the OK attributes.

Parameters:

offsetIni - the initial offset position

lenght - the length

createDataField

protected void createDataField()

Description copied from class: MemoDataField

Creates the field and overrides the JComponent.processKeyEvent(KeyEvent) method for managing focus.

Overrides:

createDataField in class MemoDataField

getIndentText

protected java.lang.String getIndentText()

doFormat

public java.lang.String doFormat(java.lang.String xml)

Reflow XML