SilverStream
Application Server 3.5

com.sssw.rt.form
Class AgcHTMLEditControl

java.lang.Object
 |
 +--java.awt.Component
       |
       +--java.awt.Container
             |
             +--javax.swing.JComponent
                   |
                   +--javax.swing.JPanel
                         |
                         +--com.sssw.rt.atlas.AtPanel
                               |
                               +--com.sssw.rt.rtcontrol.RTScrollPanel
                                     |
                                     +--com.sssw.rt.rteditor.RTEditor
                                           |
                                           +--com.sssw.rt.form.AgcHTMLEditControl
All Implemented Interfaces:
Accessible, ActionListener, AgiControl, AgiHelpInfo, AgiManualPropertyChange, AgiRTEditorEventProducer, ComponentListener, DropTargetListener, EventListener, FocusListener, ImageObserver, KeyListener, MenuContainer, MouseListener, MouseMotionListener, Serializable, WindowListener

public class AgcHTMLEditControl
extends com.sssw.rt.rteditor.RTEditor
implements AgiControl, AgiManualPropertyChange, AgiRTEditorEventProducer

The AgcHTMLEditControl (HTML Edit Control) is an HTML editor for creating and maintaining HTML content on a SilverStream form. It is not necessary to know HTML to use this control.

Properties:
Control Type, Data Column, Enabled, Height, Help Page, Image Dialog, Left, Link Dialog, Name, Raw HTML Dialog, Tool Tip, Toolbar, Top, Visible, Width
Events:
editorImageButtonClicked, editorLinkButtonClicked, editorObjectButtonClicked, focusGained, focusLost, htmlAnchorDetected, htmlAnchorSelected, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased
See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Field Summary
static Integer ALIGN_BOTTOM
          Symbolic value for VALIGN=BOTTOM.
static Integer ALIGN_CENTER
          Symbolic value for ALIGN=CENTER.
static Integer ALIGN_LEFT
          Symbolic value for ALIGN=LEFT.
static Integer ALIGN_MIDDLE
          Symbolic value for VALIGN=MIDDLE.
static Integer ALIGN_NONE
          Symbolic value for no alignment.
static Integer ALIGN_RIGHT
          Symbolic value for ALIGN=RIGHT.
static Integer ALIGN_TOP
          Symbolic value for VALIGN=TOP.
static String CELL_BGCOLOR
          Property name for the background color of the table cell.
static String CELL_BGIMAGE
          Property name for the background image of the table cell.
static String CELL_BGTRANSPARENT
          Property name for the background transparency flag of the table cell.
static String CELL_HEADERCELL
          Property name for the header flag of the table cell.
static String CELL_HORIZONTALALIGNMENT
          Property name for the default paragraph alignment of the table cell.
static String CELL_VERTICALALIGNMENT
          Property name for the vertical alignment of paragraphs of the table cell.
static String CELL_WRAPTEXT
          Property name for the wrap text flag of the table cell.
static String EDITOR_CONTEXT
          Property name for the context base.
static String HOTSPOT_HEIGHT
          Property name for the height of the hotspot.
static String HOTSPOT_LINKFRAME
          Property name for the frame.
static String HOTSPOT_LINKURL
          Property name for the URL of the hotspot.
static String HOTSPOT_WIDTH
          Property name for the width of the hotspot.
static String HOTSPOT_XPOS
          Property name for the xpos of the hotspot.
static String HOTSPOT_YPOS
          Property name for the ypos of the hotspot.
static String IMAGE_ALIGNMENT
          Property name for the alignment of the image.
static String IMAGE_BORDERSIZE
          Property name for the size of the border of the image.
static String IMAGE_HEIGHT
          Property name for the height of the image.
static String IMAGE_HORIZSPACE
          Property name for the horizontal spacing of the image.
static String IMAGE_LINKFRAME
          Property name for the target frame of the default URL.
static String IMAGE_LINKURL
          Property name for the default URL of the image.
static String IMAGE_SOURCE
          Property name for the source of the image.
static String IMAGE_SPECIFYSIZE
          Property name for the specify size flag of the image.
static String IMAGE_VERTSPACE
          Property name for the vertical spacing of the image.
static String IMAGE_WIDTH
          Property name for the width of the image.
static String LINE_ALIGNMENT
          Property name for the line alignment.
static String LINE_COLOR
          Property name for the line color.
static String LINE_HEIGHT
          Property name for the line height.
static String LINE_ISSOLID
          Property name for the is-solid flag.
static String LINE_WIDTH
          Property name for line width.
static String LINE_WIDTH_UNITS
          Property name for the line width units.
static String PAGE_ALINKCOLOR
          Property name for the active link color.
static String PAGE_BGCOLOR
          Property name for the page background color.
static String PAGE_BGIMAGE
          Property name for the page background image.
static String PAGE_BGSOUND
          Property name for the page background sound.
static String PAGE_BGSOUND_CONTINUOUS
          Property name for the page background sound continuous count.
static String PAGE_BGSOUND_LOOPCOUNT
          Property name for the page background sound loop count.
static String PAGE_LINKCOLOR
          Property name for the link color.
static String PAGE_SPECIFYBG
          Property name for the page 'specify background' flag.
static String PAGE_TEXTCOLOR
          Property name for the text color.
static String PAGE_TITLE
          Property name for the page title.
static String PAGE_VLINKCOLOR
          Property name for the 'visited' link color.
static String PARAGRAPH_ALIGNMENT
          Property name for the paragraph alignment.
static String PARAGRAPH_LISTSTYLE
          Property name for the list style.
static String PARAGRAPH_STYLENAME
          Property name for the paragraph style.
static String TABLE_ALIGNMENT
          Property name for the alignment of the table.
static String TABLE_BGCOLOR
          Property name for the background color of the table.
static String TABLE_BGIMAGE
          Property name for the background image of the table.
static String TABLE_BGTRANSPARENT
          Property name for the background transparency flag of the table.
static String TABLE_BORDERCOLOR
          Property name for the border color of the table.
static String TABLE_BORDERSIZE
          Property name for the border size of the table.
static String TABLE_CELLPADDING
          Property name for the cell padding of the table.
static String TABLE_CELLSPACING
          Property name for the cell spacing of the table.
static String TABLE_MINWIDTH
          Property name for the minimum width of the table.
static String TABLE_MINWIDTHUNITS
          Property name for the unit in which the minimum width of the table is specified.
static String TEXT_ANCHOR
          Property name for the anchor associated with the text.
static String TEXT_ANCHORTARGET
          Property name for the anchor target.
static String TEXT_BLINK
          Property name for the blink flag of the text.
static String TEXT_BOLD
          Property name for the bold flag.
static String TEXT_COLOR
          Property name for the color of the text.
static String TEXT_FONTNAME
          Property name for the name of the font.
static String TEXT_FONTSIZE
          Property name for the size of the text.
static String TEXT_FONTSTYLE
          Property name for the style of the text.
static String TEXT_ITALIC
          Property name for the italic flag.
static String TEXT_STRIKETHROUGH
          Property name for the strikethrough flag of the text.
static String TEXT_SUBSCRIPT
          Property name for the subscript flag of the text.
static String TEXT_SUPERSCRIPT
          Property name for the superscript flag of the text.
static String TEXT_UNDERLINE
          Property name for the underline flag.
static Integer TYPE_1
          Symbolic value for integer number list style (1, 2, 3...).
static Integer TYPE_a
          Symbolic value for lower case number list style (a, b, c...).
static Integer TYPE_A
          Symbolic value for upper case number list style (A, B, C...).
static Integer TYPE_CIRCLE
          Symbolic value for circle bullet style.
static Integer TYPE_DISC
          Symbolic value for disc bullet style.
static Integer TYPE_i
          Symbolic value for lower case Roman numeral list style (i, ii, iii...).
static Integer TYPE_I
          Symbolic value for upper case Roman numeral list style (I, II, III...).
static Integer TYPE_NONE
          Symbolic value for default list style.
static Integer TYPE_SQUARE
          Symbolic value for square bullet style.
static Integer UNIT_AUTO
          Symbolic value for automatic fit.
static Integer UNIT_PERCENT
          Symbolic value for percent unit.
static Integer UNIT_PIXEL
          Symbolic value for pixel unit.
 
Fields inherited from class com.sssw.rt.rteditor.RTEditor
m_Page, m_ParentEditor, TYPE_APPLET, TYPE_GENERAL, TYPE_IMAGE, TYPE_PAGE, TYPE_SOUND
 
Fields inherited from class com.sssw.rt.atlas.AtPanel
BGIMAGE_DRAW_CENTERED, BGIMAGE_DRAW_NORMAL, BGIMAGE_DRAW_STRETCH, BGIMAGE_DRAW_TILED
 
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.sssw.rt.form.AgiControl
IMAGE_MODE_CENTERED, IMAGE_MODE_NORMAL, IMAGE_MODE_STRETCH, IMAGE_MODE_TILED
 
Constructor Summary
AgcHTMLEditControl()
           
 
Method Summary
 void addAgiRTEditorListener(AgiRTEditorListener listener)
           
 void alignCenter()
          Aligns the current paragraph to the center of the page, or if the current paragraph is in a table, to the center of the current table cell.
 void alignLeft()
          Aligns the current paragraph to the left margin of the HTML page or table cell.
 void alignNone()
          Uses the default alignment for the HTML page or table cell.
 void alignRight()
          Aligns the current paragraph to the right margin of the HTML page or table cell.
 boolean canRedo()
          Returns a boolean value that determines if an operation can be redone.
 boolean canUndo()
          Returns a boolean value that determines if operations can be undone.
 void clearUndo()
          Clears the undo chain.
 void copySelectionToClipboard()
          Copies the currently selected object (text or image) and places it on the system clipboard.
 void cutSelectionToClipboard()
          Cuts the currently selected object and places it on the system clipboard.
 void decreaseFontSize()
          Decreases the font size of the currently selected object, making it smaller in the design environment.
 void decreaseIndentation()
          Decreases the indentation of the text at the current cursor position.
 void deleteObject()
          Deletes the current selection or currently selected object.
 void deletePrevObject()
          Deletes the current selection or the previous object.
 void deleteWord()
          Deletes the currently selected word.
 boolean getASCIIEncoding()
           
 Color getBackgroundColor()
          Deprecated. replaced by Component.getBackground().
 boolean getBooleanProperty(String prop)
          Returns a boolean given a property name.
 Color getColorProperty(String prop)
          Returns a Color object for the named property.
 String getContent()
          Returns the content of the editor.
 String getContentAsPlainText()
          Returns the content of the editor as plain text.
 String getHTML()
          Returns the content of the editor as an HTML string.
 int getIntProperty(String prop)
          Returns an integer given a property name.
 Object getProperty(String prop)
          Returns the specified property.
 String getStringProperty(String prop)
          Returns a String value given a property name.
 String getText()
          Returns the contents of the editor as a plain text string, ignoring the formatting information.
 void gotoColumnNum(int n)
          Moves the caret to the n-th column of the current line.
 void gotoLineBegin()
          Moves the caret to the first position of the current line.
 void gotoLineEnd()
          Positions the cursor at the end of the current line.
 void gotoLineNum(int n)
          Positions the cursor at the specified line number on the current page.
 void gotoNextLine()
          Positions the cursor at the beginning of the next line.
 void gotoNextNPos(int n)
          Moves the caret forward by n positions.
 void gotoNextParagraphBegin()
          Positions the cursor at the beginning of the next paragraph.
 void gotoNextPos()
          Positions the cursor to the next position.
 void gotoNextScreen()
          Positions the cursor at the beginning of the next screen.
 void gotoNextWordBegin()
          Positions the cursor at the beginning of the next word.
 void gotoPageBegin()
          Positions the cursor at the top of the current page.
 void gotoPageEnd()
          Positions the cursor at the bottom of the current page.
 void gotoPrevLine()
          Positions the cursor at the beginning of the previous line.
 void gotoPrevNPos(int n)
          Moves the caret backward by n positions.
 void gotoPrevParagraphBegin()
          Positions the cursor at the beginning of the previous paragraph.
 void gotoPrevPos()
          Positions the cursor to its previous position.
 void gotoPrevScreen()
          Positions the cursor at the beginning of the previous screen.
 void gotoPrevWordBegin()
          Moves the caret to the first position of the previous word or object unit.
 void gotoScreenFirstPos()
          Positions the cursor at the first position of the current screen.
 void gotoScreenLastPos()
          Positions the cursor at the last position of the current screen.
 void increaseFontSize()
          Increases the font size of the currently selected object, making it larger in the design environment.
 void increaseIndentation()
          Increases the indentation of the text at the current cursor position.
 void insertChar(char c)
          Inserts the specified character.
 void insertCustomTag(String html)
          Inserts the specified HTML tag at the current cursor location.
 void insertImage(String image_spec)
          Inserts an image with the specified image specification.
 void insertImageLink(String image_url)
          Inserts an image link (can be absolute URL or relative URL).
 void insertLine()
          Inserts a horizontal rule.
 void insertParagraphBreak()
          Inserts a paragraph break above the current cursor location.
 void insertRawHTML(String html)
          Inserts raw HTML text at the current cursor location.
 void insertSpace()
          Inserts a single space at the current cursor location.
 void insertString(String string)
          Inserts a specific text String at the current cursor location.
 void insertTab()
          Inserts a tab at the current cursor location.
 com.sssw.rt.rteditor.AgiHTMLTable insertTable(int row_count, int column_count)
          Inserts an empty table at the current cursor location with the specified row and column count.
 void insertTableColumn()
          Inserts a column in the table before the caret.
 void insertTableRow()
          Inserts a row in the table before the caret.
 boolean isEmpty()
          Returns true if the editor is empty.
 boolean isPropertyAvailable(String prop)
          Returns true if the specified property is currently available.
 void mergeCells()
          Merges the currently selected cells.
 void pasteClipboardSelection()
          Pastes the Clipboard's contents to the current cursor position.
 void pasteClipboardSelectionAsHTML()
          Pastes the clipboard string as HTML.
 void pasteClipboardSelectionAsText()
          Pastes the clipboard string as plain text.
 void redo()
          Redoes the last operation.
 void removeAgiRTEditorListener(AgiRTEditorListener listener)
           
 void removeTableColumn()
          Removes the column of the caret in the table.
 void removeTableRow()
          Removes the current row (where the caret is) from the table.
 void selectToColumnNum(int n)
          Extends the selection to the n-th column of the current line.
 void selectToLineBegin()
          Selects the text between the current cursor position and the beginning of the current line.
 void selectToLineEnd()
          Selects the text between the current cursor position and the end of the current line.
 void selectToLineNum(int n)
          Selects the text between the current cursor position and the beginning of the specified line on the current page.
 void selectToNextLine()
          Selects the text between the current cursor position and the beginning of the next line.
 void selectToNextNPos(int n)
          Extends the selection forward by n positions.
 void selectToNextParagraphBegin()
          Selects the text between the current cursor position and the beginning of the next paragraph.
 void selectToNextPos()
          Selects the text between the current cursor position and the next cursor position.
 void selectToNextScreen()
          Selects the text between the current cursor position and the beginning of the next screen.
 void selectToNextWordBegin()
          Selects the text between the current cursor position and the beginning of the next word.
 void selectToPageBegin()
          Selects the text between the current cursor position and the beginning of the current page.
 void selectToPageEnd()
          Selects the text between the current cursor position and the end of the current page.
 void selectToPrevLine()
          Selects the text between the current cursor position and the beginning of the previous line.
 void selectToPrevNPos(int n)
          Extends the selection backward by n positions.
 void selectToPrevParagraphBegin()
          Selects the text between the current cursor position and the beginning of the previous paragraph.
 void selectToPrevPos()
          Selects the text between the current cursor position and the previous cursor position.
 void selectToPrevScreen()
          Selects the text between the current cursor position and the beginning of the previous screen.
 void selectToPrevWordBegin()
          Selects the text between the current cursor position and the beginning of the previous word.
 void selectToScreenFirstPos()
          Selects the text between the current cursor position and the first position of the current screen.
 void selectToScreenLastPos()
          Selects the text between the current cursor position and the last position of the current screen.
 void setASCIIEncoding(boolean encoding)
           
 void setBackgroundColor(Color backgroundcolor)
          Deprecated. replaced by Component.setBackground(Color).
 void setBlockquote()
          Sets the block quote HTML tag.
 void setBooleanProperty(String prop, boolean value)
          Sets the specified property to the boolean value supplied.
 void setBulletedList()
          Sets the style of the current paragraph or selected paragraphs to bulleted list.
 void setColorProperty(String prop, Color value)
          Sets the named property to the given Color object.
 void setContextBase(URL context)
          Establishes the page context by specifying the base URL used to resolve relative URLs for images, links, etc.
 void setHTML(String html)
          Sets the text of the editor by an HTML string.
 void setIntProperty(String prop, int value)
          Sets the specified property to the integer value supplied.
 void setNumberedList()
          Sets the style of the current paragraph or selected paragraphs to numbered list.
 void setProperty(String prop, Object value)
          Modifies the specified property.
 void setStringProperty(String prop, String value)
          Sets the property specified by the given name to a string value.
 void spanCell(int row_count, int column_count)
          Causes text to span a column and a row.
 void splitCell()
          Splits a single table cell into two cells.
 void toggleBold()
          Applies or unapplies the HTML strong character style to the currently selected text.
 void toggleHighlight()
          Toggles between displaying only the hotspots defined on an image, and displaying the image and the hotspots.
 void toggleItalic()
          Applies or unapplies the HTML emphasis character style to the currently selected text.
 void toggleUnderline()
          Applies or unapplies the HTML underline character style to the currently selected text.
 void undo()
          Undoes the last operation.
 
Methods inherited from class com.sssw.rt.rteditor.RTEditor
actionPerformed, addAgiPrivateListener, addHTMLExtender, addNotify, canInsert, clearErrorCode, commandKeyPressed, disableToolBar, displayError, displayError, displayError, displayMessage, displayStatus, displayWarning, displayWarning, displayWarning, doCommand, doDragTargetCleanup, doFinalCleanup, doInsertImage, doInsertLink, doMouseDrag, dragEnter, dragExit, dragOver, drop, dropActionChanged, enableAtCommands, enableToolBar, findNext, findPrevious, firePrivateEvent, firePrivateEvent, fireRTEvent, focusGained, focusLost, getBaseWebbaseURL, getChangedPropertyBags, getClassLoader, getContainingUnit, getContent, getContentHeight, getContentWidth, getContextBase, getControlInfo, getCurrentAnchor, getCurrentBlockHeight, getCurrentBlockWidth, getCurrentRowIndex, getCursorColumnNumber, getCursorLineNumber, getCustomTagInfo, getCustomTagProperty, getCustomUnit, getCustomUnitPropertyBag, getDefaultStyleLabels, getDesignMode, getEmbeddedContent, getEnvironment, getErrorCode, getFontList, getFontStyle, getFrameInfo, getImage, getImageInfo, getImageMapAreaInfo, getLabelFromTemplate, getLastException, getLastLayoutRegion, getLastTable, getLocaleKey, getLocaleKeyMask, getOwnerFrame, getPage, getPageInfo, getParagraphStyle, getPropertyBagFor, getPropertyBagOwner, getPropertyEditorHelper, getRawHTML, getReloadPropertyBags, getRowIndex, getScriptEditorArgUnit, getSelectedPropertyBags, getSelectionType, getSubFrameInfo, getSubPageInfo, getTableCellInfo, getTableInfo, getTableType, getTemplateFromLabel, getUnitType, getURLFromSpec, getViewOriginX, getViewOriginY, gotoUnit, hasFrameInfo, hasModified, hasPropertyBagChanged, hideBorder, hideSubComponents, isCommandKeyEvent, isContentValid, isControlInfoAvailable, isCustomTagInfoAvailable, isCustomUnitAvailable, isEventInvokerAvailable, isFindInfoAvailable, isImageInfoAvailable, isImageMapAreaInfoAvailable, isRawHTMLAvailable, isSelectingMultipleLayoutObjects, isSelectingSingleLayoutObject, isSubFrameInfoAvailable, isTableCellInfoAvailable, isTableInfoAvailable, isUsedName, isValidName, keepSameTabPane, keyPressed, keyReleased, keyTyped, launchEditRawHTMLDialog, launchFindDialog, launchHeaderTagsEditor, launchImagePickerDialog, launchImageURLDialog, launchInspectDialog, launchJavaScriptEditor, launchLinkPickerDialog, launchLinkURLDialog, launchObjectPickerDialog, launchRawHTMLDialog, launchStyleSheetEditor, launchSubPageURLDialog, launchTextValueDialog, lookupKeyBinding, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, newControlInfo, newFontStyleInfo, newImageInfo, newPageInfo, newParagraphStyleInfo, newTableCellInfo, newTableInfo, notifyNameChange, onHScroll, onPageEvent, onPaintView, onResizeView, onVScroll, postPrivateEvent, preprocessKeyEvent, refreshHeaderTagsEditor, refreshJavaScriptEditor, refreshStyleSheetEditor, removeAgiPrivateListener, removeHTMLExtender, removeKeyBinding, removeNotify, replace, replaceAll, requestFocus, requestSave, restoreSubComponents, setBaseWebbaseURL, setCustomTagProperty, setDesignMode, setEnvironment, setFrameInfo, setKeyBinding, setMasterUndoChain, setMessageDisplay, setPropertyBagOwner, setReadOnly, showBorder, updateProperties, waitForCommand, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened
 
Methods inherited from class com.sssw.rt.rtcontrol.RTScrollPanel
componentHidden, componentMoved, componentResized, componentShown, getPreferredSize, getView, getViewHeight, getViewWidth, hideScrollBars, showScrollBars, updateHScrollBar, updateVScrollBar
 
Methods inherited from class com.sssw.rt.atlas.AtPanel
addImpl, clientPaint, clientPaint, deliverMouseEvent, deliverMouseMoveEvent, doAtCommand, drawTiledImage, getBackgroundImage, getBackgroundImageMode, getHelper, getTransparent, hide, hideToolTip, imageUpdate, isFocusTraversable, isOptimizedDrawingEnabled, ownedImage, paintBorder, paintComponent, paintImmediately, paintImmediately, paintNow, processEvent, reshape, setBackgroundImage, setBackgroundImageMode, setTransparent, show, showToolTip
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isOpaque, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, print, printAll, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, resetKeyboardActions, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods implemented from interface com.sssw.rt.form.AgiControl
getComponent, getHelpInfo, setHelpInfo
 
Methods implemented from interface com.sssw.rt.event.AgiManualPropertyChange
fireManualPropertyChange
 

Field Detail

EDITOR_CONTEXT

public static final String EDITOR_CONTEXT
Property name for the context base. Value type: String (url).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_TITLE

public static final String PAGE_TITLE
Property name for the page title. Value type: String.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_SPECIFYBG

public static final String PAGE_SPECIFYBG
Property name for the page 'specify background' flag. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_BGCOLOR

public static final String PAGE_BGCOLOR
Property name for the page background color. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_BGIMAGE

public static final String PAGE_BGIMAGE
Property name for the page background image. Value type: String (url).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_TEXTCOLOR

public static final String PAGE_TEXTCOLOR
Property name for the text color. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_LINKCOLOR

public static final String PAGE_LINKCOLOR
Property name for the link color. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_VLINKCOLOR

public static final String PAGE_VLINKCOLOR
Property name for the 'visited' link color. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_ALINKCOLOR

public static final String PAGE_ALINKCOLOR
Property name for the active link color. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_BGSOUND

public static final String PAGE_BGSOUND
Property name for the page background sound. Value type: String (url).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_BGSOUND_LOOPCOUNT

public static final String PAGE_BGSOUND_LOOPCOUNT
Property name for the page background sound loop count. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

PAGE_BGSOUND_CONTINUOUS

public static final String PAGE_BGSOUND_CONTINUOUS
Property name for the page background sound continuous count. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TABLE_ALIGNMENT

public static final String TABLE_ALIGNMENT
Property name for the alignment of the table. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)
Usage:

Possible property values are AgcHTMLEditControl.ALIGN_LEFT, AgcHTMLEditControl.ALIGN_CENTER, and AgcHTMLEditControl.ALIGN_NONE.


TABLE_CELLPADDING

public static final String TABLE_CELLPADDING
Property name for the cell padding of the table. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

TABLE_CELLSPACING

public static final String TABLE_CELLSPACING
Property name for the cell spacing of the table. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

TABLE_MINWIDTH

public static final String TABLE_MINWIDTH
Property name for the minimum width of the table. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

TABLE_MINWIDTHUNITS

public static final String TABLE_MINWIDTHUNITS
Property name for the unit in which the minimum width of the table is specified. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)
Usage:

Possible property values are AgcHTMLEditControl.UNIT_AUTO, AgcHTMLEditControl.UNIT_PIXEL, and AgcHTMLEditControl.UNIT_PERCENT.


TABLE_BGTRANSPARENT

public static final String TABLE_BGTRANSPARENT
Property name for the background transparency flag of the table. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TABLE_BGCOLOR

public static final String TABLE_BGCOLOR
Property name for the background color of the table. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

TABLE_BGIMAGE

public static final String TABLE_BGIMAGE
Property name for the background image of the table. Value type: String (image spec).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

TABLE_BORDERSIZE

public static final String TABLE_BORDERSIZE
Property name for the border size of the table. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

TABLE_BORDERCOLOR

public static final String TABLE_BORDERCOLOR
Property name for the border color of the table. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

CELL_HORIZONTALALIGNMENT

public static final String CELL_HORIZONTALALIGNMENT
Property name for the default paragraph alignment of the table cell. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)
Usage:

Possible property values are AgcHTMLEditControl.ALIGN_NONE, AgcHTMLEditControl.ALIGN_LEFT, AgcHTMLEditControl.ALIGN_CENTER, and AgcHTMLEditControl.ALIGN_RIGHT.


CELL_VERTICALALIGNMENT

public static final String CELL_VERTICALALIGNMENT
Property name for the vertical alignment of paragraphs of the table cell. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)
Usage:

Possible property values are AgcHTMLEditControl.ALIGN_NONE, AgcHTMLEditControl.ALIGN_TOP, AgcHTMLEditControl.ALIGN_MIDDLE, and AgcHTMLEditControl.ALIGN_BOTTOM.


CELL_HEADERCELL

public static final String CELL_HEADERCELL
Property name for the header flag of the table cell. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

CELL_WRAPTEXT

public static final String CELL_WRAPTEXT
Property name for the wrap text flag of the table cell. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

CELL_BGTRANSPARENT

public static final String CELL_BGTRANSPARENT
Property name for the background transparency flag of the table cell. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

CELL_BGCOLOR

public static final String CELL_BGCOLOR
Property name for the background color of the table cell. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

CELL_BGIMAGE

public static final String CELL_BGIMAGE
Property name for the background image of the table cell. Value type: String (image spec).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

PARAGRAPH_STYLENAME

public static final String PARAGRAPH_STYLENAME
Property name for the paragraph style. Value type: String.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

PARAGRAPH_ALIGNMENT

public static final String PARAGRAPH_ALIGNMENT
Property name for the paragraph alignment. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)
Usage:

Possible property values are AgcHTMLEditControl.ALIGN_NONE, AgcHTMLEditControl.ALIGN_LEFT, AgcHTMLEditControl.ALIGN_CENTER, and AgcHTMLEditControl.ALIGN_RIGHT.


PARAGRAPH_LISTSTYLE

public static final String PARAGRAPH_LISTSTYLE
Property name for the list style. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)
Usage:

Possible values are AgcHTMLEditControl.TYPE_NONE, AgcHTMLEditControl.TYPE_A, AgcHTMLEditControl.TYPE_a, AgcHTMLEditControl.TYPE_I, AgcHTMLEditControl.TYPE_i, AgcHTMLEditControl.TYPE_1, AgcHTMLEditControl.TYPE_DISC, AgcHTMLEditControl.TYPE_CIRCLE, and AgcHTMLEditControl.TYPE_SQUARE.


TEXT_FONTNAME

public static final String TEXT_FONTNAME
Property name for the name of the font. Value type: String.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_FONTSIZE

public static final String TEXT_FONTSIZE
Property name for the size of the text. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_FONTSTYLE

public static final String TEXT_FONTSTYLE
Property name for the style of the text. Value type: String.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_COLOR

public static final String TEXT_COLOR
Property name for the color of the text. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_STRIKETHROUGH

public static final String TEXT_STRIKETHROUGH
Property name for the strikethrough flag of the text. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_BOLD

public static final String TEXT_BOLD
Property name for the bold flag. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_ITALIC

public static final String TEXT_ITALIC
Property name for the italic flag. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_UNDERLINE

public static final String TEXT_UNDERLINE
Property name for the underline flag. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_BLINK

public static final String TEXT_BLINK
Property name for the blink flag of the text. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_SUPERSCRIPT

public static final String TEXT_SUPERSCRIPT
Property name for the superscript flag of the text. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_SUBSCRIPT

public static final String TEXT_SUBSCRIPT
Property name for the subscript flag of the text. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_ANCHOR

public static final String TEXT_ANCHOR
Property name for the anchor associated with the text. Value type: String (url).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

TEXT_ANCHORTARGET

public static final String TEXT_ANCHORTARGET
Property name for the anchor target. Value type: String (frame).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_SOURCE

public static final String IMAGE_SOURCE
Property name for the source of the image. Value type: String (image spec).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_LINKURL

public static final String IMAGE_LINKURL
Property name for the default URL of the image. Value type: String (page spec).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_LINKFRAME

public static final String IMAGE_LINKFRAME
Property name for the target frame of the default URL. Value type: String.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_ALIGNMENT

public static final String IMAGE_ALIGNMENT
Property name for the alignment of the image. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)
Usage:

Possible subtypes are AgcHTMLEditControl.ALIGN_LEFT, AgcHTMLEditControl.ALIGN_CENTER, and AgcHTMLEditControl.ALIGN_RIGHT.


IMAGE_BORDERSIZE

public static final String IMAGE_BORDERSIZE
Property name for the size of the border of the image. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_HORIZSPACE

public static final String IMAGE_HORIZSPACE
Property name for the horizontal spacing of the image. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_VERTSPACE

public static final String IMAGE_VERTSPACE
Property name for the vertical spacing of the image. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_SPECIFYSIZE

public static final String IMAGE_SPECIFYSIZE
Property name for the specify size flag of the image. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_HEIGHT

public static final String IMAGE_HEIGHT
Property name for the height of the image. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

IMAGE_WIDTH

public static final String IMAGE_WIDTH
Property name for the width of the image. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

HOTSPOT_LINKURL

public static final String HOTSPOT_LINKURL
Property name for the URL of the hotspot. Value type: String (url).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

HOTSPOT_LINKFRAME

public static final String HOTSPOT_LINKFRAME
Property name for the frame. Value type: String (frame).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.isPropertyAvailable(String)

HOTSPOT_XPOS

public static final String HOTSPOT_XPOS
Property name for the xpos of the hotspot. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

HOTSPOT_YPOS

public static final String HOTSPOT_YPOS
Property name for the ypos of the hotspot. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

HOTSPOT_WIDTH

public static final String HOTSPOT_WIDTH
Property name for the width of the hotspot. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

HOTSPOT_HEIGHT

public static final String HOTSPOT_HEIGHT
Property name for the height of the hotspot. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

LINE_WIDTH

public static final String LINE_WIDTH
Property name for line width. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

LINE_WIDTH_UNITS

public static final String LINE_WIDTH_UNITS
Property name for the line width units. Value type: Integer (alignment).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

LINE_HEIGHT

public static final String LINE_HEIGHT
Property name for the line height. Value type: Integer.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

LINE_ALIGNMENT

public static final String LINE_ALIGNMENT
Property name for the line alignment. Value type: Integer (alignment).
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

LINE_COLOR

public static final String LINE_COLOR
Property name for the line color. Value type: Color.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.isPropertyAvailable(String)

LINE_ISSOLID

public static final String LINE_ISSOLID
Property name for the is-solid flag. Value type: Boolean.
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.isPropertyAvailable(String)

ALIGN_NONE

public static final Integer ALIGN_NONE
Symbolic value for no alignment.
See Also:
AgcHTMLEditControl.PARAGRAPH_ALIGNMENT, AgcHTMLEditControl.CELL_VERTICALALIGNMENT, AgcHTMLEditControl.CELL_HORIZONTALALIGNMENT, AgcHTMLEditControl.TABLE_ALIGNMENT

ALIGN_LEFT

public static final Integer ALIGN_LEFT
Symbolic value for ALIGN=LEFT.
See Also:
AgcHTMLEditControl.PARAGRAPH_ALIGNMENT, AgcHTMLEditControl.CELL_HORIZONTALALIGNMENT, AgcHTMLEditControl.TABLE_ALIGNMENT, AgcHTMLEditControl.IMAGE_ALIGNMENT

ALIGN_RIGHT

public static final Integer ALIGN_RIGHT
Symbolic value for ALIGN=RIGHT.
See Also:
AgcHTMLEditControl.PARAGRAPH_ALIGNMENT, AgcHTMLEditControl.CELL_HORIZONTALALIGNMENT, AgcHTMLEditControl.IMAGE_ALIGNMENT

ALIGN_CENTER

public static final Integer ALIGN_CENTER
Symbolic value for ALIGN=CENTER.
See Also:
AgcHTMLEditControl.PARAGRAPH_ALIGNMENT, AgcHTMLEditControl.CELL_HORIZONTALALIGNMENT, AgcHTMLEditControl.IMAGE_ALIGNMENT

ALIGN_TOP

public static final Integer ALIGN_TOP
Symbolic value for VALIGN=TOP.
See Also:
AgcHTMLEditControl.CELL_VERTICALALIGNMENT

ALIGN_MIDDLE

public static final Integer ALIGN_MIDDLE
Symbolic value for VALIGN=MIDDLE.
See Also:
AgcHTMLEditControl.CELL_VERTICALALIGNMENT

ALIGN_BOTTOM

public static final Integer ALIGN_BOTTOM
Symbolic value for VALIGN=BOTTOM.
See Also:
AgcHTMLEditControl.CELL_VERTICALALIGNMENT

UNIT_AUTO

public static final Integer UNIT_AUTO
Symbolic value for automatic fit.
See Also:
AgcHTMLEditControl.TABLE_MINWIDTHUNITS

UNIT_PIXEL

public static final Integer UNIT_PIXEL
Symbolic value for pixel unit.
See Also:
AgcHTMLEditControl.TABLE_MINWIDTHUNITS

UNIT_PERCENT

public static final Integer UNIT_PERCENT
Symbolic value for percent unit.
See Also:
AgcHTMLEditControl.TABLE_MINWIDTHUNITS

TYPE_NONE

public static final Integer TYPE_NONE
Symbolic value for default list style.
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE

TYPE_A

public static final Integer TYPE_A
Symbolic value for upper case number list style (A, B, C...).
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE

TYPE_a

public static final Integer TYPE_a
Symbolic value for lower case number list style (a, b, c...).
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE

TYPE_I

public static final Integer TYPE_I
Symbolic value for upper case Roman numeral list style (I, II, III...).
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE

TYPE_i

public static final Integer TYPE_i
Symbolic value for lower case Roman numeral list style (i, ii, iii...).
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE

TYPE_1

public static final Integer TYPE_1
Symbolic value for integer number list style (1, 2, 3...).
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE

TYPE_DISC

public static final Integer TYPE_DISC
Symbolic value for disc bullet style.
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE

TYPE_CIRCLE

public static final Integer TYPE_CIRCLE
Symbolic value for circle bullet style.
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE

TYPE_SQUARE

public static final Integer TYPE_SQUARE
Symbolic value for square bullet style.
See Also:
AgcHTMLEditControl.PARAGRAPH_LISTSTYLE
Constructor Detail

AgcHTMLEditControl

public AgcHTMLEditControl()
Method Detail

gotoPrevPos

public void gotoPrevPos()
Positions the cursor to its previous position.
Usage:

Moves the caret to the position previous to the current position. This is the default action of the left-arrow key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoPrevPos();
 
See Also:
AgcHTMLEditControl.gotoNextPos()

gotoNextPos

public void gotoNextPos()
Positions the cursor to the next position.
Usage:

Moves the caret to the position next to the current position. This is the default action of the right-arrow key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoNextPos;
 
See Also:
AgcHTMLEditControl.gotoPrevPos()

gotoPrevWordBegin

public void gotoPrevWordBegin()
Moves the caret to the first position of the previous word or object unit.
Usage:

This is the default action of the ctrl-left arrow key.


gotoNextWordBegin

public void gotoNextWordBegin()
Positions the cursor at the beginning of the next word.
Usage:

Moves the caret to the first position of the next word or object unit. This is the default action of the ctrl-right arrow key.

Example:

The following code fragment illustrates how to position the cursor to the beginning of the next word.

  ControlName1.gotoNextWordBegin();
 

gotoPrevLine

public void gotoPrevLine()
Positions the cursor at the beginning of the previous line.
Usage:

Moves the caret up one line. This is the default action of the up-arrow key.

Example:

The following code fragment illustrates how to use the gotoPrevLine() method.

  ControlName1.gotoPrevLine();
 
See Also:
AgcHTMLEditControl.gotoNextLine()

gotoNextLine

public void gotoNextLine()
Positions the cursor at the beginning of the next line.
Usage:

Moves the caret down one line. This is the default action of the down-arrow key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoNextLine();
 
See Also:
AgcHTMLEditControl.gotoPrevLine()

gotoPrevParagraphBegin

public void gotoPrevParagraphBegin()
Positions the cursor at the beginning of the previous paragraph.
Usage:

Moves the caret to the first position of the previous paragraph. This is the default action of the ctrl-up arrow key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoPrevParagraphBegin();
 
See Also:
AgcHTMLEditControl.gotoNextParagraphBegin()

gotoNextParagraphBegin

public void gotoNextParagraphBegin()
Positions the cursor at the beginning of the next paragraph.
Usage:

Moves the caret to the first position of the next paragraph. This is the default action of the ctrl-down arrow key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoNextParagraphBegin();
 
See Also:
AgcHTMLEditControl.gotoPrevParagraphBegin()

gotoLineBegin

public void gotoLineBegin()
Moves the caret to the first position of the current line.
Usage:

Positions the cursor at the beginning of the current line. This is the default action of the HOME key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoLineBegin();
 
See Also:
AgcHTMLEditControl.gotoLineEnd()

gotoLineEnd

public void gotoLineEnd()
Positions the cursor at the end of the current line.
Usage:

Moves the caret to the last position of the current line. This is the default action of the END key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoLineEnd();
 
See Also:
AgcHTMLEditControl.gotoLineBegin()

gotoPageBegin

public void gotoPageBegin()
Positions the cursor at the top of the current page.
Usage:

Moves the caret to the beginning of the page. This is the default action of the ctrl-HOME key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoPageBegin();
 
See Also:
AgcHTMLEditControl.gotoPageEnd()

gotoPageEnd

public void gotoPageEnd()
Positions the cursor at the bottom of the current page.
Usage:

Moves the caret to the end of the page. This is the default action of the ctrl-END key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoPageEnd();
 
See Also:
AgcHTMLEditControl.gotoPageBegin()

gotoPrevScreen

public void gotoPrevScreen()
Positions the cursor at the beginning of the previous screen.
Usage:

Moves the caret up one screenful of lines. This is the default action of the PGUP key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoPrevScreen()
 
See Also:
AgcHTMLEditControl.gotoNextScreen(), AgcHTMLEditControl.gotoScreenFirstPos(), AgcHTMLEditControl.gotoScreenLastPos()

gotoNextScreen

public void gotoNextScreen()
Positions the cursor at the beginning of the next screen.
Usage:

Moves the caret down one screenful of lines. This is the default action of the PGDN key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoNextScreen()
 
See Also:
AgcHTMLEditControl.gotoPrevScreen(), AgcHTMLEditControl.gotoScreenFirstPos(), AgcHTMLEditControl.gotoScreenLastPos()

gotoScreenFirstPos

public void gotoScreenFirstPos()
Positions the cursor at the first position of the current screen.
Usage:

Moves the caret to the first position of the current screen. This is the default action of the CTRL-PGUP key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoScreenFirstPos();
 
See Also:
AgcHTMLEditControl.gotoPrevScreen(), AgcHTMLEditControl.gotoNextPos(), AgcHTMLEditControl.gotoScreenLastPos()

gotoScreenLastPos

public void gotoScreenLastPos()
Positions the cursor at the last position of the current screen.
Usage:

Moves the caret to the last position of the current screen. This is the default action of the CTRL-PGDN key.

Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoScreenLastPos();
 
See Also:
AgcHTMLEditControl.gotoPrevScreen(), AgcHTMLEditControl.gotoNextScreen(), AgcHTMLEditControl.gotoScreenFirstPos()

gotoLineNum

public void gotoLineNum(int n)
Positions the cursor at the specified line number on the current page.
Parameters:
n - specifies the line number.
Example:

The following code fragment illustrates how to position the cursor.

  ControlName1.gotoLineNum(4);
 

gotoColumnNum

public void gotoColumnNum(int n)
Moves the caret to the n-th column of the current line.
Parameters:
n -  

gotoPrevNPos

public void gotoPrevNPos(int n)
Moves the caret backward by n positions.
Parameters:
n -  

gotoNextNPos

public void gotoNextNPos(int n)
Moves the caret forward by n positions.
Parameters:
n -  

selectToPrevPos

public void selectToPrevPos()
Selects the text between the current cursor position and the previous cursor position.
Usage:

Extends the selection to the position previous to the current position. This is the default action of the shift-left-arrow key.

Example:

The following code fragment illustrates how to use the selectToPrevPos() method.

  ControlName1.selectToPrevPos();
 

selectToNextPos

public void selectToNextPos()
Selects the text between the current cursor position and the next cursor position.
Usage:

Extends the selection to the position next to the current position. This is the default action of the shift-right-arrow key.

Example:

The following code fragment illustrates how to use the selectToNextPos() method.

  ControlName1.selectToNextPos();
 

selectToPrevWordBegin

public void selectToPrevWordBegin()
Selects the text between the current cursor position and the beginning of the previous word.
Usage:

Extends the selection to the first position of the previous word or object unit. This is the default action of the shift-ctrl-left arrow key.

Example:

The following code fragment illustrates how to use the selectToPrevWordBegin() method.

  ControlName1.selectToPrevWordBegin();
 
See Also:
AgcHTMLEditControl.selectToNextWordBegin()

selectToNextWordBegin

public void selectToNextWordBegin()
Selects the text between the current cursor position and the beginning of the next word.
Usage:

Extends the selection to the first position of the next word or object unit. This is the default action of the shift-ctrl-right arrow key.

Example:

The following code fragment illustrates how to use the selectToNextWordBegin() method.

  ControlName1.selectToNextWordBegin();
 
See Also:
AgcHTMLEditControl.selectToPrevWordBegin()

selectToPrevLine

public void selectToPrevLine()
Selects the text between the current cursor position and the beginning of the previous line.
Usage:

Extends the selection up one line. This is the default action of the shift-up-arrow key.

Example:

The following code fragment illustrates how to selectToPrevLine() method.

  ControlName1.selectToPrevLine();
 
See Also:
AgcHTMLEditControl.selectToNextLine()

selectToNextLine

public void selectToNextLine()
Selects the text between the current cursor position and the beginning of the next line.
Usage:

Extends the selection down one line. This is the default action of the shift-down-arrow key.

Example:

The following code fragment illustrates how to selectToNextLine() method.

  ControlName1.selectToNextLine();
 
See Also:
AgcHTMLEditControl.selectToPrevLine()

selectToPrevParagraphBegin

public void selectToPrevParagraphBegin()
Selects the text between the current cursor position and the beginning of the previous paragraph.
Usage:

Extends the selection to the first position of the previous paragraph. This is the default action of the shift-ctrl-up arrow key.

Example:

The following code fragment illustrates how to use the selectToPrevParagraphBegin() method.

  ControlName1.selectToPrevParagraphBegin();
 

selectToNextParagraphBegin

public void selectToNextParagraphBegin()
Selects the text between the current cursor position and the beginning of the next paragraph.
Usage:

Extends the selection to the first position of the next paragraph. This is the default action of the shift-ctrl-down arrow key.

Example:

The following code fragment illustrates how to use the selectToNextParagraphBegin() method.

  ControlName1.selectToNextParagraphBegin();
 

selectToLineBegin

public void selectToLineBegin()
Selects the text between the current cursor position and the beginning of the current line.
Usage:

Extends the selection to the first position of the current line. This is the default action of the shift-HOME key.

Example:

The following code fragment illustrates how to use the selectToLineBegin() method.

  ControlName1.selectToLineBegin();
 

selectToLineEnd

public void selectToLineEnd()
Selects the text between the current cursor position and the end of the current line.
Usage:

Extends the selection to the last position of the current line. This is the default action of the shift-END key.

Example:

The following code fragment illustrates how to use the selectToLineEnd() method.

  ControlName1.selectToLineEnd();
 

selectToPageBegin

public void selectToPageBegin()
Selects the text between the current cursor position and the beginning of the current page.
Usage:

Extends the selection to the beginning of the page. This is the default action of the shift-ctrl-HOME key.

Example:

The following code fragment illustrates how to use the selectToPageBegin() method.

  ControlName1.selectToPageBegin();
 

selectToPageEnd

public void selectToPageEnd()
Selects the text between the current cursor position and the end of the current page.
Usage:

Extends the selection to the end of the page. This is the default action of the shift-ctrl-END key.

Example:

The following code fragment illustrates how to use the selectToPageEnd() method.

  ControlName1.selectToPageEnd();
 

selectToPrevScreen

public void selectToPrevScreen()
Selects the text between the current cursor position and the beginning of the previous screen.
Usage:

Extends the selection up one screenful of lines. This is the default action of the shift-PGUP key.

Example:

The following code fragment illustrates how to use the selectToPrevScreen() method.

  ControlName1.selectToPrevScreen();
 

selectToNextScreen

public void selectToNextScreen()
Selects the text between the current cursor position and the beginning of the next screen.
Usage:

Extends the selection down one screenful of lines. This is the default action of the shift-PGDN key.

Example:

The following code fragment illustrates how to use the selectToNextScreen() method.

  ControlName1.selectToNextScreen();
 

selectToScreenFirstPos

public void selectToScreenFirstPos()
Selects the text between the current cursor position and the first position of the current screen.
Usage:

Extends the selection to the first position of the current screen. This is the default action of the shift-CTRL-PGUP key.

Example:

The following code fragment illustrates how to use the selectToScreenFirst() method.

  ControlName1.selectToScreenFirstPos();
 

selectToScreenLastPos

public void selectToScreenLastPos()
Selects the text between the current cursor position and the last position of the current screen.
Usage:

Extends the selection to the last position of the current screen. This is the default action of the shift-CTRL-PGDN key.

Example:

The following code fragment illustrates how to use the selectToScreenLast() method.

  ControlName1.selectToScreenLastPos();
 

selectToLineNum

public void selectToLineNum(int n)
Selects the text between the current cursor position and the beginning of the specified line on the current page.
Parameters:
n - specifies the line number.
Usage:

Extends the selection to the n-th line of the page.

Example:

The following code fragment illustrates how to use the selectToLineNum() method.

  ControlName1.selectToLineNum(3);
 

selectToColumnNum

public void selectToColumnNum(int n)
Extends the selection to the n-th column of the current line.
Parameters:
n -  

selectToPrevNPos

public void selectToPrevNPos(int n)
Extends the selection backward by n positions.
Parameters:
n -  

selectToNextNPos

public void selectToNextNPos(int n)
Extends the selection forward by n positions.
Parameters:
n -  

cutSelectionToClipboard

public void cutSelectionToClipboard()
Cuts the currently selected object and places it on the system clipboard.
Example:

The following code fragment illustrates how to use the cutSelectionToClipboard() method.

  ControlName1.cutSelectionToClipboard();
 

copySelectionToClipboard

public void copySelectionToClipboard()
Copies the currently selected object (text or image) and places it on the system clipboard.
Example:

The following code fragment illustrates how to use the copySelectionToClipboard() method.

  ControlName1.copySelectionToClipboard();
 

pasteClipboardSelection

public void pasteClipboardSelection()
Pastes the Clipboard's contents to the current cursor position.
Example:

The following code fragment illustrates how to use the pasteClipboardSelection() method.

  ControlName1.pasteClipboardSelection();
 

pasteClipboardSelectionAsText

public void pasteClipboardSelectionAsText()
Pastes the clipboard string as plain text.

pasteClipboardSelectionAsHTML

public void pasteClipboardSelectionAsHTML()
Pastes the clipboard string as HTML.

insertChar

public void insertChar(char c)
Inserts the specified character.
Parameters:
c -  

insertCustomTag

public void insertCustomTag(String html)
Inserts the specified HTML tag at the current cursor location.
Parameters:
html - specifies the custom tag's name.
Usage:

Inserts a custom tag which consists of the specified html.

Example:

The following code fragment illustrates how to use the insertCustomTag() method.

  ControlName1.insertCustomTag('<<em>!--N</em>>');
 

insertImage

public void insertImage(String image_spec)
Inserts an image with the specified image specification.
Parameters:
image_spec -  
Usage:

An image specification is in one of three forms:

  • filename - image from the same webbase
  • webbase:filename - image from a different webbase of the same server
  • http://hostname/path - image from an arbitrary URL

insertImageLink

public void insertImageLink(String image_url)
Inserts an image link (can be absolute URL or relative URL).
Parameters:
image_url -  

insertLine

public void insertLine()
Inserts a horizontal rule.
Example:

The following code fragment illustrates how to use the insertLine() method.

  ControlName1.insertLine();
 

insertParagraphBreak

public void insertParagraphBreak()
Inserts a paragraph break above the current cursor location.
Example:

The following code fragment illustrates how to use the insertParagraphBreak() method.

  ControlName1.insertParagraphBreak();
 

insertRawHTML

public void insertRawHTML(String html)
Inserts raw HTML text at the current cursor location.
Overrides:
insertRawHTML in class com.sssw.rt.rteditor.RTEditor
Parameters:
html - specifies the HTML to insert.
Usage:

Inserts a raw HTML unit. The unit encapsulates the specified HTML code.

Note that "\" represents a double quote but won't terminate the String.

Example:
  ControlName1.insertRawHTML("<A HREF="www.silverstream.com">SilverStream</A>")
 

insertSpace

public void insertSpace()
Inserts a single space at the current cursor location.
Example:

The following code fragment illustrates how to use the insertSpace() method.

  ControlName1.insertSpace();
 

insertString

public void insertString(String string)
Inserts a specific text String at the current cursor location.
Parameters:
string - specifies the String to insert.
Example:

The following code fragment illustrates how to use the insertString() method.

  ControlName1.insertString("the new order");
 

insertTab

public void insertTab()
Inserts a tab at the current cursor location.
Example:

The following code fragment illustrates how to use the insertTab() method.

  ControlName1.insertTab();
 

insertTable

public com.sssw.rt.rteditor.AgiHTMLTable insertTable(int row_count,
                                                     int column_count)
Inserts an empty table at the current cursor location with the specified row and column count.
Parameters:
row_count - specifies the number of rows in the table.
column_count - specifies the number of columns in the table.
Example:

The following code fragment illustrates how to create a table that has 3 rows and 4 columns.

  ControlName1.insertTable(3,4);
 

deleteObject

public void deleteObject()
Deletes the current selection or currently selected object.
Usage:

If there is currently no selection, this method deletes the object the cursor is currently pointing at. This method is the default action of the Del key.

Example:

The following code fragment illustrates how to use the deleteObject() method.

  ControlName1.deleteObject();
 

deleteWord

public void deleteWord()
Deletes the currently selected word.
Example:

The following code fragment illustrates how to use the deleteWord() method.

  ControlName1.deleteWord()
 

deletePrevObject

public void deletePrevObject()
Deletes the current selection or the previous object.
Usage:

If there is currently no selection, this method deletes the object previous to the caret position.

Example:

The following code fragment illustrates how to use the deletePrevObject() method.

  ControlName1.deletePrevObject();
 

getHTML

public String getHTML()
Returns the content of the editor as an HTML string.
Example:
  String HTML;
  HTML = ControlName1.getHTML();
 
See Also:
AgcHTMLEditControl.setHTML(String)

getText

public String getText()
Returns the contents of the editor as a plain text string, ignoring the formatting information.
Example:

The following code fragment illustrates how to call getText().

   String s;
   s = ControlName1.getText();
 

getContent

public String getContent()
Returns the content of the editor.

getContentAsPlainText

public String getContentAsPlainText()
Returns the content of the editor as plain text.

setHTML

public void setHTML(String html)
Sets the text of the editor by an HTML string.
Parameters:
html - specifies the HTML to assign.
See Also:
AgcHTMLEditControl.getHTML()

isPropertyAvailable

public boolean isPropertyAvailable(String prop)
Returns true if the specified property is currently available.
Overrides:
isPropertyAvailable in class com.sssw.rt.rteditor.RTEditor
Parameters:
prop - the name of the property (one of the constant fields defined in this class).
Example:
  boolean available;
  available = ControlName1.isPropertyAvailable(AgcHTMLEditControl.IMAGE_SOURCE);
 
See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setProperty(String,Object)

getProperty

public Object getProperty(String prop)
Returns the specified property.
Overrides:
getProperty in class com.sssw.rt.rteditor.RTEditor
Parameters:
prop - the name of the property (one of the constant fields defined in this class).
Usage:

The return value is undefined if the property is not currently available.

See Also:
AgcHTMLEditControl.setProperty(String,Object), AgcHTMLEditControl.getColorProperty(String), AgcHTMLEditControl.getStringProperty(String), AgcHTMLEditControl.getBooleanProperty(String), AgcHTMLEditControl.getIntProperty(String), AgcHTMLEditControl.isPropertyAvailable(String)

setProperty

public void setProperty(String prop,
                        Object value)
Modifies the specified property.
Overrides:
setProperty in class com.sssw.rt.rteditor.RTEditor
Parameters:
prop - the name of the property (one of the constant fields defined in this class).
value -  
Usage:

Ignored if the property is not currently available.

See Also:
AgcHTMLEditControl.getProperty(String), AgcHTMLEditControl.setColorProperty(String,Color), AgcHTMLEditControl.setStringProperty(String,String), AgcHTMLEditControl.setBooleanProperty(String,boolean), AgcHTMLEditControl.setIntProperty(String,int), AgcHTMLEditControl.isPropertyAvailable(String)

getStringProperty

public String getStringProperty(String prop)
Returns a String value given a property name.
Parameters:
prop - specifies the name of the property to obtain.

The following is a list of properties returnable with this method: AgcHTMLEditControl.EDITOR_CONTEXT, AgcHTMLEditControl.PAGE_TITLE, AgcHTMLEditControl.PAGE_BGIMAGE, AgcHTMLEditControl.PAGE_BGSOUND, AgcHTMLEditControl.TABLE_BGIMAGE, AgcHTMLEditControl.CELL_BGIMAGE, AgcHTMLEditControl.PARAGRAPH_STYLENAME, AgcHTMLEditControl.TEXT_FONTNAME, AgcHTMLEditControl.TEXT_FONTSTYLE, AgcHTMLEditControl.TEXT_ANCHOR, AgcHTMLEditControl.TEXT_ANCHORTARGET, AgcHTMLEditControl.IMAGE_SOURCE, AgcHTMLEditControl.IMAGE_LINKURL, AgcHTMLEditControl.IMAGE_LINKFRAME, AgcHTMLEditControl.HOTSPOT_LINKURL, AgcHTMLEditControl.HOTSPOT_LINKFRAME

Usage:

The method returns "" if it cannot obtain a value for the specified property name.

Example:
  String imageSource;
  image Source = AgcHTMLEditControl.getStringProperty(AgcHTMLEditControl.IMAGE_SOURCE);
 
See Also:
AgcHTMLEditControl.setStringProperty(String,String)

getColorProperty

public Color getColorProperty(String prop)
Returns a Color object for the named property.
Parameters:
prop - specifies the property name.

The following is a list of properties returnable with this method: AgcHTMLEditControl.PAGE_BGCOLOR, AgcHTMLEditControl.PAGE_TEXTCOLOR, AgcHTMLEditControl.PAGE_LINKCOLOR, AgcHTMLEditControl.PAGE_VLINKCOLOR, AgcHTMLEditControl.PAGE_ALINKCOLOR, AgcHTMLEditControl.TABLE_BGCOLOR, AgcHTMLEditControl.TABLE_BORDERCOLOR, AgcHTMLEditControl.CELL_BGCOLOR, AgcHTMLEditControl.TEXT_COLOR, AgcHTMLEditControl.LINE_COLOR

Usage:

Use the setColorProperty() method to assign a Color object. If there is no Color object, the control returns Color.black.

Example:

The following code fragment illustrates how to obtain the text Color.

   Color textColor;
   textColor = ControlName1.getColorProperty(AgcHTMLEditControl.TEXT_COLOR);
 
See Also:
AgcHTMLEditControl.setColorProperty(String,Color)

getIntProperty

public int getIntProperty(String prop)
Returns an integer given a property name.
Parameters:
prop - specifies the property name.

The following is a list of properties returned by this method: AgcHTMLEditControl.PAGE_BGSOUND_LOOPCOUNT, AgcHTMLEditControl.TABLE_ALIGNMENT, AgcHTMLEditControl.TABLE_CELLPADDING, AgcHTMLEditControl.TABLE_CELLSPACING, AgcHTMLEditControl.TABLE_MINWIDTH, AgcHTMLEditControl.TABLE_MINWIDTHUNITS, AgcHTMLEditControl.TABLE_BORDERSIZE, AgcHTMLEditControl.CELL_HORIZONTALALIGNMENT, AgcHTMLEditControl.CELL_VERTICALALIGNMENT, AgcHTMLEditControl.PARAGRAPH_ALIGNMENT, AgcHTMLEditControl.PARAGRAPH_LISTSTYLE, AgcHTMLEditControl.TEXT_FONTSIZE, AgcHTMLEditControl.IMAGE_ALIGNMENT, AgcHTMLEditControl.IMAGE_BORDERSIZE, AgcHTMLEditControl.IMAGE_HORIZSPACE, AgcHTMLEditControl.IMAGE_VERTSPACE, AgcHTMLEditControl.IMAGE_HEIGHT, AgcHTMLEditControl.IMAGE_WIDTH, AgcHTMLEditControl.HOTSPOT_XPOS, AgcHTMLEditControl.HOTSPOT_YPOS, AgcHTMLEditControl.HOTSPOT_WIDTH, AgcHTMLEditControl.HOTSPOT_HEIGHT, AgcHTMLEditControl.LINE_WIDTH, AgcHTMLEditControl.LINE_WIDTH_UNITS, AgcHTMLEditControl.LINE_HEIGHT, AgcHTMLEditControl.LINE_ALIGNMENT

Usage:

The method returns zero if it cannot obtain the value.

Example:
  int fontSize;
  fontSize = ControlName1.getIntProperty(AgcHTMLEditControl.TEXT_FONTSIZE);
 
See Also:
AgcHTMLEditControl.setIntProperty(String,int)

getBooleanProperty

public boolean getBooleanProperty(String prop)
Returns a boolean given a property name.
Parameters:
prop - specifies the name of the property to obtain.

The following is a list of returnable properties for this method: AgcHTMLEditControl.PAGE_SPECIFYBG, AgcHTMLEditControl.PAGE_BGSOUND_CONTINUOUS, AgcHTMLEditControl.TABLE_BGTRANSPARENT, AgcHTMLEditControl.CELL_HEADERCELL, AgcHTMLEditControl.CELL_WRAPTEXT, AgcHTMLEditControl.CELL_BGTRANSPARENT, AgcHTMLEditControl.TEXT_STRIKETHROUGH, AgcHTMLEditControl.TEXT_BOLD, AgcHTMLEditControl.TEXT_ITALIC, AgcHTMLEditControl.TEXT_UNDERLINE, AgcHTMLEditControl.TEXT_BLINK, AgcHTMLEditControl.TEXT_SUPERSCRIPT, AgcHTMLEditControl.TEXT_SUBSCRIPT, AgcHTMLEditControl.IMAGE_SPECIFYSIZE, AgcHTMLEditControl.LINE_ISSOLID

Usage:

The method returns false if it cannot obtain a value for the named property.

Example:
  boolean textIsStrikeThrough;
  textIsStrikeThrough = ControlName1.getBooleanProperty(AgcHTMLEditControl.TEXT_STRIKETHROUGH);
 
See Also:
AgcHTMLEditControl.setBooleanProperty(String,boolean)

setStringProperty

public void setStringProperty(String prop,
                              String value)
Sets the property specified by the given name to a string value.
Parameters:
prop - String that specifies the name of the property to set.

The following is a list of properties you can set with this method: AgcHTMLEditControl.EDITOR_CONTEXT, AgcHTMLEditControl.PAGE_TITLE, AgcHTMLEditControl.PAGE_BGIMAGE, AgcHTMLEditControl.PAGE_BGSOUND, AgcHTMLEditControl.TABLE_BGIMAGE, AgcHTMLEditControl.CELL_BGIMAGE, AgcHTMLEditControl.PARAGRAPH_STYLENAME, AgcHTMLEditControl.TEXT_FONTNAME, AgcHTMLEditControl.TEXT_FONTSTYLE, AgcHTMLEditControl.TEXT_ANCHOR, AgcHTMLEditControl.TEXT_ANCHORTARGET, AgcHTMLEditControl.IMAGE_SOURCE, AgcHTMLEditControl.IMAGE_LINKURL, AgcHTMLEditControl.IMAGE_LINKFRAME, AgcHTMLEditControl.HOTSPOT_LINKURL, AgcHTMLEditControl.HOTSPOT_LINKFRAME

value - String that specifies new property value.
Example:
  String imageSource = "myImage.jpeg";
  AgcHTMLEditControl.setStringProperty(AgcHTMLEditControl.IMAGE_SOURCE, imageSource);
 
See Also:
AgcHTMLEditControl.getStringProperty(String)

setColorProperty

public void setColorProperty(String prop,
                             Color value)
Sets the named property to the given Color object.
Parameters:
prop - String that specifies the property name.

The following is a list of properties you can set using this method: AgcHTMLEditControl.PAGE_BGCOLOR, AgcHTMLEditControl.PAGE_TEXTCOLOR, AgcHTMLEditControl.PAGE_LINKCOLOR, AgcHTMLEditControl.PAGE_VLINKCOLOR, AgcHTMLEditControl.PAGE_ALINKCOLOR, AgcHTMLEditControl.TABLE_BGCOLOR, AgcHTMLEditControl.TABLE_BORDERCOLOR, AgcHTMLEditControl.CELL_BGCOLOR, AgcHTMLEditControl.TEXT_COLOR, AgcHTMLEditControl.LINE_COLOR

value - a Color object.
Usage:

Use the setColorProperty() method to assign a Color object to a given property.

Example:

The following code fragment illustrates how to get a Color from one object and use it to set the Color for a second.

   ControlName2.setColorProperty(AgcHTMLEditControl.TEXT_COLOR,
 	  			ControlName1.getColorProperty(AgcHTMLEditControl.TEXT_COLOR) );
 
See Also:
AgcHTMLEditControl.getColorProperty(String)

setIntProperty

public void setIntProperty(String prop,
                           int value)
Sets the specified property to the integer value supplied.
Parameters:
prop - String that specifies the property name.

The following is a list of properties settable using this method: AgcHTMLEditControl.PAGE_BGSOUND_LOOPCOUNT, AgcHTMLEditControl.TABLE_ALIGNMENT, AgcHTMLEditControl.TABLE_CELLPADDING, AgcHTMLEditControl.TABLE_CELLSPACING, AgcHTMLEditControl.TABLE_MINWIDTH, AgcHTMLEditControl.TABLE_MINWIDTHUNITS, AgcHTMLEditControl.TABLE_BORDERSIZE, AgcHTMLEditControl.CELL_HORIZONTALALIGNMENT, AgcHTMLEditControl.CELL_VERTICALALIGNMENT, AgcHTMLEditControl.PARAGRAPH_ALIGNMENT, AgcHTMLEditControl.PARAGRAPH_LISTSTYLE, AgcHTMLEditControl.TEXT_FONTSIZE, AgcHTMLEditControl.IMAGE_ALIGNMENT, AgcHTMLEditControl.IMAGE_BORDERSIZE, AgcHTMLEditControl.IMAGE_HORIZSPACE, AgcHTMLEditControl.IMAGE_VERTSPACE, AgcHTMLEditControl.IMAGE_HEIGHT, AgcHTMLEditControl.IMAGE_WIDTH, AgcHTMLEditControl.HOTSPOT_XPOS, AgcHTMLEditControl.HOTSPOT_YPOS, AgcHTMLEditControl.HOTSPOT_WIDTH, AgcHTMLEditControl.HOTSPOT_HEIGHT, AgcHTMLEditControl.LINE_WIDTH, AgcHTMLEditControl.LINE_WIDTH_UNITS, AgcHTMLEditControl.LINE_HEIGHT, AgcHTMLEditControl.LINE_ALIGNMENT

value - int value for the specified property.
Example:
  int fontSize = 12;
  ControlName1.setIntProperty(AgcHTMLEditControl.TEXT_FONTSIZE, fontSize);
 
See Also:
AgcHTMLEditControl.getIntProperty(String)

setBooleanProperty

public void setBooleanProperty(String prop,
                               boolean value)
Sets the specified property to the boolean value supplied.
Parameters:
prop - String that specifies the name of the property to set.

The following is a list of properties you can set using this method: AgcHTMLEditControl.PAGE_SPECIFYBG, AgcHTMLEditControl.PAGE_BGSOUND_CONTINUOUS, AgcHTMLEditControl.TABLE_BGTRANSPARENT, AgcHTMLEditControl.CELL_HEADERCELL, AgcHTMLEditControl.CELL_WRAPTEXT, AgcHTMLEditControl.CELL_BGTRANSPARENT, AgcHTMLEditControl.TEXT_STRIKETHROUGH, AgcHTMLEditControl.TEXT_BOLD, AgcHTMLEditControl.TEXT_ITALIC, AgcHTMLEditControl.TEXT_UNDERLINE, AgcHTMLEditControl.TEXT_BLINK, AgcHTMLEditControl.TEXT_SUPERSCRIPT, AgcHTMLEditControl.TEXT_SUBSCRIPT, AgcHTMLEditControl.IMAGE_SPECIFYSIZE, AgcHTMLEditControl.LINE_ISSOLID

value - Boolean value for the property.
Example:
  boolean textIsStrikeThrough = FALSE;
 ControlName1.setBooleanProperty(AgcHTMLEditControl.TEXT_STRIKETHROUGH, textIsStrikeThrough);
 
See Also:
AgcHTMLEditControl.getBooleanProperty(String)

getASCIIEncoding

public boolean getASCIIEncoding()

setASCIIEncoding

public void setASCIIEncoding(boolean encoding)
Parameters:
encoding -  

canUndo

public boolean canUndo()
Returns a boolean value that determines if operations can be undone.
Overrides:
canUndo in class com.sssw.rt.rteditor.RTEditor
Usage:

When canUndo() is true, the operation can be reversed.

Example:

The following code fragment illustrates how to use the canUndo() method.

  boolean canUndo;
  canUndo = ControlName1.canUndo();
 
See Also:
AgcHTMLEditControl.clearUndo(), AgcHTMLEditControl.redo(), AgcHTMLEditControl.canRedo(), AgcHTMLEditControl.undo(), AgcHTMLEditControl.canUndo()

canRedo

public boolean canRedo()
Returns a boolean value that determines if an operation can be redone.
Overrides:
canRedo in class com.sssw.rt.rteditor.RTEditor
Usage:

When canRedo() is true, the operation can be redone.

Example:

The following code fragment illustrates how to use the canRedo() method.

  boolean canRedo;
  canRedo = ControlName1.canRedo();
 
See Also:
AgcHTMLEditControl.clearUndo(), AgcHTMLEditControl.redo(), AgcHTMLEditControl.canRedo(), AgcHTMLEditControl.undo(), AgcHTMLEditControl.canUndo()

clearUndo

public void clearUndo()
Clears the undo chain.
Overrides:
clearUndo in class com.sssw.rt.rteditor.RTEditor
Example:

The following code fragment illustrates how to use the clearUndo() method.

  ControlName1.clearUndo();
 
See Also:
AgcHTMLEditControl.redo(), AgcHTMLEditControl.canRedo(), AgcHTMLEditControl.undo(), AgcHTMLEditControl.canUndo()

undo

public void undo()
Undoes the last operation.
Example:

The following code fragment illustrates how to use the undo() method.

  ControlName1.undo();
 
See Also:
AgcHTMLEditControl.clearUndo(), AgcHTMLEditControl.redo(), AgcHTMLEditControl.canRedo(), AgcHTMLEditControl.canUndo()

redo

public void redo()
Redoes the last operation.
Example:

The following code fragment illustrates how to use the redo() method.

  ControlName1.redo();
 
See Also:
AgcHTMLEditControl.clearUndo(), AgcHTMLEditControl.canRedo(), AgcHTMLEditControl.undo(), AgcHTMLEditControl.canUndo()

toggleBold

public void toggleBold()
Applies or unapplies the HTML strong character style to the currently selected text.
Usage:

Toggles the bold property of the current selection or text style. Some Web browsers might ignore the strong character style or might use a different way of displaying it, like using a larger point size.

Example:

The following code fragment illustrates how to use the toggleBold() method.

  ControlName1.toggleBold();
 
See Also:
AgcHTMLEditControl.toggleItalic(), AgcHTMLEditControl.toggleUnderline(), AgcHTMLEditControl.toggleHighlight()

toggleItalic

public void toggleItalic()
Applies or unapplies the HTML emphasis character style to the currently selected text.
Usage:

Toggles the italic property of the current selection or text style. Some Web browsers might ignore the emphasis character style, or display it as something other than italic, like underlined.

See Also:
AgcHTMLEditControl.toggleBold(), AgcHTMLEditControl.toggleUnderline(), AgcHTMLEditControl.toggleHighlight()

toggleUnderline

public void toggleUnderline()
Applies or unapplies the HTML underline character style to the currently selected text.
Usage:

Toggles the underline property of the current selection or text style. Some Web browsers might ignore the underline character attribute, or display it as something other than underline, like italic.

Example:

The following code fragment illustrates how to use the toggleUnderline() method.

  ControlName1.toggleUnderline();
 
See Also:
AgcHTMLEditControl.toggleBold(), AgcHTMLEditControl.toggleItalic(), AgcHTMLEditControl.toggleHighlight()

toggleHighlight

public void toggleHighlight()
Toggles between displaying only the hotspots defined on an image, and displaying the image and the hotspots.
Usage:

This method is useful when the features of a specific image or set of images make it difficult to see the outlines of its hotspots.

Example:

The following code fragment illustrates how to use the toggleHighlight() method.

  ControlName1.toggleHighlight();
 
See Also:
AgcHTMLEditControl.toggleBold(), AgcHTMLEditControl.toggleItalic(), AgcHTMLEditControl.toggleUnderline()

increaseFontSize

public void increaseFontSize()
Increases the font size of the currently selected object, making it larger in the design environment.
Usage:

Increases the font size of the current selection or text style. Note that the font size that users view at runtime can vary based on their browser setting.

Example:

The following code fragment illustrates how to use the increaseFontSize() method.

  ControlName1.increaseFontSize();
 
See Also:
AgcHTMLEditControl.decreaseFontSize(), AgcHTMLEditControl.increaseIndentation(), AgcHTMLEditControl.decreaseIndentation()

decreaseFontSize

public void decreaseFontSize()
Decreases the font size of the currently selected object, making it smaller in the design environment.
Usage:

Note that the font size that users view at runtime can vary based on their browser setting.

Example:

The following code fragment illustrates how to use the decreaseFontSize() method.

  ControlName1.decreaseFontSize();
 
See Also:
AgcHTMLEditControl.increaseFontSize(), AgcHTMLEditControl.increaseIndentation(), AgcHTMLEditControl.decreaseIndentation()

alignLeft

public void alignLeft()
Aligns the current paragraph to the left margin of the HTML page or table cell.
Example:

The following code fragment illustrates how to use the alignLeft() method.

  ControlName1.alignLeft();
 
See Also:
AgcHTMLEditControl.alignRight(), AgcHTMLEditControl.alignCenter(), AgcHTMLEditControl.alignNone()

alignCenter

public void alignCenter()
Aligns the current paragraph to the center of the page, or if the current paragraph is in a table, to the center of the current table cell.
Example:

The following code fragment illustrates how to use the alignCenter() method.

  ControlName1.alignCenter();
 
See Also:
AgcHTMLEditControl.alignLeft(), AgcHTMLEditControl.alignRight(), AgcHTMLEditControl.alignNone()

alignRight

public void alignRight()
Aligns the current paragraph to the right margin of the HTML page or table cell.
Example:

The following code fragment illustrates how to use the alignRight() method.

  ControlName1.alignRight();
 
See Also:
AgcHTMLEditControl.alignLeft(), AgcHTMLEditControl.alignCenter(), AgcHTMLEditControl.alignNone()

alignNone

public void alignNone()
Uses the default alignment for the HTML page or table cell.
Example:

The following code fragment illustrates how to use the alignNone() method.

  ControlName1.alignNone();
 
See Also:
AgcHTMLEditControl.alignLeft(), AgcHTMLEditControl.alignRight(), AgcHTMLEditControl.alignCenter()

setBulletedList

public void setBulletedList()
Sets the style of the current paragraph or selected paragraphs to bulleted list.
Example:

The following code fragment illustrates how to use the setBulletedList().

  ControlName1.setBulletedList();
 

setNumberedList

public void setNumberedList()
Sets the style of the current paragraph or selected paragraphs to numbered list.
Example:

The following code fragment illustrates how to use the setNumberedList() method.

  ControlName1.setNumberedList();
 

setBlockquote

public void setBlockquote()
Sets the block quote HTML tag.
Example:

The following code fragment illustrates how to use the setBlockquote() method.

  ControlName1.setBlockquote();
 

increaseIndentation

public void increaseIndentation()
Increases the indentation of the text at the current cursor position.
Usage:

Increases the indentation of the current paragraph or selected paragraphs.

Example:

The following code fragment illustrates how to use the increaseIndentation() method.

  ControlName1.increaseIndentation();
 
See Also:
AgcHTMLEditControl.increaseFontSize(), AgcHTMLEditControl.decreaseFontSize(), AgcHTMLEditControl.increaseIndentation(), AgcHTMLEditControl.decreaseIndentation()

decreaseIndentation

public void decreaseIndentation()
Decreases the indentation of the text at the current cursor position.
Example:

The following code fragment illustrates how to use the decreaseIndentation() method.

  ControlName1.decreaseIndentation();
 
See Also:
AgcHTMLEditControl.increaseFontSize(), AgcHTMLEditControl.decreaseFontSize(), AgcHTMLEditControl.increaseIndentation(), AgcHTMLEditControl.decreaseIndentation()

insertTableRow

public void insertTableRow()
Inserts a row in the table before the caret.
Example:

The following code fragment illustrates how to use the insertTableRow() method.

  ControlName1.insertTableRow();
 

insertTableColumn

public void insertTableColumn()
Inserts a column in the table before the caret.
Example:

The following code fragment illustrates how to use the insertTableColumn() method.

  ControlName1.insertTableColumn();
 

removeTableRow

public void removeTableRow()
Removes the current row (where the caret is) from the table.
Example:

The following code fragment illustrates how to use the removeTableRow() method.

  ControlName1.removeTableRow();
 

removeTableColumn

public void removeTableColumn()
Removes the column of the caret in the table.
Example:

The following code fragment illustrates how to use the removeTableColumn() method.

  ControlName1.removeTableColumn();
 

spanCell

public void spanCell(int row_count,
                     int column_count)
Causes text to span a column and a row.
Parameters:
row_count - specifies the number of rows to span.
column_count - specifies the number of columns to span.
Usage:

Spans the current cell to the specified row count and column count, if possible.

Example:

The following code fragment illustrates how to use the spanCell() method.

  ControlName1.spanCell(3,4);
 

mergeCells

public void mergeCells()
Merges the currently selected cells.
Example:

The following code fragment illustrates how to use the mergeCells() method.

  ControlName1.mergeCells();
 

splitCell

public void splitCell()
Splits a single table cell into two cells.
Usage:

Splits the current spanning cell to non-spanning cells.

Example:

The following code fragment illustrates how to use the splitCell() method.

  ControlName1.splitCell();
 

isEmpty

public boolean isEmpty()
Returns true if the editor is empty.
Overrides:
isEmpty in class com.sssw.rt.rteditor.RTEditor

setContextBase

public void setContextBase(URL context)
Establishes the page context by specifying the base URL used to resolve relative URLs for images, links, etc. on the page.
Overrides:
setContextBase in class com.sssw.rt.rteditor.RTEditor
Parameters:
context -  
Usage:

When an HTMLEditControl is put on a form, the page context is set automatically to the database of the form, but the data being displayed in the control could conceivably be relative to some other location. The URL specified when calling this method is used to resolve such references.


getBackgroundColor

public Color getBackgroundColor()
Deprecated. replaced by Component.getBackground().


setBackgroundColor

public void setBackgroundColor(Color backgroundcolor)
Deprecated. replaced by Component.setBackground(Color).

Parameters:
backgroundcolor -  

addAgiRTEditorListener

public void addAgiRTEditorListener(AgiRTEditorListener listener)
Parameters:
listener -  

removeAgiRTEditorListener

public void removeAgiRTEditorListener(AgiRTEditorListener listener)
Parameters:
listener -  

SilverStream
Application Server 3.5