org.opencms.ade.publish.client

类 CmsPublishSelectPanel

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

org.opencms.ade.publish.client.CmsPublishSelectPanel

所有已实现的接口:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, I_CmsPublishItemStatusUpdateHandler, I_CmsPublishSelectionChangeHandler

public class CmsPublishSelectPanel
extends com.google.gwt.user.client.ui.Composite
implements I_CmsPublishSelectionChangeHandler, I_CmsPublishItemStatusUpdateHandler

This is the main widget of the publish dialog.

It allows the user to choose which resources from the publish list should be published and/or removed from the publish list.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsPublishSelectPanel.CheckBoxUpdate Data with which to update a check box.
protected static interface	CmsPublishSelectPanel.I_CmsPublishSelectPanelUiBinder The UiBinder interface for this widget.
protected class	CmsPublishSelectPanel.MoreItemsCommand Command for adding more list items to the list of publish items.

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

字段概要

字段

限定符和类型	字段和说明
protected CmsPushButton	m_cancelButton The button for escaping from the publish dialog.
protected CmsCheckBox	m_checkboxAddContents Checkbox for including the contents of folders in the direct publish case.
protected CmsCheckBox	m_checkboxProblems The checkbox for the "show problems only" mode.
protected CmsCheckBox	m_checkboxRelated The checkbox for including related resources.
protected CmsCheckBox	m_checkboxSiblings The checkbox for including sibling resources.
protected com.google.gwt.user.client.ui.Panel	m_groupPanelContainer The panel containing the publish groups.
protected boolean	m_loading Flag to indicate whether new items are currently being added to the list.
protected CmsPublishDataModel	m_model The data model for the publish dialog.
protected com.google.gwt.user.client.ui.Label	m_noResources The label which is displayed when there are no resources to publish.
protected com.google.gwt.user.client.ui.Panel	m_problemsPanel The panel which shows a message telling the user the number of problems.
protected CmsSelectBox	m_projectSelector The project select box.
protected CmsPublishDialog	m_publishDialog The publish dialog which contains this panel.
protected CmsScrollPanel	m_scrollPanel The scroll panel containing the group panel.
protected java.util.Map<CmsUUID,org.opencms.ade.publish.client.CmsPublishItemSelectionController>	m_selectionControllers The global map of selection controllers for all groups.
protected com.google.gwt.user.client.ui.InlineLabel	m_selectorLabel The label shown in front of the project selector.
protected com.google.gwt.user.client.ui.FlowPanel	m_selectorPanel The panel containing the project selector.
protected com.google.gwt.user.client.ui.Label	m_tooManyResources Label which is shown instead of the resource list when the resource list is too long.
protected com.google.gwt.user.client.ui.Panel	m_topBar The top button bar.
protected CmsSelectBox	m_workflowSelector The workflow selector.
protected com.google.gwt.user.client.ui.InlineLabel	m_workflowsLabel The workflow selector label.

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsPublishSelectPanel(CmsPublishDialog publishDialog, java.util.List<CmsProjectBean> projects, CmsPublishOptions publishOptions, java.util.Map<java.lang.String,CmsWorkflow> workflows, java.lang.String selectedWorkflowId, int scrollPanelHeight) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
protected void	addMoreListItems() Adds more publish list items to the panel.
protected boolean	addNextItem() Tries to add a new publish list item to the panel, and returns false if there aren't any items left.
boolean	checkForProblems(java.util.Set<CmsUUID> resourceIds) Check for problems with new/deleted folders in the publish selection.
protected void	executeAction(CmsWorkflowAction action) Executes the given action.
protected void	finishLoading() The method to call when the items have finished being loaded into the list.
static java.lang.String	formatResourceCount(int resourceCount) Formats a number of publish resources in a more user-friendly form.
java.util.List<CmsPushButton>	getButtons() Returns the buttons of this panel which should be shown as the buttons of the publish dialog.
java.util.Set<CmsUUID>	getResourcesToPublish() Returns the ids of the resources which should be published.
java.util.Set<CmsUUID>	getResourcesToRemove() Returns the set of ids of resources which have been selected for removal.
java.util.Map<CmsUUID,org.opencms.ade.publish.client.CmsPublishItemSelectionController>	getSelectionControllers() Gets the global map of selection controllers.
boolean	isShowResources() Returns if the resource list is being shown.
protected void	onAddContentsClick(com.google.gwt.event.dom.client.ClickEvent event) Event handler for the 'add contents' check box.
void	onChangePublishSelection() The method that will be called when the publish resource selection has changed.
protected void	onClickCancel(com.google.gwt.event.dom.client.ClickEvent e) The event handler for the Cancel button.
protected void	onProblemClick(com.google.gwt.event.dom.client.ClickEvent event) Handles the click event for problem resources check box.
protected void	onProjectChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.String> event) Handling the value change event for the project selector.
protected void	onRelatedClick(com.google.gwt.event.dom.client.ClickEvent event) Handles the click event for related resources check box.
protected void	onSiblingClick(com.google.gwt.event.dom.client.ClickEvent event) Handles the click event for sibling resources check box.
protected void	onWorkflowChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.String> event) Handling the value change event for the project selector.
void	setGroupList(CmsPublishGroupList groups, boolean newData) Sets the publish groups used by this widget.
protected void	setGroups(java.util.List<CmsPublishGroup> groups, boolean newData) Sets the publish groups.
protected void	setProblemMode(boolean enabled) Enables or disables the "only show resources with problems" mode.
void	setShowResources(boolean showResources, java.lang.String tooManyResourcesMessage) Sets the mode to either show resources, or only show a "too many resources" message.
boolean	shouldEnablePublishButton() Returns true if the publish button should be enabled.
protected void	startLoading() The method which should be called when new items start being inserted into the list.
void	update(CmsUUID id, CmsPublishItemStatus status) Processes a status change.
static CmsPublishSelectPanel.CheckBoxUpdate	updateCheckbox(CmsPublishItemStateSummary states) Updates the state of a check box used for selecting/deselecting items.
void	updateDialogTitle() Updates the dialog title.

从类继承的方法 com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

从类继承的方法 com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

从类继承的方法 com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

m_cancelButton

@UiField
protected CmsPushButton m_cancelButton

The button for escaping from the publish dialog.

m_checkboxAddContents

@UiField
protected CmsCheckBox m_checkboxAddContents

Checkbox for including the contents of folders in the direct publish case.

m_checkboxProblems

@UiField
protected CmsCheckBox m_checkboxProblems

The checkbox for the "show problems only" mode.

m_checkboxRelated

@UiField
protected CmsCheckBox m_checkboxRelated

The checkbox for including related resources.

m_checkboxSiblings

@UiField
protected CmsCheckBox m_checkboxSiblings

The checkbox for including sibling resources.

m_groupPanelContainer

@UiField
protected com.google.gwt.user.client.ui.Panel m_groupPanelContainer

The panel containing the publish groups.

m_loading

protected boolean m_loading

Flag to indicate whether new items are currently being added to the list.

m_model

protected CmsPublishDataModel m_model

The data model for the publish dialog.

m_noResources

@UiField
protected com.google.gwt.user.client.ui.Label m_noResources

The label which is displayed when there are no resources to publish.

m_problemsPanel

@UiField
protected com.google.gwt.user.client.ui.Panel m_problemsPanel

The panel which shows a message telling the user the number of problems.

m_projectSelector

@UiField
protected CmsSelectBox m_projectSelector

The project select box.

m_publishDialog

protected CmsPublishDialog m_publishDialog

The publish dialog which contains this panel.

m_scrollPanel

@UiField
protected CmsScrollPanel m_scrollPanel

The scroll panel containing the group panel.

m_selectionControllers

protected java.util.Map<CmsUUID,org.opencms.ade.publish.client.CmsPublishItemSelectionController> m_selectionControllers

The global map of selection controllers for all groups.

m_selectorLabel

@UiField
protected com.google.gwt.user.client.ui.InlineLabel m_selectorLabel

The label shown in front of the project selector.

m_selectorPanel

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_selectorPanel

The panel containing the project selector.

m_tooManyResources

@UiField
protected com.google.gwt.user.client.ui.Label m_tooManyResources

Label which is shown instead of the resource list when the resource list is too long.

m_topBar

@UiField
protected com.google.gwt.user.client.ui.Panel m_topBar

The top button bar.

m_workflowSelector

@UiField
protected CmsSelectBox m_workflowSelector

The workflow selector.

m_workflowsLabel

@UiField
protected com.google.gwt.user.client.ui.InlineLabel m_workflowsLabel

The workflow selector label.

构造器详细资料

CmsPublishSelectPanel

public CmsPublishSelectPanel(CmsPublishDialog publishDialog,
                     java.util.List<CmsProjectBean> projects,
                     CmsPublishOptions publishOptions,
                     java.util.Map<java.lang.String,CmsWorkflow> workflows,
                     java.lang.String selectedWorkflowId,
                     int scrollPanelHeight)

Creates a new instance.

参数:

publishDialog - the publish dialog to which this panel should belong

projects - a map of projects, where the keys are the project ids and the values are the names of the projects

publishOptions - the initial publish options

workflows - the available workflows

selectedWorkflowId - the selected workflow id

scrollPanelHeight - the available scroll panel height

方法详细资料

formatResourceCount

public static java.lang.String formatResourceCount(int resourceCount)

Formats a number of publish resources in a more user-friendly form.

参数:

resourceCount - a number of resources

返回:

the formatted number of resources

updateCheckbox

public static CmsPublishSelectPanel.CheckBoxUpdate updateCheckbox(CmsPublishItemStateSummary states)

Updates the state of a check box used for selecting/deselecting items.

参数:

states - the selection states of the items for the check box

返回:

the data needed to update the check box

checkForProblems

public boolean checkForProblems(java.util.Set<CmsUUID> resourceIds)

Check for problems with new/deleted folders in the publish selection.

参数:

resourceIds - the ids of the resources selected for publishing

返回:

true if there are problems with nested

getButtons

public java.util.List<CmsPushButton> getButtons()

Returns the buttons of this panel which should be shown as the buttons of the publish dialog.

返回:

a list of buttons

getResourcesToPublish

public java.util.Set<CmsUUID> getResourcesToPublish()

Returns the ids of the resources which should be published.

返回:

a set of id strings

getResourcesToRemove

public java.util.Set<CmsUUID> getResourcesToRemove()

Returns the set of ids of resources which have been selected for removal.

返回:

a set of id strings

getSelectionControllers

public java.util.Map<CmsUUID,org.opencms.ade.publish.client.CmsPublishItemSelectionController> getSelectionControllers()

Gets the global map of selection controllers.

返回:

the map of selection controller

isShowResources

public boolean isShowResources()

Returns if the resource list is being shown.

The resource list is now shown if it is too long.

返回:

true if the resource list is being shown

onChangePublishSelection

public void onChangePublishSelection()

从接口复制的说明: I_CmsPublishSelectionChangeHandler

The method that will be called when the publish resource selection has changed.

指定者:

onChangePublishSelection 在接口中 I_CmsPublishSelectionChangeHandler

另请参阅:

I_CmsPublishSelectionChangeHandler.onChangePublishSelection()

setGroupList

public void setGroupList(CmsPublishGroupList groups,
                boolean newData)

Sets the publish groups used by this widget.

参数:

groups - the new publish groups

newData - true if the groups are new data which has been loaded

setShowResources

public void setShowResources(boolean showResources,
                    java.lang.String tooManyResourcesMessage)

Sets the mode to either show resources, or only show a "too many resources" message.

In the latter case, the check boxes for the siblings/related resources will be deactivated.

参数:

showResources - true if the resource list should be shown, false if only the given message should be shown

tooManyResourcesMessage - the message to show if there are too many resources to display

shouldEnablePublishButton

public boolean shouldEnablePublishButton()

Returns true if the publish button should be enabled.

返回:

true if the publish button should be enabled

update

public void update(CmsUUID id,
          CmsPublishItemStatus status)

从接口复制的说明: I_CmsPublishItemStatusUpdateHandler

Processes a status change.

指定者:

update 在接口中 I_CmsPublishItemStatusUpdateHandler

参数:

id - the id of the publish item whose status has changed

status - the new status

另请参阅:

I_CmsPublishItemStatusUpdateHandler.update(org.opencms.util.CmsUUID, org.opencms.ade.publish.client.CmsPublishItemStatus)

updateDialogTitle

public void updateDialogTitle()

Updates the dialog title.

addMoreListItems

protected void addMoreListItems()

Adds more publish list items to the panel.

addNextItem

protected boolean addNextItem()

Tries to add a new publish list item to the panel, and returns false if there aren't any items left.

返回:

true if an item could be added, false if no items are left

executeAction

protected void executeAction(CmsWorkflowAction action)

Executes the given action.

参数:

action - the action to execute on the selected resources

finishLoading

protected void finishLoading()

The method to call when the items have finished being loaded into the list.

onAddContentsClick

@UiHandler(value="m_checkboxAddContents")
protected void onAddContentsClick(com.google.gwt.event.dom.client.ClickEvent event)

Event handler for the 'add contents' check box.

参数:

event -

onClickCancel

@UiHandler(value="m_cancelButton")
protected void onClickCancel(com.google.gwt.event.dom.client.ClickEvent e)

The event handler for the Cancel button.

参数:

e - the event

onProblemClick

@UiHandler(value="m_checkboxProblems")
protected void onProblemClick(com.google.gwt.event.dom.client.ClickEvent event)

Handles the click event for problem resources check box.

参数:

event - the click event

另请参阅:

ClickHandler.onClick(com.google.gwt.event.dom.client.ClickEvent)

onProjectChange

@UiHandler(value="m_projectSelector")
protected void onProjectChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.String> event)

Handling the value change event for the project selector.

参数:

event - the change event

另请参阅:

ValueChangeHandler.onValueChange(ValueChangeEvent)

onRelatedClick

@UiHandler(value="m_checkboxRelated")
protected void onRelatedClick(com.google.gwt.event.dom.client.ClickEvent event)

Handles the click event for related resources check box.

参数:

event - the click event

另请参阅:

ClickHandler.onClick(com.google.gwt.event.dom.client.ClickEvent)

onSiblingClick

@UiHandler(value="m_checkboxSiblings")
protected void onSiblingClick(com.google.gwt.event.dom.client.ClickEvent event)

Handles the click event for sibling resources check box.

参数:

event - the click event

另请参阅:

ClickHandler.onClick(com.google.gwt.event.dom.client.ClickEvent)

onWorkflowChange

@UiHandler(value="m_workflowSelector")
protected void onWorkflowChange(com.google.gwt.event.logical.shared.ValueChangeEvent<java.lang.String> event)

Handling the value change event for the project selector.

参数:

event - the change event

另请参阅:

ValueChangeHandler.onValueChange(ValueChangeEvent)

setGroups

protected void setGroups(java.util.List<CmsPublishGroup> groups,
             boolean newData)

Sets the publish groups.

参数:

groups - the list of publish groups

newData - true if the data is new

setProblemMode

protected void setProblemMode(boolean enabled)

Enables or disables the "only show resources with problems" mode.

参数:

enabled - if true, enable the mode, else disable it

startLoading

protected void startLoading()

The method which should be called when new items start being inserted into the list.