eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'HTMLDocumentFrame':
Home

everywhere
www.exept.de
for:
[back]

Class: HTMLDocumentFrame

Inheritance:

   Object
   |
   +--GraphicsContext
      |
      +--DeviceGraphicsContext
         |
         +--GraphicsMedium
            |
            +--DisplaySurface
               |
               +--SimpleView
                  |
                  +--View
                     |
                     +--HTMLDocumentFrame
                        |
                        +--HTMLDocumentView
Package:
stx:libhtml
Category:
System-Documentation
Version:
rev: 1.141 date: 2009/11/11 11:21:01
user: cg
file: HTMLDocumentFrame.st directory: libhtml
module: stx stc-classLibrary: libhtml
Author:
Claus Gittinger

Description:


displays HTML documents.

Related information:

    HTMLDocumentView
    HTMLDocumentPainter

Class protocol:

cleanup
o  flushCachedImages

o  lowSpaceCleanup

defaults
o  defaultAlienAppletsEnabled

o  defaultHTMLExtension

o  defaultInternalAppletsEnabled

o  defaultJavaAppletsEnabled

o  defaultScriptExecutionEnabled

o  documentFileFor: relativePath
given a relative path in the documentation hierarchy,
find the files absolute path - first trying the current language,
if not found, try an english version

initialization
o  initialize

o  initializeFileExecutorTable

o  initializeFileExtensionTable
setup the table mapping file-name extensions to
internal document types

o  initializeInternalImageTable
setup the table mapping internal document types to
bitmap image filenames

o  update: something with: aParameter from: changedObject

startup
o  onFile: aDocumentName in: aView
create a documentationView on aDocumentName in some other view.
Returns the htmlView

o  onFile: aFileName text: htmlText top: topDirectory in: top
create a documentationView on aDocumentName or htmlText in
some other view. Returns the htmlView.
Helper for onFile:in: and onText:in:

o  onText: htmlText in: aView
create a documentationView on htmlText (must be html) in some other view.
Returns the htmlView.

Instance protocol:

accessing
o  bind: key to: value

o  currentDirectoryName
return the current URLs directoryName

o  currentDocument
return the current document

o  currentURL
return the current documents URL

o  defaultViewBackgroundColor

o  documentEncoding

o  documentEncoding: anEncodingSymbol

o  forms

o  getDocumentFilename: urlString

o  getDocumentSource: anchorHref action: action

o  getFileSource: urlString

o  history

o  homeDocument: urlString

o  homeText: someText

o  infoDisplay: aString

o  infoHolder: aValueHolder

o  locationDisplay: aString

o  model: aValueHolder

o  painter

o  rememberDocument: url host: urlHost text: text action: action inHistory: inHistory
remember that the current document was ever visited.
If inHistory is true, it is also remembered in the back-history

o  setTopDirectoryName: aDirectoryName

o  showImages: aBoolean
turn on/off image display

o  showInfo: aString

o  style
returns the style information; a dictionary filled with
font-, color- and other information

o  updateLabelFlag: aBoolean

** This is an obsolete interface - do not use it (it may vanish in future versions) **

o  updateTopViewsTitleFlag: aBoolean
When I encounter a <title>-element, I can optionally update my topview's window title.
This behavior can be controlled by setting/clearing this flag.
The default is false (explicitly turned on by the HTMLDocumentView)

o  uriHolder: aValueHolder

o  uriInputHolder: aValueHolder

o  visitedURLs

accessing-document
o  localImageAt: url put: anImage
when using the html-view internally, this allows for images to be provided by
Smalltalk, without a need for a file or http-service

o  performAction: action source: source documentName: urlString remember: rem

o  setText: text
set the text - see example

o  setText: text anchor: anchor
set the text - see example

o  setText: text anchor: anchor documentName: documentName

o  setText: text header: header footer: footer id: elementId anchor: anchor
set the text - see examples

o  setText: text plain: plain anchor: anchor documentName: documentName remember: rem

o  showDocument: urlOrUrlString

o  showDocument: url file: fileName onHost: aHost anchor: anchor remember: rem source: showSource

o  showDocument: url source: aBoolean

o  showDocument: urlOrUrlString text: anchorText action: action remember: rem source: source

o  showFileDocument: fileName

o  showFileDocument: fileName anchor: anchor remember: rem

o  showFileDocument: fileName anchor: anchor remember: rem source: showSource

o  showFileDocument: fileName remember: rem

o  showTextDocument: urlString file: file method: method remember: rem source: source

accessing-security
o  alienAppletsEnabled

o  catchErrors

o  enableAlienApplets: aBoolean

o  enableExecution: aBoolean

o  enableInternalApplets: aBoolean

o  enableJavaApplets: aBoolean

o  enableScriptExecution: aBoolean

o  internalAppletsEnabled

o  javaAppletsEnabled

o  nameSpaceForExecution: aNameSpace

o  scriptExecutionEnabled

change & update
o  update: something with: aParameter from: changedObject

defaults
o  isManPageSuffix: suffix

o  mimeTypeFromSuffix: suffix

document painter callBacks
o  appletClass: className fromURL: url

o  appletClass: className fromURL: url archive: archiveURLOrNil

o  codeStreamFor: url
returns a stream on a codeFile or nil

o  fullURLPathFor: url
returns an URL's full path

o  imageFor: urlString
returns an image or nil

o  imageFor: urlStringIn now: now
returns an image or nil. The argument now specifies, if the image
should be converted to a device image right NOW or not.
Usually, it is false (i.e. no interest in a device image) during
document scan, and true when the image is to be displayed.

o  streamForURL: urlStringIn
returns a stream or nil

o  submitDoitMethod: method form: info

o  submitForm: info

o  title: aString
define the title - a callBack when a <TITLE> tag is encountered

o  visitTest: urlString action: actionString

event handling
o  buttonMotion: state x: x y: y

o  buttonPress: button x: x y: y

o  keyPress: key x: x y: y

o  mouseWheelZoom: amount
CTRL-wheel action

o  redraw

o  redrawX: x y: y width: w height: h

o  sizeChanged: how

help
o  flyByHelpTextAt: aPoint

initialization & release
o  destroy

o  fetchDeviceResources
fetch device specific resources.

o  initFonts: aPageStyle

o  initLazyFontStyle: aFontStyle size: fontSize encoding: encoding

o  initStyle
setup style specifics.

o  initialize

o  recreate
sent after a snapin or a migration, reinit for new device

o  reinitStyle
handle dynamic style changes

internal pseudo documents
o  documentStreamForErrorResponse: reply forURL: urlString location: location onHost: aHost
return an array filled with:
stream
newDocument name
newDocument directory
documentHost
mhmh - this is not very object-oriented ...

o  documentStreamForURL: urlOrString file: urlFileName onHost: aHost
return an array filled with:
stream
newDocument name
newDocument directory
documentHost
mhmh - this is not very object-oriented ...

o  pseudoDocumentStreamForDirectory: url
a directory in an HREF - create pseudo document

o  pseudoDocumentStreamForImageFile: url
an image in an HREF - create pseudo document

o  pseudoDocumentStreamForManPageFile: url
a manPage in an HREF - create pseudo document

o  pseudoDocumentStreamForPDFFile: url
a PDF file in an HREF - create error document, if acroread cannot be opened

o  pseudoDocumentStreamForPlainFile: url
a plainFile in an HREF - create pseudo document

o  pseudoDocumentStreamForPostscriptFile: url
a postscript file in an HREF - create error document, if ghostview cannot be opened

o  pseudoDocumentStreamForUnreadableFile: urlString
an unreadable file in an HREF - create pseudo document

o  pseudoDocumentStreamForUnreadableFile: urlString message: msg
an unreadable file in an HREF - create pseudo document

o  pseudoDocumentStreamOnString: aString headLine: headLine title: title
create pseudo document showing a string

o  pseudoDocumentStreamOnString: aString title: title
create pseudo document showing a string

menu & actions
o  clickedExampleTextOrNil

o  copyExampleText

o  copyLink

o  editImage

o  editMenu
return an appropriate popUpMenu.
check if pointer is over:
an example - offer copy-example
an image - offer inspect-image
a href - offer open-new-browser

o  editThisDocument

o  executeAndInspectExampleText

o  executeExampleText

o  inspectImage

o  openNewOnAnchor

o  saveImage

o  showImageInFileBrowser

o  workspaceOnExampleText

misc
o  ampersandBindings

o  backToPreviousDocument

o  fontEncodingFor: encodingSymbol

o  getVerticalPosition

o  isValidMethod: methodString

o  positionOnAnchor: aLocalAnchor

o  showNotFound: aFileName

o  startImageFlushProcess

queries
o  documentTitle

o  heightForLines: numberOfLines
return the height of the receiver, if numberOfLines are to be displayed

o  heightOfContents

o  horizontalScrollStep

o  preferredExtentForLines: numLines cols: numCols
get an approximation for the extent to display numLines and
numCols in normal fontsize

o  verticalScrollStep
return the amount to scroll when stepping up/down (also used for mouseWheel).

o  widthOfContents

user actions
o  anchorElementSelected: anchorElement

o  exampleElementSelected: exampleElement
user clicked on an example. If execution is enabled,
evaluate it save from any exceptions (show what happened, if
any exception is raised during evaluation).
If the exampleElement has a SHOWRESULT attribute, display the
printString in the infoView.

o  executeExampleText: action withResultDo: resultAction onErrorDo: errorAction
user clicked on an example. If execution is enabled,
evaluate it save from any exceptions (show what happened, if
any exception is raised during evaluation).
If the exampleElement has a SHOWRESULT attribute, display the
printString in the infoView.

o  showResultOfCodeExample: rslt

o  updateAnchorInfoForX: x y: y
look for any anchor under the mouse pointer at x/y;
update infoLabel, if there is any

ST/X 6.1.1; WebServer 1.620 at exept:8081; Mon, 21 May 2012 17:36:27 GMT