info.magnolia.cms.gui.dialog
Interface DialogControl

All Known Subinterfaces:
UUIDDialogControl
All Known Implementing Classes:
Dialog, DialogBox, DialogButton, DialogButtonSet, DialogControlImpl, DialogDate, DialogEdit, DialogEditCode, DialogEditWithButton, DialogEditWithCustomButtons, DialogFile, DialogFreemarker, DialogHidden, DialogInclude, DialogLink, DialogMultiSelect, DialogPassword, DialogPasswordHash, DialogSelect, DialogStatic, DialogTab, DialogUUIDLink, SearchOnly

public interface DialogControl

Interface for dialogs. A Magnolia Dialog should at least implements the drawHtml method to add html code to a page. Dialogs must have an empty constructor; the init(Content, Content, PageContext) is assured to be called before any other operation.

Version:
2.0
Author:
Vinzenz Wyser

Method Summary
 void drawHtml(Writer out)
          Actually draw the dialog content.
 void init(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, info.magnolia.cms.core.Content websiteNode, info.magnolia.cms.core.Content configNode)
          Initialize a Dialog.
 

Method Detail

init

void init(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response,
          info.magnolia.cms.core.Content websiteNode,
          info.magnolia.cms.core.Content configNode)
          throws javax.jcr.RepositoryException
Initialize a Dialog. This method is guaranteed to be called just after the control instantiation.

Parameters:
request - current HttpServletRequest
response - current HttpServletResponse
websiteNode - current website node
configNode - configuration node for the dialog
Throws:
javax.jcr.RepositoryException

drawHtml

void drawHtml(Writer out)
              throws IOException
Actually draw the dialog content.

Parameters:
out - Writer
Throws:
IOException - exceptions thrown when writing to the Writer can be safely rethrown by the dialog


Copyright © 2003-2013 Magnolia International Ltd.. All Rights Reserved.