TextAction

java.lang.Object
- com.manydesigns.portofino.stripes.AbstractActionBean
- - com.manydesigns.portofino.pageactions.AbstractPageAction
  - - com.manydesigns.portofino.pageactions.text.TextAction

All Implemented Interfaces:

DispatchElement, PageAction, ActionBean
```
public class TextAction
extends AbstractPageAction
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction
  AbstractPageAction.TerminalResource

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTACHMENT_FILE_NAME_PATTERN`
`protected static String`	`BASE_USER_URL_PATTERN`
`String`	`CKEditor`
`Integer`	`CKEditorFuncNum`
`String`	`content`
`static String`	`CONTENT_ENCODING`
`static String`	`copyright`
`String`	`description`
`String[]`	`downloadable`
`static String`	`EMPTY_STRING`
`String`	`id`
`String`	`langCode`
`static org.slf4j.Logger`	`logger`
`String`	`message`
`static String`	`PERMISSION_EDIT`
`protected static String`	`PORTOFINO_ATTACHMENT_PATTERN`
`protected static String`	`PORTOFINO_HREF_PATTERN`
`String[]`	`selection`
`static String`	`TEXT_FILE_NAME_PATTERN`
`TextConfiguration`	`textConfiguration`
`File`	`textFile`
`String`	`title`
`FileBean`	`upload`
`boolean`	`uploadDownloadable`
`String`	`viewAttachmentUrl`

Fields inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction
CONF_FORM_PREFIX, DEFAULT_LAYOUT_CONTAINER, PAGE_CONFIGURATION_FIELDS, PAGE_CONFIGURATION_FIELDS_NO_DETAIL, pageConfigurationForm, pageInstance, pageTemplate, PORTOFINO_PAGEACTION_EXCEPTION, portofinoConfiguration, returnUrl, script, serverInfo, templates

Fields inherited from class com.manydesigns.portofino.stripes.AbstractActionBean
context

Constructor Summary

Constructors
Constructor and Description

TextAction()

Constructors
Constructor and Description
`TextAction()`

Method Summary

Methods
Modifier and Type	Method and Description
`Resolution`	`browse()`
`Resolution`	`browsePages()`
`Resolution`	`cancel()`
`protected void`	`commonUploadAttachment()`
`protected String`	`computeTextFileName()` Computes the name of the file used to store this page's content.
`Resolution`	`configure()`
`Resolution`	`configurePage()`
`Resolution`	`deleteAttachments()`
`Resolution`	`downloadAttachment()`
`Response`	`downloadContent()`
`Resolution`	`execute()`
`protected String`	`generateViewAttachmentUrl(String attachmentId)`
`String`	`getCKEditor()`
`Integer`	`getCKEditorFuncNum()`
`String`	`getContent()`
`String`	`getDescription()`
`List<Attachment>`	`getDownloadableAttachments()`
`String`	`getId()`
`String`	`getLangCode()`
`String`	`getMessage()`
`TextConfiguration`	`getTextConfiguration()`
`File`	`getTextFile()`
`String`	`getTitle()`
`FileBean`	`getUpload()`
`String`	`getViewAttachmentUrl()`
`protected void`	`loadContent()` Loads the content of the page from a file (see `locateTextFile()`).
`protected File`	`locateTextFile()` Computes the File object used to store this page's content.
`Resolution`	`manageAttachments()`
`Resolution`	`preparePage()` A lifecycle method invoked during the dispatch phase, where a http request is translated to a dispatch (a path in the page tree) ultimately leading to an action invocation.
`protected String`	`processAttachmentUrls(String content)`
`protected String`	`processContentBeforeSave(String content)` Processes the content before saving it, in order to encode internal links and attachments, and removing potentially problematic characters.
`protected String`	`processContentBeforeView(String content)`
`protected String`	`processLocalUrls(String content)`
`protected String`	`restoreAttachmentUrls(String content)`
`protected String`	`restoreLocalUrls(String content)`
`Resolution`	`saveAttachments()`
`protected void`	`saveContent()` Saves the content of the page to a file (see `locateTextFile()`).
`void`	`setCKEditor(String CKEditor)`
`void`	`setCKEditorFuncNum(Integer CKEditorFuncNum)`
`void`	`setContent(String content)`
`void`	`setDescription(String title)`
`void`	`setId(String id)`
`void`	`setLangCode(String langCode)`
`void`	`setMessage(String message)`
`void`	`setTextFile(File textFile)`
`void`	`setTitle(String title)`
`void`	`setUpload(FileBean upload)`
`void`	`setViewAttachmentUrl(String viewAttachmentUrl)`
`protected Resolution`	`streamAttachment(boolean isAttachment)`
`Resolution`	`updateConfiguration()`
`Resolution`	`updateContent()`
`Resolution`	`uploadAttachment()`
`Resolution`	`uploadAttachmentFromCKEditor()`
`Resolution`	`viewAttachment()`

Methods inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction
acceptsPathParameter, consumePathFragment, createTemplateSelectionProvider, forwardTo, forwardToPageActionError, forwardToPageActionNotConfigured, getActionAPIPath, getActionPath, getButtons, getConfiguration, getDefaultReturnUrl, getEmbeddedPageActions, getOgnlContext, getPage, getPageConfigurationForm, getPageDescription, getPageInstance, getPages, getPageTemplate, getParent, getPortofinoConfiguration, getResourcePath, getReturnUrl, getScript, getSubResource, initEmbeddedPageActions, isMultipartRequest, prepareConfigurationForms, prepareScript, readPageConfigurationFromRequest, saveConfiguration, setPageConfigurationForm, setPageInstance, setPageTemplate, setReturnUrl, setScript, updatePageConfiguration, updateScript, updateTemplate, validatePageConfiguration

Methods inherited from class com.manydesigns.portofino.stripes.AbstractActionBean
getContext, setContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.manydesigns.portofino.dispatcher.PageAction
getContext

Methods inherited from interface net.sourceforge.stripes.action.ActionBean
setContext

Field Detail

CONTENT_ENCODING

public static final String CONTENT_ENCODING

See Also:: Constant Field Values

EMPTY_STRING

public static final String EMPTY_STRING

See Also:: Constant Field Values

TEXT_FILE_NAME_PATTERN

public static final String TEXT_FILE_NAME_PATTERN

See Also:: Constant Field Values

ATTACHMENT_FILE_NAME_PATTERN

public static final String ATTACHMENT_FILE_NAME_PATTERN

See Also:: Constant Field Values

PERMISSION_EDIT

public static final String PERMISSION_EDIT

See Also:: Constant Field Values

title
```
public String title
```

description
```
public String description
```

content
```
public String content
```

selection
```
public String[] selection
```

downloadable
```
public String[] downloadable
```

uploadDownloadable
```
public boolean uploadDownloadable
```

upload
```
public FileBean upload
```

CKEditor
```
public String CKEditor
```

CKEditorFuncNum
```
public Integer CKEditorFuncNum
```

langCode
```
public String langCode
```

id
```
public String id
```

viewAttachmentUrl
```
public String viewAttachmentUrl
```

message
```
public String message
```

textConfiguration

public TextConfiguration textConfiguration

textFile
```
public File textFile
```

logger

public static final org.slf4j.Logger logger

BASE_USER_URL_PATTERN

protected static final String BASE_USER_URL_PATTERN

See Also:: Constant Field Values

PORTOFINO_ATTACHMENT_PATTERN

protected static final String PORTOFINO_ATTACHMENT_PATTERN

See Also:: Constant Field Values

PORTOFINO_HREF_PATTERN

protected static final String PORTOFINO_HREF_PATTERN

See Also:: Constant Field Values

Constructor Detail
- TextAction
```
public TextAction()
```

Method Detail

preparePage
```
public Resolution preparePage()
```
Description copied from interface: PageAction

A lifecycle method invoked during the dispatch phase, where a http request is translated to a dispatch (a path in the page tree) ultimately leading to an action invocation. This method is invoked after the PageInstance has been injected by the framework.
Also, this method is invoked on this object after it has been invoked on the PageAction corresponding to the parent page, if any.

Returns:
either null, meaning that the dispatch process is to go forward regularly, or a Resolution to be executed, interrupting normal action invocation.

execute

@DefaultHandler
public Resolution execute()
                   throws IOException

Throws:: IOException

downloadContent

@GET
@Produces(value="text/html")
public Response downloadContent()

loadContent
```
protected void loadContent()
                    throws IOException
```
Loads the content of the page from a file (see locateTextFile()). Assigns the content field.

Throws:

IOException - if there's a problem loading the content.

locateTextFile
```
protected File locateTextFile()
```
Computes the File object used to store this page's content. The default implementation looks for a file with a fixed name in this page's directory, computed by calling computeTextFileName().

Returns:
the document File.
See Also:
computeTextFileName()

computeTextFileName
```
protected String computeTextFileName()
```
Computes the name of the file used to store this page's content. The default implementation returns "text.html".

Returns:
the name of the file.
See Also:
locateTextFile()

saveContent
```
protected void saveContent()
                    throws IOException
```
Saves the content of the page to a file (see locateTextFile()).

Throws:

IOException - if there's a problem saving the content.

processContentBeforeSave
```
protected String processContentBeforeSave(String content)
```
Processes the content before saving it, in order to encode internal links and attachments, and removing potentially problematic characters.

Parameters:
content - the original content.

Returns:
the processed content.

processAttachmentUrls

protected String processAttachmentUrls(String content)

processLocalUrls

protected String processLocalUrls(String content)

cancel
```
public Resolution cancel()
```
Overrides:

cancel in class AbstractPageAction

processContentBeforeView

protected String processContentBeforeView(String content)

restoreAttachmentUrls

protected String restoreAttachmentUrls(String content)

restoreLocalUrls

protected String restoreLocalUrls(String content)

configure
```
public Resolution configure()
```

configurePage
```
public Resolution configurePage()
```

updateConfiguration

public Resolution updateConfiguration()
                               throws IOException

Throws:: IOException

uploadAttachment
```
public Resolution uploadAttachment()
```

uploadAttachmentFromCKEditor

public Resolution uploadAttachmentFromCKEditor()

commonUploadAttachment

protected void commonUploadAttachment()
                               throws IOException

Throws:: IOException

generateViewAttachmentUrl

protected String generateViewAttachmentUrl(String attachmentId)

viewAttachment
```
public Resolution viewAttachment()
```

downloadAttachment

public Resolution downloadAttachment()

streamAttachment

protected Resolution streamAttachment(boolean isAttachment)

browse
```
public Resolution browse()
```

browsePages
```
public Resolution browsePages()
```

manageAttachments
```
public Resolution manageAttachments()
```

updateContent
```
public Resolution updateContent()
```

deleteAttachments
```
public Resolution deleteAttachments()
```

saveAttachments
```
public Resolution saveAttachments()
```

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String title)

getContent
```
public String getContent()
```

setContent

public void setContent(String content)

getTextConfiguration

public TextConfiguration getTextConfiguration()

getUpload
```
public FileBean getUpload()
```

setUpload

public void setUpload(FileBean upload)

getCKEditor
```
public String getCKEditor()
```

setCKEditor

public void setCKEditor(String CKEditor)

getCKEditorFuncNum
```
public Integer getCKEditorFuncNum()
```

setCKEditorFuncNum

public void setCKEditorFuncNum(Integer CKEditorFuncNum)

getLangCode
```
public String getLangCode()
```

setLangCode

public void setLangCode(String langCode)

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getViewAttachmentUrl
```
public String getViewAttachmentUrl()
```

setViewAttachmentUrl

public void setViewAttachmentUrl(String viewAttachmentUrl)

getMessage
```
public String getMessage()
```

setMessage

public void setMessage(String message)

getTextFile
```
public File getTextFile()
```

setTextFile

public void setTextFile(File textFile)

getDownloadableAttachments

public List<Attachment> getDownloadableAttachments()

Class TextAction

Nested Class Summary

Nested classes/interfaces inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

Field Summary

Fields inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

Fields inherited from class com.manydesigns.portofino.stripes.AbstractActionBean

Constructor Summary

Method Summary

Methods inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

Methods inherited from class com.manydesigns.portofino.stripes.AbstractActionBean

Methods inherited from class java.lang.Object

Methods inherited from interface com.manydesigns.portofino.dispatcher.PageAction

Methods inherited from interface net.sourceforge.stripes.action.ActionBean

Field Detail

copyright

CONTENT_ENCODING

EMPTY_STRING

TEXT_FILE_NAME_PATTERN

ATTACHMENT_FILE_NAME_PATTERN

PERMISSION_EDIT

title

description

content

selection

downloadable

uploadDownloadable

upload

CKEditor

CKEditorFuncNum

langCode

id

viewAttachmentUrl

message

textConfiguration

textFile

logger

BASE_USER_URL_PATTERN

PORTOFINO_ATTACHMENT_PATTERN

PORTOFINO_HREF_PATTERN

Constructor Detail

TextAction

Method Detail

preparePage

execute

downloadContent

loadContent

locateTextFile

computeTextFileName

saveContent

processContentBeforeSave

processAttachmentUrls

processLocalUrls

cancel

processContentBeforeView

restoreAttachmentUrls

restoreLocalUrls

configure

configurePage

updateConfiguration

uploadAttachment

uploadAttachmentFromCKEditor

commonUploadAttachment

generateViewAttachmentUrl

viewAttachment

downloadAttachment

streamAttachment

browse

browsePages

manageAttachments

updateContent

deleteAttachments

saveAttachments

getTitle

setTitle

getDescription

setDescription

getContent

setContent

getTextConfiguration

getUpload