Package ro.sync.ecss.extensions.dita.topic.table.simpletable.properties

Class SimpleTableShowPropertiesOperationBase

java.lang.Object

ro.sync.ecss.extensions.commons.table.properties.ShowTablePropertiesBaseOperation

ro.sync.ecss.extensions.dita.topic.table.simpletable.properties.SimpleTableShowPropertiesOperationBase

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

ChoiceTableShowPropertiesOperation, SimpleTableShowPropertiesOperation

@API(type=INTERNAL,
     src=PUBLIC)
public class SimpleTableShowPropertiesOperationBase
extends ShowTablePropertiesBaseOperation

Base operation for edit choice properties on DITA simple tables.

Field Summary

Fields inherited from class ro.sync.ecss.extensions.commons.table.properties.ShowTablePropertiesBaseOperation

authorAccess, tableHelper

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
SimpleTableShowPropertiesOperationBase(TablePropertiesHelper helper)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	computeFragmentMoveInsideHeader(List<AuthorDocumentFragment> fragments, List<Position> offsets, TabInfo tabInfo, List<AuthorElement> nodesToModify, AuthorElement currentNode)	Computes the fragment and position, inside header element, for the given node.
protected boolean	computeFragmentsToMoveInsideBody(List<AuthorDocumentFragment> fragments, List<Position> offsets, TabInfo tabInfo, List<AuthorElement> nodesToModify, AuthorElement currentNode)	Computes the fragment and position, inside body element, for the given node.
protected boolean	computeFragmentsToMoveInsideFooter(List<AuthorDocumentFragment> fragments, List<Position> offsets, TabInfo tabInfo, List<AuthorElement> nodesToModify, AuthorElement currentNode)	Computes the fragment and position, inside footer element, for the given node.
protected List<TabInfo>	getCategoriesAndProperties(List<Integer[]> selections)	Obtain the categories from the table properties dialog.
protected String	getHelpPageID()	Get the ID of the help page which will be called by the end user.
protected List<TableProperty>	getTableAttribute()	Obtain the table attributes.

Methods inherited from class ro.sync.ecss.extensions.commons.table.properties.ShowTablePropertiesBaseOperation

checkRowSpans, doOperation, getArguments, getAttrProperty, getCommonValue, getDescription, getElementsWithModifiedAttributes, getFragmentsAndOffsetsToInsert, getSelectedTab, getTableInformation, showTableProperties

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleTableShowPropertiesOperationBase

public SimpleTableShowPropertiesOperationBase(TablePropertiesHelper helper)

Constructor.

Parameters:

helper - The helper.

Method Details

getCategoriesAndProperties

protected List<TabInfo> getCategoriesAndProperties(List<Integer[]> selections)

Description copied from class: ShowTablePropertiesBaseOperation

Obtain the categories from the table properties dialog. The categories maps the tab name to the list of properties that will be modified in the corresponding tab panel. Every property will be modified using a combobox/radios which will contain the possible values for that property. The label string for the combobox/radios group will be the provided render string of the property or the property name, if a render string is not provided.

Specified by:

getCategoriesAndProperties in class ShowTablePropertiesBaseOperation

Parameters:

selections - The currently selected nodes or the node at caret position.

Returns:

A list of tab info objects containing the tab names and the corresponding properties list.

See Also:

• ShowTablePropertiesBaseOperation.getCategoriesAndProperties(java.util.List)

computeFragmentsToMoveInsideFooter

protected boolean computeFragmentsToMoveInsideFooter(List<AuthorDocumentFragment> fragments,
 List<Position> offsets,
 TabInfo tabInfo,
 List<AuthorElement> nodesToModify,
 AuthorElement currentNode)
                                              throws AuthorOperationException

Description copied from class: ShowTablePropertiesBaseOperation

Computes the fragment and position, inside footer element, for the given node.

Specified by:

computeFragmentsToMoveInsideFooter in class ShowTablePropertiesBaseOperation

Parameters:

fragments - A list with already computed fragments. The new fragment will be added to this list.

offsets - A list with positions where the given fragments will be inserted.

tabInfo - The current edited tab info.

nodesToModify - A list containing all the nodes that will be deleted.

currentNode - The node to be checked if it should be moved.

Returns:

true if the parent of the given node parent should be also deleted.

Throws:

AuthorOperationException - If the new parent fragment could not be inserted.

See Also:

• ShowTablePropertiesBaseOperation.computeFragmentsToMoveInsideFooter(java.util.List, java.util.List, ro.sync.ecss.extensions.commons.table.properties.TabInfo, java.util.List, ro.sync.ecss.extensions.api.node.AuthorElement)

computeFragmentMoveInsideHeader

protected boolean computeFragmentMoveInsideHeader(List<AuthorDocumentFragment> fragments,
 List<Position> offsets,
 TabInfo tabInfo,
 List<AuthorElement> nodesToModify,
 AuthorElement currentNode)
                                           throws AuthorOperationException

Description copied from class: ShowTablePropertiesBaseOperation

Computes the fragment and position, inside header element, for the given node.

Specified by:

computeFragmentMoveInsideHeader in class ShowTablePropertiesBaseOperation

Parameters:

fragments - A list with already computed fragments. The new fragment will be added to this list.

offsets - A list with positions where the given fragments will be inserted.

tabInfo - The current edited tab info.

nodesToModify - A list containing all the nodes that will be deleted.

currentNode - The node to be checked if it should be moved.

Returns:

true if the parent of the given node parent should be also deleted.

Throws:

AuthorOperationException - If the new parent fragment could not be inserted.

See Also:

• ShowTablePropertiesBaseOperation.computeFragmentMoveInsideHeader(java.util.List, java.util.List, ro.sync.ecss.extensions.commons.table.properties.TabInfo, java.util.List, ro.sync.ecss.extensions.api.node.AuthorElement)

computeFragmentsToMoveInsideBody

protected boolean computeFragmentsToMoveInsideBody(List<AuthorDocumentFragment> fragments,
 List<Position> offsets,
 TabInfo tabInfo,
 List<AuthorElement> nodesToModify,
 AuthorElement currentNode)
                                            throws AuthorOperationException

Description copied from class: ShowTablePropertiesBaseOperation

Computes the fragment and position, inside body element, for the given node.

Specified by:

computeFragmentsToMoveInsideBody in class ShowTablePropertiesBaseOperation

Parameters:

fragments - A list with already computed fragments. The new fragment will be added to this list.

offsets - A list with positions where the given fragments will be inserted.

tabInfo - The current edited tab info.

nodesToModify - A list containing all the nodes that will be deleted.

currentNode - The node to be checked if it should be moved.

Returns:

true if the parent of the given node parent should be also deleted.

Throws:

AuthorOperationException - If the new parent fragment could not be inserted.

See Also:

• ShowTablePropertiesBaseOperation.computeFragmentsToMoveInsideBody(java.util.List, java.util.List, ro.sync.ecss.extensions.commons.table.properties.TabInfo, java.util.List, ro.sync.ecss.extensions.api.node.AuthorElement)

getTableAttribute

protected List<TableProperty> getTableAttribute()

Description copied from class: ShowTablePropertiesBaseOperation

Obtain the table attributes.

Specified by:

getTableAttribute in class ShowTablePropertiesBaseOperation

Returns:

A list with TableProperty objects containing the table attributes qualified name, render string and possible values.

See Also:

• ShowTablePropertiesBaseOperation.getTableAttribute()

getHelpPageID

protected String getHelpPageID()

Description copied from class: ShowTablePropertiesBaseOperation

Get the ID of the help page which will be called by the end user.

Overrides:

getHelpPageID in class ShowTablePropertiesBaseOperation

Returns:

the ID of the help page which will be called by the end user or null.

See Also:

• ShowTablePropertiesBaseOperation.getHelpPageID()