de.cbse.jeasy
Class JEHelp

java.lang.Object
  de.cbse.jeasy.JEObject
      de.cbse.jeasy.JEHelp

public class JEHelp
extends JEObject

The JEHelp offers a connection to an editorpane. Every time the JEHelp is given an url or text or file, that will be loaded into the editorpane. Use it to build up a context help system.

Properties :

• id
  The unique id of the root object.


• referenceId
  A reference for this jeasy object used to identify this type of jeasy object even if it was cloned. It is used for locale properties of the object and may be used for identification in messages. If no reference is set, the jeasy id will be set as default.


• url
  A string containing a URL specification.


• editorpane (reference to JEComponent)
  Specifies the jeasy id of an JEEditorPane.

Version:

%I%, %G%

Author:

Harry Pfohl

Field Summary

Fields inherited from class de.cbse.jeasy.JEObject

aaa, ACTIVITYBAR, ANIMATION, BORDER, BUSINESSOBJECT_NAME, BUTTON, BUTTONGROUP, CHECKBOX, CHECKBOXMENUITEM, COLOR, COMBOBOX, ComboBoxButtonWidth, COMBOLIST, CONSTRAINTS, CONTEXT_HELP_FOCUS_GAINED, CONTEXT_HELP_FOCUS_LOST, CONTEXT_HELP_MOUSE_ENTERED, CONTEXT_HELP_MOUSE_EXITED, DATAFIELD, DATATYPE, DESKTOPPANE, DIALOG, EDITORPANE, FONT, FORMAT, FRAME, GANTTGRID, GLOBAL, GRADIENTPAINT, HELP, ICON, ID_JESTART, INPUT_ERROR_DATE, INPUT_ERROR_LENGTH, INPUT_ERROR_MANDATORY, INPUT_ERROR_PARSE, INPUT_ERROR_RANGE, INPUT_ERROR_REGULAREXPRESSION, INPUT_ERROR_TIME, INPUT_ERRORS, INSETS, INTERNALFRAME, intType, LABEL, LIST, LOCALE, MENU, MENUBAR, MENUITEM, MESSAGE, METHODINVOCATION, NO_CONSTANT, NO_INPUT_ERROR, OPTIONPANE, PANEL, parentId, POPUP, PROGRESSBAR, PROPERTIE_NAME, propertyHashMap, RADIOBUTTON, RADIOBUTTONMENUITEM, refresh, SPINNER, SPLITPANE, START, STORE, STRING, TABBEDPANE, TABLE, TASKPANE, TEXTUREPAINT, THEME, TIPS, TOOLBAR, TREE, TREENODE, type, WINDOW

Constructor Summary

JEHelp(JELocaleProperties hm)
Reads the properties from a HashMap

JEHelp(JENode jen)
Constructor based on a XML file parsed to a TreeNode.

Method Summary

void	init() Creates Java or SWING objects with the given properties.
boolean	isAutoLoad() Gets whether a file should be loaded into JEEditorPane when setFile is called.
void	setAutoLoad(boolean autoLoad) Set to true means showing the file at once when setFile is called.
void	setFile(java.lang.String fileName) Sets the file to be displayed at the JEEditorPane
void	setText(java.lang.String text) Sets the text to be displayed at the JEEditorPane
void	setUrl(java.net.URL url) Sets the url to be displayed at the JEEditorPane
void	setUrlString(java.lang.String urlString) Sets the url to be displayed at the JEEditorPane
void	show() Shows the page set by file or url if the JEEditorPane is in front and shown to the user and if autoLoad ist set to true.

Methods inherited from class de.cbse.jeasy.JEObject

clearPreview, clone, getApplLocale, getBorderConstantProperty, getBorderProperty, getCharGProperty, getCharProperty, getColorProperty, getConstraintsProperty, getFontProperty, getGProperty, getGradientPaintProperty, getId, getImageConstantProperty, getImageIconProperty, getInsetsProperty, getJEGlobal, getJETexturePaintProperty, getLayoutProperty, getLocaleProperties, getObjectsHashMap, getObjectsNonPreviewHashMap, getParentId, getPreviewHashMap, getPreviewObject, getProjectDirectory, getPropertieHashMap, getProperty, getProperty, getPropertyAsArray, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsInteger, getPropertyAsObject, getPropertyAsObject, getPropertyAsVector, getPropertyAsVector, getReferenceButtonBehind, getReferenceId, getRegisterText, getResourceUrl, getRootPane, getRootPaneId, getSwingConstantProperty, getTabbedPaneConstantProperty, getTexturePaintProperty, getType, getUniqueNumber, hasSuperclass, invoke, invoke, invoke, invoke, isApplet, isEnterprise, isGlobalAnimation, isGlobalListening, isInited, isPreview, isPreviewMember, isProfessional, isRefresh, isSetuped, isStandard, registerJEObject, removeProperties, removeProperty, removeProperty, setApplet, setApplLocale, setGlobalAnimation, setGlobalListening, setInited, setJeGlobal, setLocaleProperties, setParentId, setPreview, setPreviewHashMap, setPreviewMember, setPreviewObject, setProjectDirectory, setPropertieHashMap, setProperties, setProperties, setProperty, setProperty, setRefresh, setRootPane, setRootPaneId, setSetuped, setType, setupComponent, show, timerTask

Methods inherited from class java.lang.Object

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

Constructor Detail

JEHelp

public JEHelp(JELocaleProperties hm)

Reads the properties from a HashMap

Parameters:

hm - HashMap

JEHelp

public JEHelp(JENode jen)

Constructor based on a XML file parsed to a TreeNode.

Parameters:

jen -

See Also:

JESaxParser

Method Detail

init

public void init()

Description copied from class: JEObject

Creates Java or SWING objects with the given properties.

Overrides:

init in class JEObject

setUrlString

public void setUrlString(java.lang.String urlString)

Sets the url to be displayed at the JEEditorPane

Parameters:

fileName -

setUrl

public void setUrl(java.net.URL url)

Sets the url to be displayed at the JEEditorPane

Parameters:

fileName -

setFile

public void setFile(java.lang.String fileName)

Sets the file to be displayed at the JEEditorPane

Parameters:

fileName -

setText

public void setText(java.lang.String text)

Sets the text to be displayed at the JEEditorPane

Parameters:

fileName -

show

public void show()

Shows the page set by file or url if the JEEditorPane is in front and shown to the user and if autoLoad ist set to true.

isAutoLoad

public boolean isAutoLoad()

Gets whether a file should be loaded into JEEditorPane when setFile is called.

Returns:

setAutoLoad

public void setAutoLoad(boolean autoLoad)

Set to true means showing the file at once when setFile is called. If is was false the last file will be shown.

Parameters:

autoLoad -