Changeset 2521


Ignore:
Timestamp:
10/04/08 00:09:38 (6 years ago)
Author:
mosipov
Message:

Improved documentation

Location:
FCKeditor.Java/trunk/src/site
Files:
2 added
5 edited

Legend:

Unmodified
Added
Removed
  • FCKeditor.Java/trunk/src/site/apt/connector.apt

    r2510 r2521  
    6868 
    6969  The Connector is now enabled. 
    70  
    71   >>>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    72 Extending the Connector 
    73  
    74     [Hint:]  Skip this section if you are not interested in extending the 
    75              Connector. 
    76  
    77   The basic idea of extending the Connector is to provide interfaces for 
    78   user-dependent interactions which can be implemented by the web application 
    79   developer. All methods are passed the current <<<HttpServletRequest>>> instance 
    80   in order to retrieve request and/or session attributes to assemble a user-specific 
    81   return value. We intentionally do not impose any constraints or indorse any 
    82   particular implementation approach to give you the freedom to implement the 
    83   interfaces the way it fits best in your environment. 
    84  
    85   Supply the fully-qualified class names of the implementing classes as described 
    86   in the {{{properties.html}configuration settings}}. 
    87  
    88   Right now, the integration pack provides two interfaces to extend the Connector: 
    89  
    90   [[1]] {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<net.fckeditor.requestcycle.UserPathBuilder>>>}} 
    91  
    92         This interface consists only of one method <<<String getUserFilesPath(final HttpServletRequest)>>>. 
    93         You are able to construct a user-dependent <<<UserFilesPath>>>, e.g. 
    94         <<</userfiles/johndoe>>>. 
    95  
    96   [[2]] {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<net.fckeditor.requestcycle.UserAction>>>}} 
    97  
    98         There are two methods to authorize users to do file-based actions: 
    99  
    100         * <<<boolean isEnabledForFileBrowsing(final HttpServletRequest)>>> denoting 
    101           the user's ability to browse files on the server. 
    102  
    103         * <<<boolean isEnabledForFileUpload(final HttpServletRequest)>>> denoting 
    104           the user's ability to upload files to the server. 
    105  
    106         [] 
    107  
    108         For those who want to enable all users to browse and upload files, there  
    109         is a ready-to-use implementation <<<{{{java-core/apidocs/net/fckeditor/requestcycle/impl/UserActionImpl.html}UserActionImpl}}>>>. 
    110  
    111   [] 
    112   >>>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
  • FCKeditor.Java/trunk/src/site/apt/ext_overview.apt

    r2510 r2521  
    3333    File Browser. 
    3434 
    35   * <<UserPathBuilder>>: Enables you to construct a user-dependent file path. 
     35  * <<UserPathsBuilder>>: Enables you to construct a user-dependent file path. 
    3636 
    3737  * <<Localization>>: Enables you to localize any message returned by tags and 
  • FCKeditor.Java/trunk/src/site/apt/localization.apt

    r2510 r2521  
    7373 
    7474    [Hint:] The resolver system is fail-safe concerning localized string retrieval. 
    75             This means that if a localized cannot be found, the default string 
    76             will be used. 
     75            This means that if a localized string cannot be found, the default 
     76            string will be used. 
    7777 
    7878  Each responded string can be localized on a global basis and on a per-locale basis. 
  • FCKeditor.Java/trunk/src/site/apt/properties.apt

    r2510 r2521  
    3535  ... 
    3636  fckeditor.toolbarSet=Basic 
    37   connector.userActionImpl=net.fckeditor.requestcycle.impl.UserActionImpl 
     37  connector.userActionImpl=net.fckeditor.requestcycle.impl.EnabledUserAction 
    3838  ... 
    3939+------------------------------------------------------------------------------+ 
     
    4747  PropertiesLoader.setProperty("fckeditor.toolbarSet", "Basic"); 
    4848  PropertiesLoader.setProperty("connector.userActionImpl", 
    49                    "net.fckeditor.requestcycle.impl.UserActionImpl"); 
     49                   "net.fckeditor.requestcycle.impl.EnabledUserAction"); 
    5050  ... 
    5151+------------------------------------------------------------------------------+ 
     
    133133|                                                               |                                                                                       |                                                       | other renamed file type.                                                      | 
    134134*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
    135 | connector.userActionImpl              | {{{java-core/apidocs/net/fckeditor/requestcycle/impl/FalseUserAction.html}<<<net.fckeditor.requestcycle. | any fully-qualified class  | Provides custom security functions for the File       | 
    136 |                                                               | impl.FalseUserAction>>>}}                                     | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<UserAction>>>}}  | Browser Connector. For more details see {{{connector.html}here}}. | 
     135| connector.userActionImpl              | {{{java-core/apidocs/net/fckeditor/requestcycle/impl/DisabledUserAction.html}<<<net.fckeditor.requestcycle. | any fully-qualified class       | Provides custom security functions for the File       | 
     136|                                                               | impl.DisabledUserAction>>>}}                                  | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<UserAction>>>}}  | Browser Connector. For more details see {{{useraction.html}here}}. | 
    137137|                                                               |                                                                                       | implementation                        |                                                                                                       | 
    138138*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
    139139| connector.userPathBuilderImpl | {{{java-core/apidocs/net/fckeditor/requestcycle/impl/ContextPathBuilder.html}<<<net.fckeditor.requestcycle. | any fully-qualified class       | Provides a custom function for constructing a user-dependent <<<UserFilesPath>>> for the File | 
    140 |                                                               | impl.ContextPathBuilder>>>}}                          | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<UserPathBuilder>>>}} | Browser Connector. For more details see {{{connector.html}here}}. | 
     140|                                                               | impl.ContextPathBuilder>>>}}                          | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<UserPathBuilder>>>}} | Browser Connector. For more details see {{{userpathsbuilder.html}here}}. | 
    141141|                                                               |                                                                                       | implementation                        |                                                                                                       | 
    142142*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     
    150150|| Property                                                     || Default                                                                      || Valid Values || Description                                     || 
    151151*-----------------------------------+-------------------------------------------+---------------+---------------------------------------------------+ 
    152 | localization.localeResolverImpl       | {{{java-core/apidocs/net/fckeditor/localization/impl/AcceptLanguageHeaderResolver.html}<<<net.fckeditor.localization.impl. | any fully-qualified class | Provides localization capabilites for the integration pack. For more details see {{{i18n.html}here}}. | 
     152| localization.localeResolverImpl       | {{{java-core/apidocs/net/fckeditor/localization/impl/AcceptLanguageHeaderResolver.html}<<<net.fckeditor.localization.impl. | any fully-qualified class | Provides localization capabilites for the integration pack. For more details see {{{localization.html}here}}. | 
    153153|                                                                       | AcceptLanguageHeaderResolver>>>}}                     | name of a valid {{{java-core/apidocs/net/fckeditor/localization/LocaleResolver.html}<<<LocaleResolver>>>}} |  | 
    154154|                                                                       |                                                                                       | implementation|                                                                                                       | 
  • FCKeditor.Java/trunk/src/site/site.xml

    r2510 r2521  
    3535                <menu name="Extending the Library"> 
    3636                        <item name="Overview" href="/ext_overview.html"/> 
    37                         <item name="UserAction" /> 
    38                         <item name="UserPathBuilder" /> 
     37                        <item name="UserAction" href="/useraction.html" /> 
     38                        <item name="UserPathsBuilder" href="/userpathsbuilder.html" /> 
    3939                        <item name="Localization" href="/localization.html" /> 
    4040                </menu> 
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy