com.ontimize.gui.field
Class Form2HTMLDataField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.ontimize.gui.field.AbstractFormComponent
                  com.ontimize.gui.field.IdentifiedAbstractFormComponent
                      com.ontimize.gui.field.Form2HTMLDataField

All Implemented Interfaces:

AccessForm, java.awt.event.ActionListener, DataComponent, java.util.EventListener, FormComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, SecureElement, java.io.Serializable, ValueChangeDataComponent

public class Form2HTMLDataField

extends IdentifiedAbstractFormComponent

implements DataComponent, java.awt.event.ActionListener, Internationalization, ValueChangeDataComponent

The initializes parameters can be seen in init(Hashtable)

Since:

5.2057EN-0.5

Author:

Imatia Innovation S.L.

See Also:

Serialized Form

Nested Class Summary

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

protected javax.swing.JButton	apply
static java.lang.String	APPLY_TEXT
static java.lang.String	CSS_TAG
protected java.lang.String	cssContentFile
static java.lang.String	DEFAULT_HTML_PATTERN
static java.lang.String	ERROR_APPLYING_XSL
static java.lang.String	ERROR_XSL_NOT_VALID
protected boolean	fireValueEvents
protected XMLTextPane	html
static java.lang.String	HTML_TITLE_TAG
static java.lang.String	HTML_VIEWER_TAG
static java.lang.String	HTML_VIEWER_TITLE_TAG
protected javax.swing.JPanel	htmlEditorPanel
protected java.lang.String	htmlTitle
protected java.lang.String	htmlViewerTitle
protected javax.swing.JLabel	jlXSLLabel
protected javax.swing.JComponent	menuComponent
protected boolean	modifiable
protected javax.swing.JButton	navigator
static java.lang.String	NAVIGATOR_TEXT
static java.lang.String	PATTERN_BODY_TAG
static java.lang.String	PATTERN_STYLE_TAG
static java.lang.String	PATTERN_TAG
protected java.lang.String	patternContentFile
protected javax.swing.JButton	reload
static java.lang.String	RELOAD_TEXT
protected boolean	required
protected java.util.ResourceBundle	resourceBundle
protected javax.swing.JButton	right
static java.lang.String	SHOW_RIGHT_TEXT
protected javax.xml.transform.TransformerFactory	tFactory
protected javax.xml.transform.Transformer	transformer
protected java.util.List	valueListener
protected java.lang.String	valueSave
protected BasicHTMLViewer	viewer
static java.lang.String	XML_FIELD_ATTR_TAG
protected java.lang.String	xmlFieldAttr
static java.lang.String	XSL_LABEL_TAG
static java.lang.String	XSL_LIST_TAG
static java.lang.String	XSL_PARAMETERS_TAG
protected java.lang.String	xslLabel
protected javax.swing.JComboBox	xslList
protected java.util.Vector	xslListValues
protected java.util.Hashtable	xslParameters
static java.lang.String	ZOOM_IN_TEXT
static java.lang.String	ZOOM_OUT_TEXT
protected javax.swing.JButton	zoomIn
protected javax.swing.JButton	zoomOut

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

attribute, enabledPermission, parentForm, restricted, visiblePermission

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

defaultBottomMargin, defaultLeftMargin, defaultRightMargin, defaultTopMargin

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.field.FormComponent

DEBUG

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, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Form2HTMLDataField(java.util.Hashtable parameters)
This field transform an Ontimize Form in a HTML Form that can be view in a web browser.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
void	addValueChangeListener(ValueChangeListener l)
protected java.lang.String	appendString(java.lang.String base, java.lang.String toFind, java.lang.String toADD)
protected void	applyXSL()
protected java.lang.String	createHTML()
void	deleteData() The method to delete data for component.
static java.lang.String	fileToString(java.io.InputStream is)
protected void	fireValueChanged(java.lang.Object newValue, java.lang.Object oldValue, int type)
java.lang.Object	getConstraints(java.awt.LayoutManager arg0) Description method to return the constraints component to place correctly in parent container.
java.lang.String	getLabelComponentText() Returns the label text component.
int	getSQLDataType() Returns the sql data type according to java.sql.Types
java.lang.Object	getValue() Gets the value of a component.
void	init(java.util.Hashtable parameters) Initializes parameters.
boolean	isEmpty() Checks the data existence in component.
boolean	isHidden() Indicates to check the visibility condition for a component.
boolean	isModifiable() Checks the modifiable condition for a component.
boolean	isModified() This method should be return true when data have been modified.
boolean	isRequired() Indicates the required condition for a component.
protected void	openInBrowser()
void	removeValueChangeListener(ValueChangeListener l)
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setModifiable(boolean modifiable) Establishes the modifiable condition for a component.
void	setRequired(boolean required) Sets required a component according to condition.
void	setResourceBundle(java.util.ResourceBundle resourceBundle) Sets the language resource bundle.
void	setValue(java.lang.Object value) Sets the value for component.

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

checkEnabledPermission, checkVisiblePermission, getAttribute, getParentForm, initPermissions, isRestricted, setParentForm

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

getTextsToTranslate, setComponentLocale

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, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, 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, addFocusListener, 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, isEnabled, 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, removeFocusListener, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ontimize.gui.field.FormComponent

isEnabled, setVisible

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

getTextsToTranslate, setComponentLocale

Methods inherited from interface com.ontimize.gui.field.IdentifiedElement

getAttribute

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Field Detail

XSL_LIST_TAG

public static final java.lang.String XSL_LIST_TAG

See Also:

Constant Field Values

XSL_PARAMETERS_TAG

public static final java.lang.String XSL_PARAMETERS_TAG

See Also:

Constant Field Values

XML_FIELD_ATTR_TAG

public static final java.lang.String XML_FIELD_ATTR_TAG

See Also:

Constant Field Values

HTML_VIEWER_TAG

public static final java.lang.String HTML_VIEWER_TAG

See Also:

Constant Field Values

CSS_TAG

public static final java.lang.String CSS_TAG

See Also:

Constant Field Values

PATTERN_TAG

public static final java.lang.String PATTERN_TAG

See Also:

Constant Field Values

HTML_TITLE_TAG

public static final java.lang.String HTML_TITLE_TAG

See Also:

Constant Field Values

HTML_VIEWER_TITLE_TAG

public static final java.lang.String HTML_VIEWER_TITLE_TAG

See Also:

Constant Field Values

XSL_LABEL_TAG

public static final java.lang.String XSL_LABEL_TAG

See Also:

Constant Field Values

PATTERN_STYLE_TAG

public static final java.lang.String PATTERN_STYLE_TAG

See Also:

Constant Field Values

PATTERN_BODY_TAG

public static final java.lang.String PATTERN_BODY_TAG

See Also:

Constant Field Values

DEFAULT_HTML_PATTERN

public static final java.lang.String DEFAULT_HTML_PATTERN

See Also:

Constant Field Values

RELOAD_TEXT

public static final java.lang.String RELOAD_TEXT

See Also:

Constant Field Values

APPLY_TEXT

public static final java.lang.String APPLY_TEXT

See Also:

Constant Field Values

NAVIGATOR_TEXT

public static final java.lang.String NAVIGATOR_TEXT

See Also:

Constant Field Values

ZOOM_IN_TEXT

public static final java.lang.String ZOOM_IN_TEXT

See Also:

Constant Field Values

ZOOM_OUT_TEXT

public static final java.lang.String ZOOM_OUT_TEXT

See Also:

Constant Field Values

SHOW_RIGHT_TEXT

public static final java.lang.String SHOW_RIGHT_TEXT

See Also:

Constant Field Values

ERROR_XSL_NOT_VALID

public static final java.lang.String ERROR_XSL_NOT_VALID

See Also:

Constant Field Values

ERROR_APPLYING_XSL

public static final java.lang.String ERROR_APPLYING_XSL

See Also:

Constant Field Values

modifiable

protected boolean modifiable

required

protected boolean required

fireValueEvents

protected boolean fireValueEvents

valueSave

protected java.lang.String valueSave

valueListener

protected java.util.List valueListener

reload

protected javax.swing.JButton reload

apply

protected javax.swing.JButton apply

navigator

protected javax.swing.JButton navigator

zoomIn

protected javax.swing.JButton zoomIn

zoomOut

protected javax.swing.JButton zoomOut

right

protected javax.swing.JButton right

viewer

protected BasicHTMLViewer viewer

xslList

protected javax.swing.JComboBox xslList

xslParameters

protected java.util.Hashtable xslParameters

html

protected XMLTextPane html

xmlFieldAttr

protected java.lang.String xmlFieldAttr

cssContentFile

protected java.lang.String cssContentFile

patternContentFile

protected java.lang.String patternContentFile

htmlTitle

protected java.lang.String htmlTitle

htmlViewerTitle

protected java.lang.String htmlViewerTitle

xslLabel

protected java.lang.String xslLabel

menuComponent

protected javax.swing.JComponent menuComponent

jlXSLLabel

protected javax.swing.JLabel jlXSLLabel

htmlEditorPanel

protected javax.swing.JPanel htmlEditorPanel

resourceBundle

protected java.util.ResourceBundle resourceBundle

xslListValues

protected java.util.Vector xslListValues

tFactory

protected javax.xml.transform.TransformerFactory tFactory

transformer

protected javax.xml.transform.Transformer transformer

Constructor Detail

Form2HTMLDataField

public Form2HTMLDataField(java.util.Hashtable parameters)

This field transform an Ontimize Form in a HTML Form that can be view in a web browser.
It contains basically a HTML Editor, a HTML Viewer and a combo with the transform style-sheets.
This field takes the source from another field, refenreced by the xmlFieldAttr attribute,
then applies the xsl selected to the content, and stores the result in the component or in the
database. The component can also show the result of the transformation using the HTML viewer

Parameters:

parameters - The Hashtable with parameters

Method Detail

getConstraints

public java.lang.Object getConstraints(java.awt.LayoutManager arg0)

Description copied from interface: FormComponent

Description method to return the constraints component to place correctly in parent container.

Specified by:

getConstraints in interface FormComponent

Overrides:

getConstraints in class AbstractFormComponent

init

public void init(java.util.Hashtable parameters)

Initializes parameters.

Specified by:

init in interface FormComponent

Overrides:

init in class IdentifiedAbstractFormComponent

Parameters:

parameters - the Hashtable with parameters. Adds the next parameters:

attribute	values	default	required	meaning
attr			yes	attr of field
xmlFieldAttr			no	attr of the field where is stored the XML Form and which will be used for the transformations
htmlTitle			no	The text that will appear in the border of the HTML Field
htmlViewerTitle			no	The text that will appear in the border of the HTML Viewer Field
xslLabel			no	The text that will appear in the component
xslList	package.filename1.xsl;package.filename2.xsl;...		no	List of the XSL files that can be used form transform the XML File
xslParameters	param1=value1;param2=value2;...		no	List of parameters=values that will be applied to all XSL transformations
htmlViewer			no	Name of the class that will be used as a HTML Viewer
css			no	Name of the css file that will used by the viewer
pattern			no	Name of the pattern file that will used by the viewer

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: FormComponent

Description method to set enabled or not the component according the boolean condition in parameter.

Specified by:

setEnabled in interface FormComponent

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle resourceBundle)

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 AbstractFormComponent

getLabelComponentText

public java.lang.String getLabelComponentText()

Description copied from interface: DataComponent

Returns the label text component. This label will change according to the Locale.

Specified by:

getLabelComponentText in interface DataComponent

Returns:

the label text

getSQLDataType

public int getSQLDataType()

Description copied from interface: DataComponent

Returns the sql data type according to java.sql.Types

Specified by:

getSQLDataType in interface DataComponent

Returns:

the Integer type

isEmpty

public boolean isEmpty()

Description copied from interface: DataComponent

Checks the data existence in component.

Specified by:

isEmpty in interface DataComponent

Returns:

true when component is empty

isHidden

public boolean isHidden()

Description copied from interface: DataComponent

Indicates to check the visibility condition for a component.

Specified by:

isHidden in interface DataComponent

Returns:

the visibility condition

isModifiable

public boolean isModifiable()

Description copied from interface: DataComponent

Checks the modifiable condition for a component. It is useful when it is not desired form deletes a component value.

Specified by:

isModifiable in interface DataComponent

Returns:

true when component is modifiable

isModified

public boolean isModified()

Description copied from interface: DataComponent

This method should be return true when data have been modified. The method setValue() should be change this condition.

Specified by:

isModified in interface DataComponent

Returns:

the modified condition

isRequired

public boolean isRequired()

Description copied from interface: DataComponent

Indicates the required condition for a component.

Specified by:

isRequired in interface DataComponent

Returns:

the required condition

setModifiable

public void setModifiable(boolean modifiable)

Description copied from interface: DataComponent

Establishes the modifiable condition for a component. When component is not modifiable, data will not be deleted automatically in DeleteFields call.

Specified by:

setModifiable in interface DataComponent

Parameters:

modifiable - the boolean condition

setRequired

public void setRequired(boolean required)

Description copied from interface: DataComponent

Sets required a component according to condition.

Specified by:

setRequired in interface DataComponent

Parameters:

required - the required condition

setValue

public void setValue(java.lang.Object value)

Description copied from interface: DataComponent

Sets the value for component.

Specified by:

setValue in interface DataComponent

Parameters:

value - the object with value to set

getValue

public java.lang.Object getValue()

Description copied from interface: DataComponent

Gets the value of a component.

Specified by:

getValue in interface DataComponent

Returns:

the object with value.

deleteData

public void deleteData()

Description copied from interface: DataComponent

The method to delete data for component.

Specified by:

deleteData in interface DataComponent

fireValueChanged

protected void fireValueChanged(java.lang.Object newValue,
                                java.lang.Object oldValue,
                                int type)

addValueChangeListener

public void addValueChangeListener(ValueChangeListener l)

Specified by:

addValueChangeListener in interface ValueChangeDataComponent

removeValueChangeListener

public void removeValueChangeListener(ValueChangeListener l)

Specified by:

removeValueChangeListener in interface ValueChangeDataComponent

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

createHTML

protected java.lang.String createHTML()

openInBrowser

protected void openInBrowser()

applyXSL

protected void applyXSL()

appendString

protected java.lang.String appendString(java.lang.String base,
                                        java.lang.String toFind,
                                        java.lang.String toADD)

fileToString

public static java.lang.String fileToString(java.io.InputStream is)