ch.sahits.game.openpatrician.display.dialog.service

Class DialogUtil

java.lang.Object

ch.sahits.game.openpatrician.display.dialog.service.DialogUtil

@Component
public class DialogUtil
extends Object

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Dec 20, 2013

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DialogUtil.SailorOnShipBinding Sailors on ship binding with min and max.
private class	DialogUtil.SimpleSailorOnShipBinding Sailors on ship binding.

Field Summary

Fields

Modifier and Type	Field and Description
private JavaFXUtils	fxUtils
private SelectiveCachableXMLImageLoader	imageLoader
private ch.sahits.game.openpatrician.utilities.l10n.Locale	locale
private org.apache.logging.log4j.Logger	logger
private org.springframework.context.MessageSource	messageSource
private ch.sahits.game.openpatrician.clientserverinterface.service.ShipService	shipService
private DecoratedTextFactory	textFactory
private org.springframework.oxm.Unmarshaller	unmarshaller
private ch.sahits.game.openpatrician.data.xmlmodel.WeaponLocations	weaponLocations

Constructor Summary

Constructors

Constructor and Description
DialogUtil()

Method Summary

Modifier and Type	Method and Description
javafx.scene.layout.Pane	center(javafx.scene.control.Control childNode) Create an element that will layout the childNode horizontally centered within a Dialog.
javafx.scene.layout.Pane	center(javafx.scene.image.ImageView childNode) Create an element that will layout the childNode horizontally centered within a Dialog.
javafx.scene.Group	center(javafx.scene.layout.Pane childNode) Create an element that will layout the childNode horizontally centered within a Dialog.
javafx.scene.layout.GridPane	createGridPaneFromModel(Table model) Create a grid pane based on a model.
javafx.event.EventHandler<javafx.scene.input.MouseEvent>	createNextActionForShips(javafx.collections.ObservableList<ch.sahits.game.openpatrician.model.ship.IShip> ships, javafx.beans.property.ObjectProperty<ch.sahits.game.openpatrician.model.ship.IShip> currentShip) Navigate to the next ship in the catalogue.
javafx.event.EventHandler<javafx.scene.input.MouseEvent>	createPreviousActionForShips(javafx.collections.ObservableList<ch.sahits.game.openpatrician.model.ship.IShip> ships, javafx.beans.property.ObjectProperty<ch.sahits.game.openpatrician.model.ship.IShip> currentShip) Navigate to the previous ship in the catalogue.
javafx.scene.layout.GridPane	createShipInfoOnThreeLines(javafx.beans.property.ObjectProperty<ch.sahits.game.openpatrician.model.ship.IShip> currentShip) Create the grid pane for the ship information on three lines.
javafx.scene.layout.GridPane	createShipSelection3LinesForShips(javafx.collections.ObservableList<ch.sahits.game.openpatrician.model.ship.IShip> ships, javafx.beans.property.ObjectProperty<ch.sahits.game.openpatrician.model.ship.IShip> currentShip) Create the grid pane for the ship selection on three lines.
javafx.scene.layout.Pane	createShipWeaponDisplay(ch.sahits.game.openpatrician.model.ship.IShip ship) Create the weapon display with all weapons and place holders.
javafx.scene.Node	createVerticalSpacer(int heigth) Create a Node that forces vertical spacing.
private javafx.beans.property.ObjectProperty<DecoratedText>	createWeaponStrength(ch.sahits.game.openpatrician.model.ship.IShip currentShip)
javafx.beans.binding.BooleanBinding	enableShipCatalogueForShips(javafx.collections.ObservableList<ch.sahits.game.openpatrician.model.ship.IShip> ships) Boolean binding for the navigation enabling of the ships cataloque.
private javafx.scene.image.ImageView	getShipDeck(ch.sahits.game.openpatrician.model.ship.EShipType shipType)
private javafx.scene.image.ImageView	getShipWeapon(ch.sahits.game.openpatrician.model.ship.IWeaponSlot weaponSlot)
private ch.sahits.game.openpatrician.data.xmlmodel.BasicSlot	getSlotModel(int id)
private Source	getSourceFromFile(String fileName)
private javafx.scene.image.ImageView	getWeaponPlaceHolder(ch.sahits.game.openpatrician.model.ship.ESide side)
private void	initilizeWeaponModel()
int	removeById(javafx.scene.layout.Pane parent, String id) Remove a node identified by id from the parent and return the index.
javafx.scene.layout.Pane	right(javafx.scene.control.Control childNode) Create an element that will layout the childNode at the right dialog content border.
javafx.scene.Group	right(javafx.scene.layout.Pane childNode) Create an element that will layout the childNode at the right dialog content border.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private final org.apache.logging.log4j.Logger logger

fxUtils

@Autowired
private JavaFXUtils fxUtils

shipService

@Autowired
private ch.sahits.game.openpatrician.clientserverinterface.service.ShipService shipService

locale

@Autowired
private ch.sahits.game.openpatrician.utilities.l10n.Locale locale

messageSource

@Autowired
private org.springframework.context.MessageSource messageSource

textFactory

@Autowired
private DecoratedTextFactory textFactory

imageLoader

@Autowired
 @Qualifier(value="xmlImageLoader")
private SelectiveCachableXMLImageLoader imageLoader

unmarshaller

@Autowired
 @Qualifier(value="jaxb2XmlModelMarshaller")
private org.springframework.oxm.Unmarshaller unmarshaller

weaponLocations

private ch.sahits.game.openpatrician.data.xmlmodel.WeaponLocations weaponLocations

Constructor Detail

DialogUtil

public DialogUtil()

Method Detail

initilizeWeaponModel

@PostConstruct
private void initilizeWeaponModel()

getSourceFromFile

private Source getSourceFromFile(String fileName)

enableShipCatalogueForShips

public javafx.beans.binding.BooleanBinding enableShipCatalogueForShips(javafx.collections.ObservableList<ch.sahits.game.openpatrician.model.ship.IShip> ships)

Boolean binding for the navigation enabling of the ships cataloque. Only the ships are considered (convoys are excluded)

Parameters:

ships - to be observed.

Returns:

binding.

createNextActionForShips

public javafx.event.EventHandler<javafx.scene.input.MouseEvent> createNextActionForShips(javafx.collections.ObservableList<ch.sahits.game.openpatrician.model.ship.IShip> ships,
                                                                                         javafx.beans.property.ObjectProperty<ch.sahits.game.openpatrician.model.ship.IShip> currentShip)

Navigate to the next ship in the catalogue. Only the ships are considered (convoys are excluded)

Parameters:

ships - in the selection

currentShip - current ship

Returns:

Event handler for the navigation.

createPreviousActionForShips

public javafx.event.EventHandler<javafx.scene.input.MouseEvent> createPreviousActionForShips(javafx.collections.ObservableList<ch.sahits.game.openpatrician.model.ship.IShip> ships,
                                                                                             javafx.beans.property.ObjectProperty<ch.sahits.game.openpatrician.model.ship.IShip> currentShip)

Navigate to the previous ship in the catalogue. Only the ships are considered (convoys are excluded)

Parameters:

ships - in the selection

currentShip - current ship

Returns:

Event handler for the navigation.

createGridPaneFromModel

public javafx.scene.layout.GridPane createGridPaneFromModel(Table model)

Create a grid pane based on a model.

Parameters:

model - base model

Returns:

grid pane

createShipSelection3LinesForShips

public javafx.scene.layout.GridPane createShipSelection3LinesForShips(javafx.collections.ObservableList<ch.sahits.game.openpatrician.model.ship.IShip> ships,
                                                                      javafx.beans.property.ObjectProperty<ch.sahits.game.openpatrician.model.ship.IShip> currentShip)

Create the grid pane for the ship selection on three lines. The currently selected ship is the first in ships.

     +----------+-------------+-------------+-------------+-----------+
     |                      ship type and name                        |
     |prevShip  | weapon icon | health icon | sailor icon |   nextShip|
     |          |weapon amount|   health    | no. sailors |           |
     +----------+-------------+-------------+-------------+-----------+
 

Parameters:

ships - observable list of ships through which is to be navigated.

currentShip - container to store the currently selected ship. The value will be set as par of the execution.

Returns:

GridPane displaying ship details like weapon strength, health and crew compliment as well as navigation capabilities through the list of ships.

createShipInfoOnThreeLines

public javafx.scene.layout.GridPane createShipInfoOnThreeLines(javafx.beans.property.ObjectProperty<ch.sahits.game.openpatrician.model.ship.IShip> currentShip)

Create the grid pane for the ship information on three lines.

     +------------+-------------+-------------+-------------+
     | ship type and name                                   |
     | knot icon  | weapon icon | health icon | sailor icon |
     |            |weapon amount|   health    | no. sailors |
     +------------+-------------+-------------+-------------+
 

Parameters:

currentShip - container to store the currently selected ship. The value will be set as par of the execution.

Returns:

GridPane displaying ship details like speed, weapon strength, health and crew compliment.

createWeaponStrength

private javafx.beans.property.ObjectProperty<DecoratedText> createWeaponStrength(ch.sahits.game.openpatrician.model.ship.IShip currentShip)

center

public javafx.scene.layout.Pane center(javafx.scene.control.Control childNode)

Create an element that will layout the childNode horizontally centered within a Dialog.

Parameters:

childNode - that should be centered

Returns:

wrapping Pane

center

public javafx.scene.layout.Pane center(javafx.scene.image.ImageView childNode)

Create an element that will layout the childNode horizontally centered within a Dialog.

Parameters:

childNode - that should be centered

Returns:

wrapping Pane

center

public javafx.scene.Group center(javafx.scene.layout.Pane childNode)

Create an element that will layout the childNode horizontally centered within a Dialog.

Parameters:

childNode - that should be centered

Returns:

wrapping Pane

right

public javafx.scene.Group right(javafx.scene.layout.Pane childNode)

Create an element that will layout the childNode at the right dialog content border.

Parameters:

childNode - that should be right aligned.

Returns:

wrapping Pane

right

public javafx.scene.layout.Pane right(javafx.scene.control.Control childNode)

Create an element that will layout the childNode at the right dialog content border.

Parameters:

childNode - that should be right aligned.

Returns:

wrapping Pane

createVerticalSpacer

public javafx.scene.Node createVerticalSpacer(int heigth)

Create a Node that forces vertical spacing.

Parameters:

heigth - of the spacing node.

Returns:

Node with specified heigth.

removeById

public int removeById(javafx.scene.layout.Pane parent,
                      String id)

Remove a node identified by id from the parent and return the index.

Parameters:

parent - containing the node

id - of the id

Returns:

index in the children of the removed node within id. If the node cannot be found -1 will be returned.

createShipWeaponDisplay

public javafx.scene.layout.Pane createShipWeaponDisplay(ch.sahits.game.openpatrician.model.ship.IShip ship)

Create the weapon display with all weapons and place holders.

Parameters:

ship -

Returns:

getShipDeck

private javafx.scene.image.ImageView getShipDeck(ch.sahits.game.openpatrician.model.ship.EShipType shipType)

getWeaponPlaceHolder

private javafx.scene.image.ImageView getWeaponPlaceHolder(ch.sahits.game.openpatrician.model.ship.ESide side)

getShipWeapon

private javafx.scene.image.ImageView getShipWeapon(ch.sahits.game.openpatrician.model.ship.IWeaponSlot weaponSlot)

getSlotModel

private ch.sahits.game.openpatrician.data.xmlmodel.BasicSlot getSlotModel(int id)