From 3590c9bb84b8e7960569873e465bc6d1d29ec9eb Mon Sep 17 00:00:00 2001 From: codyhoag Date: Mon, 17 Apr 2017 17:20:52 -0400 Subject: [PATCH] LRDOCS-3504 replicate sources --- .../blade.document.action/README.markdown | 39 +++++++++++++++---- .../BladeActionConfigurationIcon.java | 7 ++-- .../BladeActionDisplayContext.java | 4 +- .../BladeActionDisplayContextFactory.java | 3 +- maven/blade.document.action/README.markdown | 39 +++++++++++++++---- .../BladeActionConfigurationIcon.java | 7 ++-- .../BladeActionDisplayContext.java | 4 +- .../BladeActionDisplayContextFactory.java | 3 +- 8 files changed, 76 insertions(+), 30 deletions(-) diff --git a/liferay-workspace/modules/blade.document.action/README.markdown b/liferay-workspace/modules/blade.document.action/README.markdown index ab1f716df..b88493fe0 100644 --- a/liferay-workspace/modules/blade.document.action/README.markdown +++ b/liferay-workspace/modules/blade.document.action/README.markdown @@ -1,14 +1,37 @@ -# Action for Documents and Media Portlet +# Document Action -The blade.document.action is showing how to add a context menu to some entry in Documents and Media Portlet according to this [article](https://blogs.aca-it.be/liferay-dxp-document-actions/). You can see the effect in Documents and Media Admin Portlet(Control Panel->Liferay->Content->Documents and Media). -see the image below: +The Document Action sample shows how to add a context menu option to an entry in +the Documents and Media portlet. When deploying this sample with no +customizations, an additional menu option is available in the Documents and +Media Admin portlet and the Documents and Media portlet. This sample creates a +*Blade Basic Info* option that displays basic information about the entry (e.g., +file name, type, version, etc.). For example, the Admin portlet provides the new +option as illustrated in the images below: -![Documents And Media Admin Portlet](https://github.com/liferay/liferay-blade-samples/tree/master/docImages/DocumentsAndMediaAdminPortlet.png) +![Documents And Media Admin Portlet](https://github.com/codyhoag/liferay-docs/blob/blade-sample-images/develop/tutorials/blade-images/documents-and-media-admin-portlet.png) -![Documents And Media Admin Portlet Detail](https://github.com/liferay/liferay-blade-samples/tree/master/docImages/DocumentsAndMediaAdminPortlet_Detail.png) +![Documents And Media Admin Portlet Detail](https://github.com/codyhoag/liferay-docs/blob/blade-sample-images/develop/tutorials/blade-images/documents-and-media-admin-portlet-detail.png) -Also you can see the same effect in Documents and Media Portlet , but you should check `Show Actions` in `Configuration` of the portlet first. +Likewise, the Documents and Media portlet provides the same option after +selecting `Show Actions` from the portlet's `Configuration` menu. -![Documents And Media Portlet](https://github.com/liferay/liferay-blade-samples/tree/master/docImages/DocumentsAndMediaPortlet.png) +![Documents And Media Portlet](https://github.com/codyhoag/liferay-docs/blob/blade-sample-images/develop/tutorials/blade-images/documents-and-media-portlet.png) -![Documents And Media Portlet Detail](https://github.com/liferay/liferay-blade-samples/tree/master/docImages/DocumentsAndMediaPortlet_Detail.png) \ No newline at end of file +![Documents And Media Portlet Detail](https://github.com/codyhoag/liferay-docs/blob/blade-sample-images/develop/tutorials/blade-images/documents-and-media-portlet-detail.png) + +There are four Java classes used in this sample: + +- `BladeActionConfigurationIcon`: Adds the new context menu option to the + Document Detail screen options (top right corner) of the Documents and Media + Admin portlet. See the + [Configuring Your App's Actions Menu](https://dev.liferay.com/develop/tutorials/-/knowledge_base/7-0/applying-lexicon-styles-to-your-app#configuring-your-apps-actions-menu) + tutorial for more details. +- `BladeActionDisplayContext`: Adds the + [Display Context](https://dev.liferay.com/participate/liferaypedia/-/wiki/Main/Display+Context) + for the document action. +- `BladeActionDisplayContextFactory`: Adds the + [Display Context](https://dev.liferay.com/participate/liferaypedia/-/wiki/Main/Display+Context) + factory for the document action. +- `BladeDocumentActionPortlet`: Provides the portlet class, which extends the + [GenericPortlet](https://portals.apache.org/pluto/portlet-2.0-apidocs/javax/portlet/GenericPortlet.html). + This class generates what is shown when the context menu option is selected. \ No newline at end of file diff --git a/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/configurationicon/BladeActionConfigurationIcon.java b/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/configurationicon/BladeActionConfigurationIcon.java index 40a52ed26..e92de5b0c 100644 --- a/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/configurationicon/BladeActionConfigurationIcon.java +++ b/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/configurationicon/BladeActionConfigurationIcon.java @@ -43,10 +43,9 @@ import org.osgi.service.component.annotations.Reference; /** - * This class is for adding context menu to Document Detail screen options(top right corner) in - * Documents and Media admin portlet.
- * see - * CONFIGURING YOUR APPS ACTIONS MENU. + * Adds the new context menu option to the Document Detail screen options (top + * right corner) of the Documents and Media Admin portlet. + * * @author liferay */ @Component( diff --git a/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContext.java b/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContext.java index 43ca9593f..e9d795235 100644 --- a/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContext.java +++ b/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContext.java @@ -50,8 +50,8 @@ import javax.servlet.http.HttpServletResponse; /** - * Custom Display Context.
- * see DISPLAY CONTEXT. + * Provides the Custom Display Context, which provides access to the Documents + * and Media portlet's UI elements. * * @author liferay */ diff --git a/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContextFactory.java b/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContextFactory.java index 840975763..322e7118b 100644 --- a/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContextFactory.java +++ b/liferay-workspace/modules/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContextFactory.java @@ -30,7 +30,8 @@ import org.osgi.service.component.annotations.Component; /** - * register a DLDisplayContextFactory to provide custom Display Context + * Implements the DLDisplayContextFactory to provide custom display contexts. + * * @author liferay */ @Component(immediate = true, service = DLDisplayContextFactory.class) diff --git a/maven/blade.document.action/README.markdown b/maven/blade.document.action/README.markdown index ab1f716df..b88493fe0 100644 --- a/maven/blade.document.action/README.markdown +++ b/maven/blade.document.action/README.markdown @@ -1,14 +1,37 @@ -# Action for Documents and Media Portlet +# Document Action -The blade.document.action is showing how to add a context menu to some entry in Documents and Media Portlet according to this [article](https://blogs.aca-it.be/liferay-dxp-document-actions/). You can see the effect in Documents and Media Admin Portlet(Control Panel->Liferay->Content->Documents and Media). -see the image below: +The Document Action sample shows how to add a context menu option to an entry in +the Documents and Media portlet. When deploying this sample with no +customizations, an additional menu option is available in the Documents and +Media Admin portlet and the Documents and Media portlet. This sample creates a +*Blade Basic Info* option that displays basic information about the entry (e.g., +file name, type, version, etc.). For example, the Admin portlet provides the new +option as illustrated in the images below: -![Documents And Media Admin Portlet](https://github.com/liferay/liferay-blade-samples/tree/master/docImages/DocumentsAndMediaAdminPortlet.png) +![Documents And Media Admin Portlet](https://github.com/codyhoag/liferay-docs/blob/blade-sample-images/develop/tutorials/blade-images/documents-and-media-admin-portlet.png) -![Documents And Media Admin Portlet Detail](https://github.com/liferay/liferay-blade-samples/tree/master/docImages/DocumentsAndMediaAdminPortlet_Detail.png) +![Documents And Media Admin Portlet Detail](https://github.com/codyhoag/liferay-docs/blob/blade-sample-images/develop/tutorials/blade-images/documents-and-media-admin-portlet-detail.png) -Also you can see the same effect in Documents and Media Portlet , but you should check `Show Actions` in `Configuration` of the portlet first. +Likewise, the Documents and Media portlet provides the same option after +selecting `Show Actions` from the portlet's `Configuration` menu. -![Documents And Media Portlet](https://github.com/liferay/liferay-blade-samples/tree/master/docImages/DocumentsAndMediaPortlet.png) +![Documents And Media Portlet](https://github.com/codyhoag/liferay-docs/blob/blade-sample-images/develop/tutorials/blade-images/documents-and-media-portlet.png) -![Documents And Media Portlet Detail](https://github.com/liferay/liferay-blade-samples/tree/master/docImages/DocumentsAndMediaPortlet_Detail.png) \ No newline at end of file +![Documents And Media Portlet Detail](https://github.com/codyhoag/liferay-docs/blob/blade-sample-images/develop/tutorials/blade-images/documents-and-media-portlet-detail.png) + +There are four Java classes used in this sample: + +- `BladeActionConfigurationIcon`: Adds the new context menu option to the + Document Detail screen options (top right corner) of the Documents and Media + Admin portlet. See the + [Configuring Your App's Actions Menu](https://dev.liferay.com/develop/tutorials/-/knowledge_base/7-0/applying-lexicon-styles-to-your-app#configuring-your-apps-actions-menu) + tutorial for more details. +- `BladeActionDisplayContext`: Adds the + [Display Context](https://dev.liferay.com/participate/liferaypedia/-/wiki/Main/Display+Context) + for the document action. +- `BladeActionDisplayContextFactory`: Adds the + [Display Context](https://dev.liferay.com/participate/liferaypedia/-/wiki/Main/Display+Context) + factory for the document action. +- `BladeDocumentActionPortlet`: Provides the portlet class, which extends the + [GenericPortlet](https://portals.apache.org/pluto/portlet-2.0-apidocs/javax/portlet/GenericPortlet.html). + This class generates what is shown when the context menu option is selected. \ No newline at end of file diff --git a/maven/blade.document.action/src/main/java/blade/document/action/configurationicon/BladeActionConfigurationIcon.java b/maven/blade.document.action/src/main/java/blade/document/action/configurationicon/BladeActionConfigurationIcon.java index 40a52ed26..e92de5b0c 100644 --- a/maven/blade.document.action/src/main/java/blade/document/action/configurationicon/BladeActionConfigurationIcon.java +++ b/maven/blade.document.action/src/main/java/blade/document/action/configurationicon/BladeActionConfigurationIcon.java @@ -43,10 +43,9 @@ import org.osgi.service.component.annotations.Reference; /** - * This class is for adding context menu to Document Detail screen options(top right corner) in - * Documents and Media admin portlet.
- * see - * CONFIGURING YOUR APPS ACTIONS MENU. + * Adds the new context menu option to the Document Detail screen options (top + * right corner) of the Documents and Media Admin portlet. + * * @author liferay */ @Component( diff --git a/maven/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContext.java b/maven/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContext.java index 43ca9593f..e9d795235 100644 --- a/maven/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContext.java +++ b/maven/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContext.java @@ -50,8 +50,8 @@ import javax.servlet.http.HttpServletResponse; /** - * Custom Display Context.
- * see DISPLAY CONTEXT. + * Provides the Custom Display Context, which provides access to the Documents + * and Media portlet's UI elements. * * @author liferay */ diff --git a/maven/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContextFactory.java b/maven/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContextFactory.java index 840975763..322e7118b 100644 --- a/maven/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContextFactory.java +++ b/maven/blade.document.action/src/main/java/blade/document/action/displaycontext/BladeActionDisplayContextFactory.java @@ -30,7 +30,8 @@ import org.osgi.service.component.annotations.Component; /** - * register a DLDisplayContextFactory to provide custom Display Context + * Implements the DLDisplayContextFactory to provide custom display contexts. + * * @author liferay */ @Component(immediate = true, service = DLDisplayContextFactory.class)