com.ontimize.gui.field

Class HTMLComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JEditorPane

javax.swing.JTextPane

com.ontimize.gui.field.HTMLComponent

All Implemented Interfaces:

AccessForm, FormComponent, IdentifiedElement, Internationalization, SecureElement, ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public class HTMLComponent
extends JTextPane
implements FormComponent, IdentifiedElement, AccessForm

This class implements a HTML editor component.

Author:

Imatia Innovation

See Also:

HTMLEditorKit, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HTMLComponent.ExtendedHTMLEditorKit This class implements an extension html editor where the document creation priority is set to minimum.

Nested classes/interfaces inherited from class javax.swing.JEditorPane

JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	attribute The reference to attribute.
protected FormPermission	enabledPermission The reference for enabled permission in form.
protected String	file The reference to the .html file.
protected Locale	locale The default locale reference.
protected Form	parentForm The reference to parent form.
protected boolean	restricted
protected FormPermission	visiblePermission The reference for visible permission in form.

Fields inherited from class javax.swing.JEditorPane

HONOR_DISPLAY_PROPERTIES, W3C_LENGTH_UNITS

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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

Constructors

Constructor and Description
HTMLComponent(Hashtable parameters) The class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkEnabledPermission()
protected boolean	checkVisiblePermission()
Object	getAttribute() Gets the object attribute.
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
void	init(Hashtable parameters) Initializes parameters and selects the bundle equals to class ResourceBundle, adding a suffix to basic file name.
void	initPermissions()
boolean	isRestricted()
protected void	loadPage(Locale l)
void	setComponentLocale(Locale l)
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setHTML(String html)
void	setParentForm(Form f) Method declaration to set the form that contains the component.
void	setResourceBundle(ResourceBundle res) Sets the language resource bundle.
void	setVisible(boolean visible) Description method to set visible or not the component according the boolean condition in parameter.
void	updateUI()

Methods inherited from class javax.swing.JTextPane

addStyle, createDefaultEditorKit, getCharacterAttributes, getInputAttributes, getLogicalStyle, getParagraphAttributes, getStyle, getStyledDocument, getStyledEditorKit, getUIClassID, insertComponent, insertIcon, paramString, removeStyle, replaceSelection, setCharacterAttributes, setDocument, setEditorKit, setLogicalStyle, setParagraphAttributes, setStyledDocument

Methods inherited from class javax.swing.JEditorPane

addHyperlinkListener, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitClassNameForContentType, getEditorKitForContentType, getHyperlinkListeners, getPage, getPreferredSize, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getStream, getText, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, scrollToReference, setContentType, setEditorKitForContentType, setPage, setPage, setText

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, 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, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, 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, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, 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

Field Detail

attribute

protected Object attribute

The reference to attribute. By default, null.

file

protected String file

The reference to the .html file.

locale

protected Locale locale

The default locale reference.

parentForm

protected Form parentForm

The reference to parent form. By default, false.

visiblePermission

protected FormPermission visiblePermission

The reference for visible permission in form. By default, null.

enabledPermission

protected FormPermission enabledPermission

The reference for enabled permission in form. By default, null.

restricted

protected boolean restricted

Constructor Detail

HTMLComponent

public HTMLComponent(Hashtable parameters)

The class constructor. Inits parameters, sets transparent and disables the edition in the component.

Parameters:

parameters - the Hashtable with parameters

Method Detail

init

public void init(Hashtable parameters)

Initializes parameters and selects the bundle equals to class ResourceBundle, adding a suffix to basic file name.

Specified by:

init in interface FormComponent

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
attr			yes	The attribute for component.
archive			yes	Associated file. The extension file must be .htm or .html.

getConstraints

public Object getConstraints(LayoutManager parentLayout)

Description copied from interface: FormComponent

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

Specified by:

getConstraints in interface FormComponent

Parameters:

parentLayout - the parent container reference

Returns:

the constraints for the component

getTextsToTranslate

public Vector getTextsToTranslate()

Description copied from interface: Internationalization

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

Specified by:

getTextsToTranslate in interface Internationalization

Returns:

all the texts in the element suitable for being translated.

setResourceBundle

public void setResourceBundle(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

Parameters:

res - the new language bundle.

setComponentLocale

public void setComponentLocale(Locale l)

Specified by:

setComponentLocale in interface Internationalization

getAttribute

public Object getAttribute()

Description copied from interface: IdentifiedElement

Gets the object attribute. This attribute allows to identify the object

Specified by:

getAttribute in interface IdentifiedElement

loadPage

protected void loadPage(Locale l)

updateUI

public void updateUI()

Overrides:

updateUI in class JTextComponent

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

Overrides:

setEnabled in class JComponent

Parameters:

enabled - the enabled condition

setVisible

public void setVisible(boolean visible)

Description copied from interface: FormComponent

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

Specified by:

setVisible in interface FormComponent

Overrides:

setVisible in class JComponent

Parameters:

visible - the visibility condition

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

checkVisiblePermission

protected boolean checkVisiblePermission()

checkEnabledPermission

protected boolean checkEnabledPermission()

setParentForm

public void setParentForm(Form f)

Description copied from interface: AccessForm

Method declaration to set the form that contains the component. This method must be called automatically during the form building.

Specified by:

setParentForm in interface AccessForm

Parameters:

f - the form reference

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface SecureElement

setHTML

public void setHTML(String html)