com.ontimize.gui.field

Class HtmlHelpField

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

All Implemented Interfaces:

AccessForm, FormComponent, IdentifiedElement, Internationalization, SecureElement, ImageObserver, MenuContainer, Serializable, EventListener, HyperlinkListener

public class HtmlHelpField
extends IdentifiedAbstractFormComponent
implements HyperlinkListener

HTML component with hyperlinks to invoke some different actions in the form elements.

Shown text is the component template parameter value. This value can be one of the following three possibilities:

• Template = The HTML text to show.
• Template = HTML file path with the text to show.
• Template = Value existing in the application bundle file with the translation. Translation value can be one of the previous options (text or path)

The hyperlinks in the html text are actions to execute in the form elements.
This actions can be configured using the element attribute and the method name.
For example:

 <html>
    <body>
      <a href="ETableEntityName.openInsertDetailForm()"><img src="com/ontimize/gui/images/detail.png">Show the insertion form from table ETableEntityName</a>
      <a href="EPacketsItems.openDetailForm(getSelectedRow())">Open the detail form with the selected data</a>
      <a href="query.doClick()">Do click in the form query button</a>
    </body>
 </html>
 

See parameters: init(Hashtable)

Author:

Imatia Innovation SL

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HtmlHelpField.ParameterInfo

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 Hashtable	currentData
protected String	currentSeparator
protected String	currentTemplate
protected boolean	horizontalScroll
protected CustomEditorPane	htmlViewer
protected String	originalTemplate Variables useful to show the same template with different values in it
protected boolean	scrollable
protected boolean	verticalScroll

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

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

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

DEBUG_LANGUAGE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
HtmlHelpField(Hashtable p)

Method Summary

Methods

Modifier and Type	Method and Description
void	clean()
protected void	doAction(Object ob, String action)
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
String	getCurrentTemplate()
List	getDataFieldNames(String template, String separator)
protected Method	getMethod(Object ob, String methodName, HtmlHelpField.ParameterInfo[] parameters)
protected Method	getNonPublicMethod(Class c, String methodName, Class[] paramsClasss)
protected HtmlHelpField.ParameterInfo	getParameterInfo(Object ob, String param)
protected String[]	getParameters(String paramString)
Dimension	getPreferredSize()
protected String	getTemplateText(String templatePath)
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
protected String	getTranslateTemplate(ResourceBundle resourceBundle)
JEditorPane	getViewer()
void	hyperlinkUpdate(HyperlinkEvent evt)
void	init(Hashtable parameters) Initialize the component with the following parameters:
void	setData(Hashtable data, String separator)
void	setPaint(Paint paint)
void	setResourceBundle(ResourceBundle resourceBundle) Sets the language resource bundle.
void	setText(String text_path)
void	showHtml(String templatePath, Hashtable dictionary)

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

setComponentLocale

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setFont, 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, 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, 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, setEnabled, setVisible

Field Detail

htmlViewer

protected CustomEditorPane htmlViewer

horizontalScroll

protected boolean horizontalScroll

verticalScroll

protected boolean verticalScroll

scrollable

protected boolean scrollable

originalTemplate

protected String originalTemplate

Variables useful to show the same template with different values in it

currentTemplate

protected String currentTemplate

currentData

protected Hashtable currentData

currentSeparator

protected String currentSeparator

Constructor Detail

HtmlHelpField

public HtmlHelpField(Hashtable p)
              throws Exception

Throws:

Exception

Method Detail

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

init

public void init(Hashtable parameters)

Initialize the component with the following parameters:

Specified by:

init in interface FormComponent

Overrides:

init in class IdentifiedAbstractFormComponent

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
attr			yes	Attribute for field.
template			yes	Complete path to html template.
scroll			no	Specifies whether the component must use an scroll or not.
scrollh			no	Adjust the component to use horizontal scroll.
scrollv			no	Adjust the component to use vertical scroll.
paint			no	Fixes specified paint for viewer.
maxwidth			no	Maximum width for component.
opaque		yes	no	The opacity condition for component. By default, it is opaque.

setResourceBundle

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

Parameters:

resourceBundle - the new language bundle.

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

Overrides:

getTextsToTranslate in class AbstractFormComponent

Returns:

all the texts in the element suitable for being translated.

getTranslateTemplate

protected String getTranslateTemplate(ResourceBundle resourceBundle)

setText

public void setText(String text_path)

getCurrentTemplate

public String getCurrentTemplate()

getTemplateText

protected String getTemplateText(String templatePath)

getDataFieldNames

public List getDataFieldNames(String template,
                     String separator)

showHtml

public void showHtml(String templatePath,
            Hashtable dictionary)

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

Overrides:

getConstraints in class AbstractFormComponent

Parameters:

parentLayout - the parent container reference

Returns:

the constraints for the component

setData

public void setData(Hashtable data,
           String separator)

clean

public void clean()

hyperlinkUpdate

public void hyperlinkUpdate(HyperlinkEvent evt)

Specified by:

hyperlinkUpdate in interface HyperlinkListener

doAction

protected void doAction(Object ob,
            String action)
                 throws Exception

Throws:

Exception

setPaint

public void setPaint(Paint paint)

getViewer

public JEditorPane getViewer()

getParameterInfo

protected HtmlHelpField.ParameterInfo getParameterInfo(Object ob,
                                           String param)
                                                throws Exception

Throws:

Exception

getMethod

protected Method getMethod(Object ob,
               String methodName,
               HtmlHelpField.ParameterInfo[] parameters)
                    throws Exception

Throws:

Exception

getNonPublicMethod

protected Method getNonPublicMethod(Class c,
                        String methodName,
                        Class[] paramsClasss)
                             throws Exception

Throws:

Exception

getParameters

protected String[] getParameters(String paramString)